Skip to content

natoscott/valkey-json

Repository files navigation

ValkeyJSON - a JSON data type for Valkey

ValkeyJSON is a Valkey module that implements ECMA-404 The JSON Data Interchange Standard as a native data type. It allows storing, updating and fetching JSON values from Valkey keys (documents).

Primary features:

  • Full support of the JSON standard
  • JSONPath-like syntax for selecting element inside documents
  • Documents are stored as binary data in a tree structure, allowing fast access to sub-elements
  • Typed atomic operations for all JSON values types

Quickstart

  1. Launch ValkeyJSON with Docker
  2. Use ValkeyJSON from a Valkey client

Documentation

Read the docs at https://valkey-io.github.io/valkey-json

Current limitations and known issues

  • Searching for object keys is O(N)
  • Containers are not scaled down after deleting items (i.e. free memory isn't reclaimed)
  • Numbers are stored using 64-bit integers or doubles, and out of range values are not accepted

Acknowledgements

ValkeyJSON is made possible only because of the existance of these amazing open source projects:

License

AGPLv3 - see LICENSE

About

Valkey JSON Module

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published