DEV: ROS8.8 release docs

build/generate_version_commands_page.py

@@ -20,6 +20,7 @@
     ('sorted-set', 'Sorted set commands'),
     ('stream', 'Stream commands'),
     ('bitmap', 'Bitmap commands'),
+    ('array', 'Array commands'),
     ('hyperloglog', 'HyperLogLog commands'),
     ('geo', 'Geospatial commands'),
     ('json', 'JSON commands'),
@@ -196,6 +197,7 @@ def generate_page_content(commands_by_group, target_version):
             'sorted-set': 'Sorted set commands operate on sets of unique strings ordered by a score.',
             'stream': 'Stream commands operate on append-only log data structures.',
             'bitmap': 'Bitmap commands operate on strings as arrays of bits.',
+            'array': 'Array commands operate on arrays of strings.',
             'hyperloglog': 'HyperLogLog commands provide probabilistic cardinality estimation.',
             'geo': 'Geospatial commands operate on geographic coordinates.',
             'json': 'JSON commands operate on JSON data structures.',

content/commands/acl-load.md

@@ -38,6 +38,10 @@ sure to have an *all or nothing* behavior, that is:
 * If every line in the file is valid, all the ACLs are loaded.
 * If one or more line in the file is not valid, nothing is loaded, and the old ACL rules defined in the server memory continue to be used.
 
+Starting with Redis 8.8, your ACL file is allowed to have comment lines; lines that begin with the `#` character.
+Any such comment lines are stripped when the ACL file is loaded and they are not persisted across `ACL LOAD`/`ACL SAVE` commands.
+Make sure you save a backup of your ACL file. This is the only way to preserve comments.
+
 ## Examples
 
 ```

content/commands/arcount.md

@@ -0,0 +1,73 @@
+---
+acl_categories:
+- '@array'
+arguments:
+- key_spec_index: 0
+  name: key
+  type: key
+arity: 2
+bannerText: Array is a new data type that is currently in preview and may be subject to change.
+categories:
+- docs
+- develop
+- oss
+- rs
+- rc
+- kubernetes
+- clients
+command_flags:
+- readonly
+- fast
+complexity: O(1)
+description: Returns the number of non-empty elements in an array.
+group: array
+hidden: false
+key_specs:
+- begin_search:
+    index:
+      pos: 1
+  find_keys:
+    range:
+      lastkey: 0
+      limit: 0
+      step: 1
+  flags:
+  - ro
+  - access
+linkTitle: ARCOUNT
+since: 8.8.0
+summary: Returns the number of non-empty elements in an array.
+syntax_fmt: ARCOUNT key
+title: ARCOUNT
+---
+Returns the number of non-empty elements in an array.
+
+## Required arguments
+
+<details open><summary><code>key</code></summary>
+
+The name of the key that holds the array.
+
+</details>
+
+## Examples
+
+{{% redis-cli %}}
+ARSET myarray 0 "a"
+ARSET myarray 5 "b"
+ARCOUNT myarray
+{{% /redis-cli %}}
+
+## Return information
+
+{{< multitabs id="return-info"
+    tab1="RESP2"
+    tab2="RESP3" >}}
+
+[Integer reply](../../develop/reference/protocol-spec#integers): The number of non-empty elements, or 0 if key does not exist.
+
+-tab-sep-
+
+[Integer reply](../../develop/reference/protocol-spec#integers): The number of non-empty elements, or 0 if key does not exist.
+
+{{< /multitabs >}}

content/commands/ardel.md

@@ -0,0 +1,92 @@
+---
+acl_categories:
+- ARRAY
+arguments:
+- key_spec_index: 0
+  name: key
+  type: key
+- multiple: true
+  name: index
+  type: integer
+arity: -3
+bannerText: Array is a new data type that is currently in preview and may be subject to change.
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+command_flags:
+- WRITE
+- FAST
+complexity: O(N) where N is the number of indices to delete
+description: Deletes elements at the specified indices in an array.
+function: ardelCommand
+group: array
+hidden: false
+key_specs:
+- begin_search:
+    index:
+      pos: 1
+  find_keys:
+    range:
+      lastkey: 0
+      limit: 0
+      step: 1
+  flags:
+  - RW
+  - DELETE
+linkTitle: ARDEL
+reply_schema:
+  description: Number of elements deleted.
+  type: integer
+since: 8.8.0
+summary: Deletes elements at the specified indices in an array.
+syntax_fmt: ARDEL key index [index ...]
+title: ARDEL
+---
+Deletes elements at the specified indices in an array.
+
+## Required arguments
+
+<details open><summary><code>key</code></summary>
+
+The name of the key that holds the array.
+
+</details>
+
+<details open><summary><code>index</code></summary>
+
+One or more zero-based integer indices of the elements to delete. Deleting an index that does not exist counts as zero elements deleted and does not modify the array.
+
+</details>
+
+## Examples
+
+{{% redis-cli %}}
+ARSET myarray 0 "a"
+ARSET myarray 1 "b"
+ARSET myarray 2 "c"
+ARDEL myarray 1
+ARGET myarray 1
+ARDEL myarray 0 2
+ARCOUNT myarray
+{{% /redis-cli %}}
+
+## Return information
+
+{{< multitabs id="return-info"
+    tab1="RESP2"
+    tab2="RESP3" >}}
+
+[Integer reply](../../develop/reference/protocol-spec#integers): Number of elements deleted.
+
+-tab-sep-
+
+[Integer reply](../../develop/reference/protocol-spec#integers): Number of elements deleted.
+
+{{< /multitabs >}}

content/commands/ardelrange.md

@@ -0,0 +1,95 @@
+---
+acl_categories:
+- ARRAY
+arguments:
+- key_spec_index: 0
+  name: key
+  type: key
+- arguments:
+  - name: start
+    type: integer
+  - name: end
+    type: integer
+  multiple: true
+  name: range
+  type: block
+arity: -4
+bannerText: Array is a new data type that is currently in preview and may be subject to change.
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+command_flags:
+- WRITE
+complexity: Proportional to the number of existing elements / slices touched, not
+  to the numeric span of the requested ranges
+description: Deletes elements in one or more ranges.
+function: ardelrangeCommand
+group: array
+hidden: false
+key_specs:
+- begin_search:
+    index:
+      pos: 1
+  find_keys:
+    range:
+      lastkey: 0
+      limit: 0
+      step: 1
+  flags:
+  - RW
+  - DELETE
+linkTitle: ARDELRANGE
+reply_schema:
+  description: Number of elements deleted.
+  type: integer
+since: 8.8.0
+summary: Deletes elements in one or more ranges.
+syntax_fmt: ARDELRANGE key start end [start end ...]
+title: ARDELRANGE
+---
+Deletes elements in one or more ranges.
+
+## Required arguments
+
+<details open><summary><code>key</code></summary>
+
+The name of the key that holds the array.
+
+</details>
+
+<details open><summary><code>range</code></summary>
+
+One or more `start end` pairs, each defining an inclusive range of indices to delete. If `start` is greater than `end` for a given pair, the range is processed in ascending order regardless. Multiple pairs may overlap; each element is counted at most once.
+
+</details>
+
+## Examples
+
+{{% redis-cli %}}
+ARMSET myarray 0 "a" 1 "b" 2 "c" 3 "d" 4 "e"
+ARDELRANGE myarray 1 3
+ARCOUNT myarray
+ARGET myarray 0
+ARGET myarray 4
+{{% /redis-cli %}}
+
+## Return information
+
+{{< multitabs id="return-info"
+    tab1="RESP2"
+    tab2="RESP3" >}}
+
+[Integer reply](../../develop/reference/protocol-spec#integers): Number of elements deleted.
+
+-tab-sep-
+
+[Integer reply](../../develop/reference/protocol-spec#integers): Number of elements deleted.
+
+{{< /multitabs >}}

content/commands/arget.md

@@ -0,0 +1,94 @@
+---
+acl_categories:
+- ARRAY
+arguments:
+- key_spec_index: 0
+  name: key
+  type: key
+- name: index
+  type: integer
+arity: 3
+bannerText: Array is a new data type that is currently in preview and may be subject to change.
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+command_flags:
+- READONLY
+- FAST
+complexity: O(1)
+description: Gets the value at an index in an array.
+function: argetCommand
+group: array
+hidden: false
+key_specs:
+- begin_search:
+    index:
+      pos: 1
+  find_keys:
+    range:
+      lastkey: 0
+      limit: 0
+      step: 1
+  flags:
+  - RO
+  - ACCESS
+linkTitle: ARGET
+reply_schema:
+  oneOf:
+  - description: The value at the given index.
+    type: string
+  - description: Null reply if key or index does not exist.
+    type: 'null'
+since: 8.8.0
+summary: Gets the value at an index in an array.
+syntax_fmt: ARGET key index
+title: ARGET
+---
+Gets the value at an index in an array.
+
+## Required arguments
+
+<details open><summary><code>key</code></summary>
+
+The name of the key that holds the array.
+
+</details>
+
+<details open><summary><code>index</code></summary>
+
+The zero-based integer index of the element to retrieve.
+
+</details>
+
+## Examples
+
+{{% redis-cli %}}
+ARSET myarray 0 "hello"
+ARGET myarray 0
+ARGET myarray 1
+{{% /redis-cli %}}
+
+## Return information
+
+{{< multitabs id="return-info"
+    tab1="RESP2"
+    tab2="RESP3" >}}
+
+One of the following:
+* [Bulk string reply](../../develop/reference/protocol-spec#bulk-strings): The value at the given index.
+* [Nil reply](../../develop/reference/protocol-spec#null-bulk-strings): Null reply if key or index does not exist.
+
+-tab-sep-
+
+One of the following:
+* [Bulk string reply](../../develop/reference/protocol-spec#bulk-strings): The value at the given index.
+* [Null reply](../../develop/reference/protocol-spec#nulls): Null reply if key or index does not exist.
+
+{{< /multitabs >}}