Append value as JSON to the array located at the JSONPath in key

redis.json.arrappend "posts:#{id}", ".tags", "redis"

Append values as JSON to the array located at the JSONPath in key

redis.json.arrappend "posts:#{id}", ".tags", %w[redis crystal]

Get the index of value in the array located at the JSONPath in key if and only if it falls in the specified range

redis.json.arrindex "posts:#{id}", ".tags", "redis", between: 1..3
# => 2

Get the index of value in the array located at the JSONPath in key

redis.json.arrindex "posts:#{id}", ".tags", "redis" # => 2

Insert value into the array located at the JSONPath in key at index

redis.json.arrinsert "posts:#{id}", ".tags", index: 1, value: "redis"
# => 3

Insert the elements of values into the array located at the JSONPath in key at index

redis.json.arrinsert "posts:#{id}", ".tags", index: 1, values: %w[
  redis
  crystal
]
# => 4

Get the number of elements in the array located at the JSONPath in key

redis.json.arrlen "posts:#{id}", ".tags"
# => 4

Remove and return the value located at index (defaulting to the last element) in the array located at the JSONPath in key

redis.json.arrlen "posts:#{id}", ".tags"
# => 4

Remove and return the value located at index (defaulting to the last element) in the array located at the JSONPath in key

redis.json.arrlen "posts:#{id}", ".tags"
# => 4

NOTE This method cannot be invoked on a pipeline or the transaction yielded to a Redis::Connection#multi block.

Get the value stored at the given JSONPath inside the given key, deserializing the value into the type T. You can use this to deserialize your custom JSON::Serializable objects.

struct Order
  include JSON::Serializable
  getter id : UUID
  getter customer_id : UUID
  getter line_items : Array(LineItem)
end

struct LineItem
  include JSON::Serializable
  getter product_id : UUID
  getter quantity : Int32
  getter unit_price_cents : Int32
end

# Get the Order at the root
redis.json.get("order:#{id}", ".", as: Order)
# Get the LineItems at the `.line_items` JSONPath
# Note the `$` at the beginning to make it an array
redis.json.get("order:#{id}", "$.line_items", as: Array(LineItem))
# Get only the `product_id` properties of all the `line_items`
redis.json.get("order:#{id}", "$.line_items..product_id", as: Array(UUID))

NOTE This method cannot be used in a pipeline or Redis::Connection#multi block because it operates on the value returned from the Redis server inside the method, which isn't possible when using pipelines or multi.

Get the raw JSON string representation at the given key nested at the given JSONPath.

email = redis.json.get("user:#{id}", ".email").as(String)
# => "me@example.com"

Get the values stored at the specifed JSONPaths, deserializing them into the specified type as values in a Hash.

if result = redis.json.get("posts:#{id}", %w[title tags], as: String | Array(String))
  result         # => {"title" => "JSON with Redis", tags: ["redis", "json", "crystal"]}
  typeof(result) # => Hash(String, String | Array(String))
end

NOTE This method cannot be used in a pipeline or Redis::Connection#multi block because it operates on the value returned from the Redis server, which isn't a thing when using pipelines or multi.

Get the raw JSON string at the specified key

Get the values for all keys at the specified JSONPaths.

NOTE This method cannot be used in a pipeline or Redis::Connection#multi block because it operates on the value returned from the Redis server inside the method, which isn't possible when using pipelines or multi.

NOTE If you are using a cluster, the keys must all be on the same shard, or you may only get some of them back with this method. When using #mget in a cluster, you'll most likely want to use subhashed keys (with {} around the same part of the name) to ensure all keys are on the same shard.

Increment the number at the specified JSONPath

redis.json.numincrby "product:#{id}", ".purchase_count", 1, as: Int64
# => 2

If key exists and an incrementable number exists at the specified JSONPath (including the possibility of incrementing multiple numbers if the JSONPath resolves to multiple numeric values), then this method returns a value of type T. If the JSONPath resolves to multiple values (for example, it begins with "$" or is recursive), you will need to specify that it can be an Array of that type.

NOTE This method cannot be used on deferred command runners like Redis::Pipeline or Redis::Transaction. It eagerly consumes the result from the server, so the result must not be deferred.

Increment the number at the specified JSONPath

redis.json.numincrby "product:#{id}", ".purchase_count", 1

Set the given key to the given JSON value. The value will have to_json called on it automatically. The nx and xx arguments are identical to Redis::Commands#set.

Store a user at the root JSONPath (.) of the specified key:

struct User
  include JSON::Serializable

  getter id : UUID
  getter name : String
  getter email : String
end

redis.json.set "user:#{user.id}", ".", user

Update (with xx so we ensure the key exists) a user's email by setting the new email value at the .email JSONPath:

redis.json.set "user:#{id}", ".email", new_email, xx: true