Skip to content

Commit a81d1a4

Browse files
oshadmioshadmi
committed
Remove front matter from commands .md files since it is generated
1 parent 9430e49 commit a81d1a4

22 files changed

+0
-199
lines changed

‎docs/commands/json.arrappend.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.ARRAPPEND command"
3-
linkTitle: "JSON.ARRAPPEND"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Append the `json` values into the array at `path` after the last element in it.
112

123
@return

‎docs/commands/json.arrindex.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.ARRINDEX command"
3-
linkTitle: "JSON.ARRINDEX"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Searches for the first occurrence of a scalar JSON value in an array.
112

123
The optional inclusive `start` (default 0) and exclusive `stop` (default 0, meaning that the last element is included) specify a slice of the array to search.

‎docs/commands/json.arrinsert.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.ARRINSERT command"
3-
linkTitle: "JSON.ARRINSERT"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Inserts the `json` values into the array at `path` before the `index` (shifts to the right).
112

123
The index must be in the array's range. Inserting at `index` 0 prepends to the array. Negative index values start from the end of the array.

‎docs/commands/json.arrlen.md

-10
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,3 @@
1-
2-
---
3-
title: "JSON.ARRLEN command"
4-
linkTitle: "JSON.ARRLEN"
5-
type: docs
6-
weight: 1
7-
description: >
8-
"detailed description"
9-
---
10-
111
Reports the length of the JSON Array at `path` in `key`.
122

133
`path` defaults to root if not provided. Returns null if the `key` or `path` do not exist.

‎docs/commands/json.arrpop.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.ARRPOP command"
3-
linkTitle: "JSON.ARRPOP"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Removes and returns an element from the index in the array.
112

123
`path` defaults to root if not provided. `index` is the position in the array to start popping from (defaults to -1, meaning the last element). Out-of-range indexes round to their respective array ends. Popping an empty array returns null.

‎docs/commands/json.arrtrim.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.ARRTRIM command"
3-
linkTitle: "JSON.ARRTRIM"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Trims an array so that it contains only the specified inclusive range of elements.
112

123
This command is extremely forgiving and using it with out-of-range indexes will not produce an error. There are a few differences between how RedisJSON v2.0 and legacy versions handle out-of-range indexes.

‎docs/commands/json.clear.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.CLEAR command"
3-
linkTitle: "JSON.CLEAR"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Clears container values (Arrays/Objects), sets numeric values to `0`, sets string value to emptys, and sets boolean values to `false`.
112

123
Already cleared values are ignored: empty containers, zero numbers, empty strings, `false`, and `null`.

‎docs/commands/json.debug-help.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.DEBUG HELP subcommand"
3-
linkTitle: "JSON.DEBUG HELP"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Returns helpful information about the `JSON.DEBUG` command.
112

123
@return

‎docs/commands/json.debug-memory.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.DEBUG MEMORY subcommand"
3-
linkTitle: "JSON.DEBUG MEMORY"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Report a value's memory usage in bytes. `path` defaults to root if not provided.
112

123
@return

‎docs/commands/json.del.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.DEL command"
3-
linkTitle: "JSON.DEL"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Deletes a value.
112

123
`path` defaults to root if not provided. Ignores nonexistent keys and paths. Deleting an object's root is equivalent to deleting the key from Redis.

‎docs/commands/json.get.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.GET command"
3-
linkTitle: "JSON.GET"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Returns the value at `path` in JSON serialized form.
112

123
This command accepts multiple `path` arguments. If no path is given, it defaults to the value's root.

‎docs/commands/json.mget.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.MGET command"
3-
linkTitle: "JSON.MGET"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Returns the values at `path` from multiple `key` arguments. Returns null for nonexistent keys and nonexistent paths.
112

123
@return

‎docs/commands/json.numincrby.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.NUMINCRBY command"
3-
linkTitle: "JSON.NUMINCRBY"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Increments the number value stored at `path` by `number`.
112

123
@return

‎docs/commands/json.nummultby.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.NUMMULTBY command"
3-
linkTitle: "JSON.NUMMULTBY"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Multiplies the number value stored at `path` by `number`.
112

123
@return

‎docs/commands/json.objkeys.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.OBJKEYS command"
3-
linkTitle: "JSON.OBJKEYS"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Returns the keys in the object that's referenced by `path`.
112

123
`path` defaults to root if not provided. Returns null if the object is empty or either `key` or `path` do not exist.

‎docs/commands/json.objlen.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.OBJLEN command"
3-
linkTitle: "JSON.OBJLEN"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Reports the number of keys in the JSON Object at `path` in `key`.
112

123
`path` defaults to root if not provided. Returns null if the `key` or `path` do not exist.

‎docs/commands/json.resp.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.RESP command"
3-
linkTitle: "JSON.RESP"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Returns the JSON in `key` in [Redis Serialization Protocol (RESP)][5] form.
112

123
`path` defaults to root if not provided. This command uses the following mapping from JSON to RESP:

‎docs/commands/json.set.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.SET command"
3-
linkTitle: "JSON.SET"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Sets the JSON value at `path` in `key`.
112

123
For new Redis keys the `path` must be the root. For existing keys, when the entire `path` exists, the value that it contains is replaced with the `json` value. For existing keys, when the `path` exists, except for the last element, a new child is added with the `json` value.

‎docs/commands/json.strappend.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.STRAPPEND command"
3-
linkTitle: "JSON.STRAPPEND"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Appends the `json-string` values to the string at `path`.
112

123
`path` defaults to root if not provided.

‎docs/commands/json.strlen.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.STRLEN command"
3-
linkTitle: "JSON.STRLEN"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Reports the length of the JSON String at `path` in `key`.
112

123
`path` defaults to root if not provided. Returns null if the `key` or `path` do not exist.

‎docs/commands/json.toggle.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.TOGGLE command"
3-
linkTitle: "JSON.TOGGLE"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Toggle a boolean value stored at `path`.
112

123
return

‎docs/commands/json.type.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
---
2-
title: "JSON.TYPE command"
3-
linkTitle: "JSON.TYPE"
4-
type: docs
5-
weight: 1
6-
description: >
7-
"detailed description"
8-
---
9-
101
Reports the type of JSON value at `path`.
112

123
`path` defaults to root if not provided. Returns null if the `key` or `path` do not exist.

0 commit comments

Comments
 (0)