Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.45 KB

commands.md

File metadata and controls

41 lines (28 loc) · 1.45 KB
title linkTitle type weight description
RedisJSON commands
RedisJSON commands
docs
1
"Details relevant to all commands"

Overview

Supported JSON

RedisJSON aims to provide full support for ECMA-404 The JSON Data Interchange Standard.

Below, the term JSON Value refers to any of the valid values. A Container is either a JSON Array or a JSON Object. A JSON Scalar is a JSON Number, a JSON String, or a literal (JSON False, JSON True, or JSON Null).

RedisJSON API

The module's commands are described below. Each section header shows the syntax for the command, where:

  • Command and subcommand names are in uppercase, for example JSON.SET or INDENT
  • Mandatory arguments are enclosed in angle brackets, for example <path>
  • Optional arguments are enclosed in square brackets, for example [index]
  • Additional optional arguments are indicated by three period characters, for example ...
  • The pipe character, |, means an exclusive or

Commands usually require a key's name as their first argument. The path is generally assumed to be the root if not specified.

The time complexity of the command does not include that of the path. The size - usually denoted N - of a value is:

  • 1 for scalar values
  • The sum of sizes of items in a container

Scalar commands

Array commands

Object commands

Module commands