JSON.CLEAR to empty the values a path selects without removing them from the document.
Objects lose all their keys, arrays lose all their elements, and numbers are reset to 0. Values of other types, such as strings and booleans, are left as they are. The reply is the number of values that were cleared.
The difference from JSON.DEL is that the selected keys and slots stay in the document as empty containers, so the shape of the document is preserved and consumers that expect a field to exist keep working.
Syntax
Arguments
Important points
- Raw TCP examples pass JSON values as valid JSON text. Typed Upstash SDK helpers serialize native objects and values for you.
- Paths beginning with
$use JSONPath and can match multiple values, so many JSON commands return an array of per-match results.
Response
The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.
Examples
TCP examples use the TLSREDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.
Redis CLI
Redis CLI
@upstash/redis
@upstash/redis
upstash_redis
upstash_redis
ioredis
ioredis
node-redis
node-redis
redis-py
redis-py
go-redis
go-redis
jedis
jedis
redis-rs
redis-rs