+
+
+is the name of the key that will hold the vector set data.
+
+
+key
+
+is the name of the key that will hold the vector set data.
+
+
+
+either a 32-bit floating point (FP32) blob of values or `num` floating point numbers as strings.
+
+
+FP32 vector or VALUES num vector
+
+either a 32-bit floating point (FP32) blob of values or `num` floating point numbers as strings.
+
+
+
+is the name of the element that is being added to the vector set.
+
+
+## Optional arguments
+
+element
+
+is the name of the element that is being added to the vector set.
+
+
+
+implements random projection to reduce the dimensionality of the vector. The projection matrix is saved and reloaded along with the vector set. Please note that the REDUCE option must be passed immediately before the vector. For example,
+
+```
+VADD mykey REDUCE 50 VALUES ...
+```
+
+
+REDUCE dim
+
+implements random projection to reduce the dimensionality of the vector. The projection matrix is saved and reloaded along with the vector set. Please note that the REDUCE option must be passed immediately before the vector. For example,
+
+```
+VADD mykey REDUCE 50 VALUES ...
+```
+
+
+
+performs the operation partially using threads, in a check-and-set style. The neighbor candidates collection, which is slow, is performed in the background, while the command is executed in the main thread.
+
+
+CAS
+
+performs the operation partially using threads, in a check-and-set style. The neighbor candidates collection, which is slow, is performed in the background, while the command is executed in the main thread.
+
+
+
+in the first VADD call for a given key, NOQUANT forces the vector to be created without int8 quantization, which is otherwise the default.
+
+
+NOQUANT
+
+in the first VADD call for a given key, NOQUANT forces the vector to be created without int8 quantization, which is otherwise the default.
+
+
+
+forces the vector to use binary quantization instead of int8. This is much faster and uses less memory, but impacts the recall quality.
+
+
+BIN
+
+forces the vector to use binary quantization instead of int8. This is much faster and uses less memory, but impacts the recall quality.
+
+
+
+forces the vector to use signed 8-bit quantization. This is the default, and the option only exists to make sure to check at insertion time that the vector set is of the same format.
+
+
+{{< note >}}
+`NOQUANT`, `Q8`, and `BIN` are mutually exclusive.
+
+{{< /note >}}
+
+Q8
+
+forces the vector to use signed 8-bit quantization. This is the default, and the option only exists to make sure to check at insertion time that the vector set is of the same format.
+
+
+
+plays a role in the effort made to find good candidates when connecting the new node to the existing Hierarchical Navigable Small World (HNSW) graph. The default is 200. Using a larger value may help in achieving a better recall. To improve the recall it is also possible to increase EF during VSIM searches.
+
+
+EF build-exploration-factor
+
+plays a role in the effort made to find good candidates when connecting the new node to the existing Hierarchical Navigable Small World (HNSW) graph. The default is 200. Using a larger value may help in achieving a better recall. To improve the recall it is also possible to increase EF during VSIM searches.
+
+
+
+associates attributes in the form of a JavaScript object to the newly created entry or updates the attributes (if they already exist).
+It is the same as calling the VSETATTR command separately.
+
+
+SETATTR attributes
+
+associates attributes in the form of a JavaScript object to the newly created entry or updates the attributes (if they already exist).
+It is the same as calling the VSETATTR command separately.
+
+
+
+is the maximum number of connections that each node of the graph will have with other nodes. The default is 16. More connections means more memory, but provides for more efficient graph exploration. Nodes at layer zero (every node exists at least at layer zero) have `M * 2` connections, while the other layers only have `M` connections. For example, setting `M` to `64` will use at least 1024 bytes of memory for layer zero. That's `M * 2` connections times 8 bytes (pointers), or `128 * 8 = 1024`. For higher layers, consider the following:
+
+- Each node appears in ~1.33 layers on average (empirical observation from HNSW papers), which works out to be 0.33 higher layers per node.
+- Each of those higher layers has `M = 64` connections.
+
+So, the additional amount of memory is approximately `0.33 × 64 × 8 ≈ 169.6` bytes per node, bringing the total memory to ~1193 bytes.
+
+If you don't have a recall quality problem, the default is acceptable, and uses a minimal amount of memory.
+
+
+## Related topics
+
+- [Vector sets]({{< relref "/develop/data-types/vector-sets" >}})
\ No newline at end of file
diff --git a/content/commands/vcard/index.md b/content/commands/vcard/index.md
new file mode 100644
index 0000000000..2aa7868318
--- /dev/null
+++ b/content/commands/vcard/index.md
@@ -0,0 +1,41 @@
+---
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+complexity: O(1)
+description: Return the number of elements in a vector set.
+group: vector_set
+hidden: false
+linkTitle: VCARD
+since: 8.0.0
+summary: Return the number of elements in a vector set.
+syntax_fmt: "VCARD key"
+title: VCARD
+bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
+---
+
+Return the number of elements in the specified vector set.
+
+```shell
+VCARD word_embeddings
+(integer) 3000000
+```
+
+## Required arguments
+
+M numlinks
+
+is the maximum number of connections that each node of the graph will have with other nodes. The default is 16. More connections means more memory, but provides for more efficient graph exploration. Nodes at layer zero (every node exists at least at layer zero) have `M * 2` connections, while the other layers only have `M` connections. For example, setting `M` to `64` will use at least 1024 bytes of memory for layer zero. That's `M * 2` connections times 8 bytes (pointers), or `128 * 8 = 1024`. For higher layers, consider the following:
+
+- Each node appears in ~1.33 layers on average (empirical observation from HNSW papers), which works out to be 0.33 higher layers per node.
+- Each of those higher layers has `M = 64` connections.
+
+So, the additional amount of memory is approximately `0.33 × 64 × 8 ≈ 169.6` bytes per node, bringing the total memory to ~1193 bytes.
+
+If you don't have a recall quality problem, the default is acceptable, and uses a minimal amount of memory.
+
+
+
+is the name of the key that holds the vector set.
+
+
+## Related topics
+
+- [Vector sets]({{< relref "/develop/data-types/vector-sets" >}})
diff --git a/content/commands/vdim/index.md b/content/commands/vdim/index.md
new file mode 100644
index 0000000000..d033a5ddcb
--- /dev/null
+++ b/content/commands/vdim/index.md
@@ -0,0 +1,43 @@
+---
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+complexity: O(1)
+description: Return the dimension of vectors in the vector set.
+group: vector_set
+hidden: false
+linkTitle: VDIM
+since: 8.0.0
+summary: Return the dimension of vectors in the vector set.
+syntax_fmt: "VDIM key"
+title: VDIM
+bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
+---
+
+Return the number of dimensions of the vectors in the specified vector set.
+
+```shell
+VDIM word_embeddings
+(integer) 300
+```
+
+If the vector set was created using the `REDUCE` option for dimensionality reduction, this command reports the reduced dimension. However, you must still use full-size vectors when performing queries with the `VSIM` command.
+
+## Required arguments
+
+key
+
+is the name of the key that holds the vector set.
+
+
+
+is the name of the key that holds the vector set.
+
+
+## Related topics
+
+- [Vector sets]({{< relref "/develop/data-types/vector-sets" >}})
diff --git a/content/commands/vemb/index.md b/content/commands/vemb/index.md
new file mode 100644
index 0000000000..861ae8769b
--- /dev/null
+++ b/content/commands/vemb/index.md
@@ -0,0 +1,72 @@
+---
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+complexity: O(1)
+description: Return the vector associated with an element.
+group: vector_set
+hidden: false
+linkTitle: VEMB
+since: 8.0.0
+summary: Return the vector associated with an element.
+syntax_fmt: "VEMB key element [RAW]"
+title: VEMB
+bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
+---
+
+Return the approximate vector associated with a given element in the vector set.
+
+```shell
+VEMB word_embeddings SQL
+1) "0.18208661675453186"
+2) "0.08535309880971909"
+3) "0.1365649551153183"
+4) "-0.16501599550247192"
+5) "0.14225517213344574"
+... 295 more elements ...
+```
+
+Vector sets normalize and may quantize vectors on insertion. `VEMB` reverses this process to approximate the original vector by de-normalizing and de-quantizing it.
+
+To retrieve the raw internal representation, use the `RAW` option:
+
+```shell
+VEMB word_embeddings apple RAW
+1) int8
+2) "\xf1\xdc\xfd\x1e\xcc%E...\xde\x1f\xfbN" # artificially shortened for this example
+3) "3.1426539421081543"
+4) "0.17898885905742645"
+```
+
+## Required arguments
+
+key
+
+is the name of the key that holds the vector set.
+
+
+
+is the name of the key that holds the vector set.
+
+
+key
+
+is the name of the key that holds the vector set.
+
+
+
+is the name of the element whose vector you want to retrieve.
+
+
+## Optional arguments
+
+element
+
+is the name of the element whose vector you want to retrieve.
+
+
+
+returns the raw vector data, its quantization type, and metadata such as norm and range.
+
+
+## Related topics
+
+- [Vector sets]({{< relref "/develop/data-types/vector-sets" >}})
diff --git a/content/commands/vgetattr/index.md b/content/commands/vgetattr/index.md
new file mode 100644
index 0000000000..68184c7fc7
--- /dev/null
+++ b/content/commands/vgetattr/index.md
@@ -0,0 +1,46 @@
+---
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+complexity: O(1)
+description: Retrieve the JSON attributes of elements.
+group: vector_set
+hidden: false
+linkTitle: VGETATTR
+since: 8.0.0
+summary: Retrieve the JSON attributes of elements.
+syntax_fmt: "VGETATTR key element"
+title: VGETATTR
+bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
+---
+
+Return the JSON attributes associated with an element in a vector set.
+
+```shell
+VGETATTR key element
+```
+
+## Required arguments
+
+RAW
+
+returns the raw vector data, its quantization type, and metadata such as norm and range.
+
+
+
+is the name of the key that holds the vector set.
+
+
+key
+
+is the name of the key that holds the vector set.
+
+
+
+is the name of the element whose attributes you want to retrieve.
+
+
+## Related topics
+
+- [Vector sets]({{< relref "/develop/data-types/vector-sets" >}})
diff --git a/content/commands/vinfo/index.md b/content/commands/vinfo/index.md
new file mode 100644
index 0000000000..7044fdf7ad
--- /dev/null
+++ b/content/commands/vinfo/index.md
@@ -0,0 +1,52 @@
+---
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+complexity: O(1)
+description: Return information about a vector set.
+group: vector_set
+hidden: false
+linkTitle: VINFO
+since: 8.0.0
+summary: Return information about a vector set.
+syntax_fmt: "VINFO key"
+title: VINFO
+bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
+---
+
+Return metadata and internal details about a vector set, including size, dimensions, quantization type, and graph structure.
+
+```shell
+VINFO word_embeddings
+1) quant-type
+2) int8
+3) vector-dim
+4) (integer) 300
+5) size
+6) (integer) 3000000
+7) max-level
+8) (integer) 12
+9) vset-uid
+10) (integer) 1
+11) hnsw-max-node-uid
+12) (integer) 3000000
+```
+
+## Required arguments
+
+element
+
+is the name of the element whose attributes you want to retrieve.
+
+
+
+is the name of the key that holds the vector set.
+
+
+## Related topics
+
+- [Vector sets]({{< relref "/develop/data-types/vector-sets" >}})
diff --git a/content/commands/vlinks/index.md b/content/commands/vlinks/index.md
new file mode 100644
index 0000000000..5c88a1e927
--- /dev/null
+++ b/content/commands/vlinks/index.md
@@ -0,0 +1,60 @@
+---
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+complexity: O(1)
+description: Return the neighbors of an element at each layer in the HNSW graph.
+group: vector_set
+hidden: false
+linkTitle: VLINKS
+since: 8.0.0
+summary: Return the neighbors of an element at each layer in the HNSW graph.
+syntax_fmt: "VLINKS key element [WITHSCORES]"
+title: VLINKS
+bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
+---
+
+Return the neighbors of a specified element in a vector set. The command shows the connections for each layer of the HNSW graph.
+
+```shell
+VLINKS key element
+```
+
+Use the `WITHSCORES` option to include similarity scores for each neighbor.
+
+```shell
+VLINKS key element WITHSCORES
+```
+
+## Required arguments
+
+key
+
+is the name of the key that holds the vector set.
+
+
+
+is the name of the key that holds the vector set.
+
+
+key
+
+is the name of the key that holds the vector set.
+
+
+
+is the name of the element whose HNSW neighbors you want to inspect.
+
+
+## Optional arguments
+
+element
+
+is the name of the element whose HNSW neighbors you want to inspect.
+
+
+
+includes similarity scores for each neighbor.
+
+
+## Related topics
+
+- [Vector sets]({{< relref "/develop/data-types/vector-sets" >}})
diff --git a/content/commands/vrandmember/index.md b/content/commands/vrandmember/index.md
new file mode 100644
index 0000000000..bf8ea842b1
--- /dev/null
+++ b/content/commands/vrandmember/index.md
@@ -0,0 +1,113 @@
+---
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+complexity: O(N) where N is the absolute value of the count argument.
+description: Return one or multiple random members from a vector set.
+group: vector_set
+hidden: false
+linkTitle: VRANDMEMBER
+since: 8.0.0
+summary: Return one or multiple random members from a vector set.
+syntax_fmt: "VRANDMEMBER key [count]"
+title: VRANDMEMBER
+bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
+---
+
+Return one or more random elements from a vector set.
+
+The behavior is similar to the `SRANDMEMBER` command:
+
+- When called without a count, returns a single element as a bulk string.
+- When called with a positive count, returns up to that many distinct elements (no duplicates).
+- When called with a negative count, returns that many elements, possibly with duplicates.
+- If the count exceeds the number of elements, the entire set is returned.
+- If the key does not exist, the command returns `null` if no count is given, or an empty array if a count is provided.
+
+```shell
+VADD vset VALUES 3 1 0 0 elem1
+VADD vset VALUES 3 0 1 0 elem2
+VADD vset VALUES 3 0 0 1 elem3
+```
+
+Return a single random element:
+
+```shell
+VRANDMEMBER vset
+"elem2"
+```
+
+Return two distinct random elements:
+
+```shell
+VRANDMEMBER vset 2
+1) "elem1"
+2) "elem3"
+```
+
+Return 3 random elements with possible duplicates:
+
+```shell
+VRANDMEMBER vset -3
+1) "elem2"
+2) "elem2"
+3) "elem1"
+```
+
+Request more elements than exist in the set:
+
+```shell
+VRANDMEMBER vset 10
+1) "elem1"
+2) "elem2"
+3) "elem3"
+```
+
+When the key doesn't exist:
+
+```shell
+VRANDMEMBER nonexistent
+(nil)
+```
+
+```shell
+VRANDMEMBER nonexistent 3
+(empty array)
+```
+
+This command is useful for:
+
+- Sampling elements for testing or training.
+- Generating random queries for performance testing.
+
+Internally:
+
+- For small counts (less than 20% of the set size), a dictionary is used to ensure uniqueness.
+- For large counts (more than 20% of the set size), a linear scan provides faster performance, though results may be less random.
+
+## Required arguments
+
+WITHSCORES
+
+includes similarity scores for each neighbor.
+
+
+
+is the name of the key that holds the vector set.
+
+
+## Optional arguments
+
+key
+
+is the name of the key that holds the vector set.
+
+
+
+specifies the number of elements to return. Positive values return distinct elements; negative values allow duplicates.
+
+
+## Related topics
+
+- [Vector sets]({{< relref "/develop/data-types/vector-sets" >}})
diff --git a/content/commands/vrem/index.md b/content/commands/vrem/index.md
new file mode 100644
index 0000000000..208caae252
--- /dev/null
+++ b/content/commands/vrem/index.md
@@ -0,0 +1,59 @@
+---
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+complexity: O(log(N)) for each element removed, where N is the number of elements in the vector set.
+description: Remove one or more elements from a vector set.
+group: vector_set
+hidden: false
+linkTitle: VREM
+since: 8.0.0
+summary: Remove one or more elements from a vector set.
+syntax_fmt: "VREM key element"
+title: VREM
+bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
+---
+
+Remove an element from a vector set.
+
+```shell
+VADD vset VALUES 3 1 0 1 bar
+(integer) 1
+```
+
+```shell
+VREM vset bar
+(integer) 1
+```
+
+```shell
+VREM vset bar
+(integer) 0
+```
+
+`VREM` reclaims memory immediately. It does not use tombstones or logical deletions, making it safe to use in long-running applications that frequently update the same vector set.
+
+## Required arguments
+
+count
+
+specifies the number of elements to return. Positive values return distinct elements; negative values allow duplicates.
+
+
+
+is the name of the key that holds the vector set.
+
+
+key
+
+is the name of the key that holds the vector set.
+
+
+
+is the name of the element to remove from the vector set.
+
+
+## Related topics
+
+- [Vector sets]({{< relref "/develop/data-types/vector-sets" >}})
diff --git a/content/commands/vsetattr/index.md b/content/commands/vsetattr/index.md
new file mode 100644
index 0000000000..ca4833b90b
--- /dev/null
+++ b/content/commands/vsetattr/index.md
@@ -0,0 +1,60 @@
+---
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+complexity: O(1)
+description: Associate or remove the JSON attributes of elements.
+group: vector_set
+hidden: false
+linkTitle: VSETATTR
+since: 8.0.0
+summary: Associate or remove the JSON attributes of elements.
+syntax_fmt: "VSETATTR key element \"{ JSON obj }\""
+title: VSETATTR
+bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
+---
+
+Associate a JSON object with an element in a vector set. Use this command to store attributes that can be used in filtered similarity searches with `VSIM`.
+
+You can also update existing attributes or delete them by setting an empty string.
+
+```shell
+VSETATTR key element "{\"type\": \"fruit\", \"color\": \"red\"}"
+```
+
+To remove attributes, pass an empty JSON string:
+
+```shell
+VSETATTR key element ""
+```
+
+## Required arguments
+
+element
+
+is the name of the element to remove from the vector set.
+
+
+
+is the name of the key that holds the vector set.
+
+
+key
+
+is the name of the key that holds the vector set.
+
+
+
+is the name of the element whose attributes you want to set or remove.
+
+
+element
+
+is the name of the element whose attributes you want to set or remove.
+
+
+
+is a valid JSON string. Use an empty string (`""`) to delete the attributes.
+
+
+## Related topics
+
+- [Vector sets]({{< relref "/develop/data-types/vector-sets" >}})
diff --git a/content/commands/vsim/index.md b/content/commands/vsim/index.md
new file mode 100644
index 0000000000..a6bbfa991d
--- /dev/null
+++ b/content/commands/vsim/index.md
@@ -0,0 +1,122 @@
+---
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+complexity: O(log(N)) where N is the number of elements in the vector set.
+description: Return elements by vector similarity.
+group: vector_set
+hidden: false
+linkTitle: VSIM
+since: 8.0.0
+summary: Return elements by vector similarity.
+syntax_fmt: "VSIM key (ELE | FP32 | VALUES num) (vector | element) [WITHSCORES] [COUNT num] [EF search-exploration-factor]\n [FILTER expression] [FILTER-EF max-filtering-effort] [TRUTH] [NOTHREAD]"
+title: VSIM
+bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
+---
+
+Return elements similar to a given vector or element. Use this command to perform approximate or exact similarity searches within a vector set.
+
+You can query using either a vector (via `FP32` or `VALUES num`) or by referencing another element (using `ELE`). Optional parameters let you control the search behavior, such as score output, result count, and filtering options.
+
+```shell
+VSIM word_embeddings ELE apple
+1) "apple"
+2) "apples"
+3) "pear"
+4) "fruit"
+5) "berry"
+6) "pears"
+7) "strawberry"
+8) "peach"
+9) "potato"
+10) "grape"
+```
+
+You can include similarity scores and limit the number of results:
+
+```shell
+VSIM word_embeddings ELE apple WITHSCORES COUNT 3
+1) "apple"
+2) "0.9998867657923256"
+3) "apples"
+4) "0.8598527610301971"
+5) "pear"
+6) "0.8226882219314575"
+```
+
+Set the `EF` (exploration factor) to improve recall at the cost of performance. Use the `TRUTH` option to perform an exact linear scan, useful for benchmarking. The `NOTHREAD` option runs the search in the main thread and may increase server latency.
+
+## Required arguments
+
+json
+
+is a valid JSON string. Use an empty string (`""`) to delete the attributes.
+
+
+
+is the name of the key that holds the vector set data.
+
+
+key
+
+is the name of the key that holds the vector set data.
+
+
+
+specifies how the input vector is provided. Use `ELE` to refer to an existing element, `FP32` for binary float format, or `VALUES num` for a list of stringified float values.
+
+
+ELE | FP32 | VALUES num
+
+specifies how the input vector is provided. Use `ELE` to refer to an existing element, `FP32` for binary float format, or `VALUES num` for a list of stringified float values.
+
+
+
+is either the vector data (for `FP32` or `VALUES`) or the name of the element (for `ELE`) to use as the similarity reference.
+
+
+## Optional arguments
+
+vector or element
+
+is either the vector data (for `FP32` or `VALUES`) or the name of the element (for `ELE`) to use as the similarity reference.
+
+
+
+returns the similarity score (from 1 to 0) alongside each result. A score of 1 is identical; 0 is the opposite.
+
+
+WITHSCORES
+
+returns the similarity score (from 1 to 0) alongside each result. A score of 1 is identical; 0 is the opposite.
+
+
+
+limits the number of returned results to `num`.
+
+
+COUNT num
+
+limits the number of returned results to `num`.
+
+
+
+controls the search effort. Higher values explore more nodes, improving recall at the cost of speed. Typical values range from 50 to 1000.
+
+
+EF search-exploration-factor
+
+controls the search effort. Higher values explore more nodes, improving recall at the cost of speed. Typical values range from 50 to 1000.
+
+
+
+applies a filter expression to restrict matching elements. See the filtered search section for syntax details.
+
+
+FILTER expression
+
+applies a filter expression to restrict matching elements. See the filtered search section for syntax details.
+
+
+
+limits the number of filtering attempts for the `FILTER` expression. See the filtered search section for more.
+
+
+FILTER-EF max-filtering-effort
+
+limits the number of filtering attempts for the `FILTER` expression. See the filtered search section for more.
+
+
+
+forces an exact linear scan of all elements, bypassing the HNSW graph. Use for benchmarking or to calculate recall. This is significantly slower (O(N)).
+
+
+TRUTH
+
+forces an exact linear scan of all elements, bypassing the HNSW graph. Use for benchmarking or to calculate recall. This is significantly slower (O(N)).
+
+
+
+executes the search in the main thread instead of a background thread. Useful for small vector sets or benchmarks. This may block the server during execution.
+
+
+## Related topics
+
+- [Vector sets]({{< relref "/develop/data-types/vector-sets" >}})
diff --git a/content/develop/clients/_index.md b/content/develop/clients/_index.md
index da11724978..2e342239d6 100644
--- a/content/develop/clients/_index.md
+++ b/content/develop/clients/_index.md
@@ -57,8 +57,8 @@ Redis does not document directly:
## Requirements
You will need access to a Redis server to use these libraries.
-You can experiment with a local installation of Redis Stack
-(see [Install Redis Stack]({{< relref "/operate/oss_and_stack/install/install-stack/" >}})) or with a free trial of [Redis Cloud]({{< relref "/operate/rc" >}}).
+You can experiment with a local installation of Redis Community Edition
+(see [Install Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}})) or with a free trial of [Redis Cloud]({{< relref "/operate/rc" >}}).
To interact with a Redis server without writing code, use the
[Redis CLI]({{< relref "/develop/tools/cli" >}}) and
[Redis Insight]({{< relref "/develop/tools/insight" >}}) tools.
diff --git a/content/develop/clients/dotnet/_index.md b/content/develop/clients/dotnet/_index.md
index e1dd60f62a..5e12c52d06 100644
--- a/content/develop/clients/dotnet/_index.md
+++ b/content/develop/clients/dotnet/_index.md
@@ -20,7 +20,7 @@ weight: 3
The sections below explain how to install `NRedisStack` and connect your application
to a Redis database.
-`NRedisStack` requires a running Redis or [Redis Stack]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
+`NRedisStack` requires a running [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
You can also access Redis with an object-mapping client interface. See
[Redis OM for .NET]({{< relref "/integrate/redisom-for-net" >}})
@@ -70,9 +70,9 @@ Console.WriteLine(String.Join("; ", hashFields));
// Prints:
// name: John; surname: Smith; company: Redis; age: 29
```
-## Redis Stack modules
+## Redis Community Edition modules
-To access Redis Stack capabilities, use the appropriate interface like this:
+To access Redis Community Edition capabilities, use the appropriate interface like this:
```
IBloomCommands bf = db.BF();
diff --git a/content/develop/clients/dotnet/queryjson.md b/content/develop/clients/dotnet/queryjson.md
index 422853a9d2..9a14e4f77c 100644
--- a/content/develop/clients/dotnet/queryjson.md
+++ b/content/develop/clients/dotnet/queryjson.md
@@ -20,7 +20,7 @@ This example shows how to create a
for [JSON]({{< relref "/develop/data-types/json" >}}) data and
run queries against the index.
-Make sure that you have Redis Stack and `NRedisStack` installed.
+Make sure that you have Redis Community Edition and `NRedisStack` installed.
Start by importing dependencies:
diff --git a/content/develop/clients/go/_index.md b/content/develop/clients/go/_index.md
index b415ffb12e..4423f06e81 100644
--- a/content/develop/clients/go/_index.md
+++ b/content/develop/clients/go/_index.md
@@ -19,8 +19,7 @@ weight: 7
[`go-redis`](https://github.com/redis/go-redis) is the [Go](https://go.dev/) client for Redis.
The sections below explain how to install `go-redis` and connect your application to a Redis database.
-`go-redis` requires a running Redis or
-[Redis Stack]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server.
+`go-redis` requires a running [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server.
See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation
instructions.
diff --git a/content/develop/clients/go/queryjson.md b/content/develop/clients/go/queryjson.md
index 3e874b83cc..259c8c5dd1 100644
--- a/content/develop/clients/go/queryjson.md
+++ b/content/develop/clients/go/queryjson.md
@@ -19,7 +19,7 @@ This example shows how to create a
for [JSON]({{< relref "/develop/data-types/json" >}}) data and
run queries against the index.
-Make sure that you have Redis Stack and `go-redis` installed.
+Make sure that you have Redis Community Edition and `go-redis` installed.
Start by importing dependencies:
diff --git a/content/develop/clients/jedis/_index.md b/content/develop/clients/jedis/_index.md
index 1ae36dca9d..32ff86748b 100644
--- a/content/develop/clients/jedis/_index.md
+++ b/content/develop/clients/jedis/_index.md
@@ -22,7 +22,7 @@ a more advanced Java client that also supports asynchronous and reactive connect
The sections below explain how to install `Jedis` and connect your application
to a Redis database.
-`Jedis` requires a running Redis or [Redis Stack]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
+`Jedis` requires a running [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
## Install
diff --git a/content/develop/clients/jedis/queryjson.md b/content/develop/clients/jedis/queryjson.md
index 04e7319580..d594b191e3 100644
--- a/content/develop/clients/jedis/queryjson.md
+++ b/content/develop/clients/jedis/queryjson.md
@@ -20,7 +20,7 @@ This example shows how to create a
for [JSON]({{< relref "/develop/data-types/json" >}}) data and
run queries against the index.
-Make sure that you have Redis Stack and `Jedis` installed.
+Make sure that you have Redis Community Edition and `Jedis` installed.
Start by importing dependencies:
diff --git a/content/develop/clients/lettuce/_index.md b/content/develop/clients/lettuce/_index.md
index 8c8c9b9c6f..74fb817e98 100644
--- a/content/develop/clients/lettuce/_index.md
+++ b/content/develop/clients/lettuce/_index.md
@@ -24,7 +24,7 @@ If you only need synchronous connections then you may find the other Java client
The sections below explain how to install `Lettuce` and connect your application
to a Redis database.
-`Lettuce` requires a running Redis or [Redis Stack]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
+`Lettuce` requires a running [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
## Install
diff --git a/content/develop/clients/nodejs/_index.md b/content/develop/clients/nodejs/_index.md
index 8bc77c2ecc..1946ab6fe6 100644
--- a/content/develop/clients/nodejs/_index.md
+++ b/content/develop/clients/nodejs/_index.md
@@ -20,7 +20,7 @@ weight: 4
The sections below explain how to install `node-redis` and connect your application
to a Redis database.
-`node-redis` requires a running Redis or [Redis Stack]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
+`node-redis` requires a running [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
You can also access Redis with an object-mapping client interface. See
[RedisOM for Node.js]({{< relref "/integrate/redisom-for-node-js" >}})
diff --git a/content/develop/clients/om-clients/_index.md b/content/develop/clients/om-clients/_index.md
index d1902af7a9..773adfe6cf 100644
--- a/content/develop/clients/om-clients/_index.md
+++ b/content/develop/clients/om-clients/_index.md
@@ -10,14 +10,14 @@ categories:
- oss
- kubernetes
- clients
-description: Object-Mapper libraries for Redis Stack
+description: Object-Mapper libraries for Redis Community Edition
linkTitle: Object mapping
stack: true
title: Object-Mapper libraries
weight: 10
---
-Redis OM (pronounced *REDiss OHM*) is a library that provides object mapping for Redis. With the help of Redis OM, you can map Redis data types, specifically Hashes and JSON documents, to objects of your preferred programming language or framework. Redis OM relies on Redis Stack's JSON, query, and search features, allowing you to query and search for objects.
+Redis OM (pronounced *REDiss OHM*) is a library that provides object mapping for Redis. With the help of Redis OM, you can map Redis data types, specifically Hashes and JSON documents, to objects of your preferred programming language or framework. Redis OM relies on the JSON and Redis Query Engine features of Redis Community Edition, allowing you to search and/or query for objects.
You can use Redis OM with the following four programming languages:
diff --git a/content/develop/clients/php/_index.md b/content/develop/clients/php/_index.md
index 713a670e66..b67702efa2 100644
--- a/content/develop/clients/php/_index.md
+++ b/content/develop/clients/php/_index.md
@@ -24,8 +24,7 @@ The sections below explain how to install `Predis` and connect your application
client library and is not developed or supported directly by Redis.
{{< /note >}}
-`Predis` requires a running Redis or
-[Redis Stack]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server.
+`Predis` requires a running [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server.
See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation
instructions.
diff --git a/content/develop/clients/php/queryjson.md b/content/develop/clients/php/queryjson.md
index 13c2a4b21b..2236274d12 100644
--- a/content/develop/clients/php/queryjson.md
+++ b/content/develop/clients/php/queryjson.md
@@ -17,7 +17,7 @@ weight: 2
This example shows how to index and query Redis JSON data using `predis`.
-Make sure that you have Redis Stack and `predis` installed, as described
+Make sure that you have Redis Community Edition and `predis` installed, as described
in the [Install](#install) section above.
Start by importing dependencies:
diff --git a/content/develop/clients/redis-py/_index.md b/content/develop/clients/redis-py/_index.md
index 7b9b513a71..406276deca 100644
--- a/content/develop/clients/redis-py/_index.md
+++ b/content/develop/clients/redis-py/_index.md
@@ -20,7 +20,7 @@ weight: 1
The sections below explain how to install `redis-py` and connect your application
to a Redis database.
-`redis-py` requires a running Redis or [Redis Stack]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
+`redis-py` requires a running [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
You can also access Redis with an object-mapping client interface. See
[RedisOM for Python]({{< relref "/integrate/redisom-for-python" >}})
diff --git a/content/develop/clients/redis-py/queryjson.md b/content/develop/clients/redis-py/queryjson.md
index 4cb28eb354..76ed37e7ae 100644
--- a/content/develop/clients/redis-py/queryjson.md
+++ b/content/develop/clients/redis-py/queryjson.md
@@ -20,7 +20,7 @@ This example shows how to create a
for [JSON]({{< relref "/develop/data-types/json" >}}) data and
run queries against the index.
-Make sure that you have Redis Stack and `redis-py` installed.
+Make sure that you have Redis Community Edition and `redis-py` installed.
Import dependencies:
diff --git a/content/develop/data-types/_index.md b/content/develop/data-types/_index.md
index 58f279fe55..01da0c3c9a 100644
--- a/content/develop/data-types/_index.md
+++ b/content/develop/data-types/_index.md
@@ -38,7 +38,7 @@ implements the following data types:
- [Bitfield](#bitfields)
- [Geospatial](#geospatial-indexes)
-[Redis Stack]({{< relref "/operate/oss_and_stack" >}}) and
+[Redis Community Edition]({{< relref "/operate/oss_and_stack" >}}) and
[Redis Enterprise]({{< relref "/operate/rs" >}})
also include some [extension modules](#adding-extensions) that implement other
useful types, such as JSON. See [Extension data types](#extension-data-types)
@@ -122,7 +122,7 @@ For more information, see:
## Extension data types
-[Redis Stack]({{< relref "/operate/oss_and_stack" >}}) and
+[Redis Community Edition]({{< relref "/operate/oss_and_stack" >}}) and
[Redis Enterprise]({{< relref "/operate/rs" >}})
include some [extension modules](#adding-extensions) that implement
the following data types:
@@ -229,4 +229,4 @@ To extend the features provided by the included data types, use one of these opt
1. Write your own custom [server-side functions in Lua]({{< relref "/develop/interact/programmability/" >}}).
1. Write your own Redis module using the [modules API]({{< relref "/develop/reference/modules/" >}}) or check out the [community-supported modules]({{< relref "/operate/oss_and_stack/stack-with-enterprise/" >}}).
-1. Use [JSON]({{< relref "/develop/data-types/json/" >}}), [search]({{< relref "/develop/interact/search-and-query/" >}}), [time series]({{< relref "/develop/data-types/timeseries/" >}}), and other capabilities provided by [Redis Stack]({{< relref "/operate/oss_and_stack/" >}}).
+1. Use [JSON]({{< relref "/develop/data-types/json/" >}}), [search]({{< relref "/develop/interact/search-and-query/" >}}), [time series]({{< relref "/develop/data-types/timeseries/" >}}), and other capabilities provided by [Redis Community Edition]({{< relref "/operate/oss_and_stack/" >}}).
diff --git a/content/develop/data-types/json/_index.md b/content/develop/data-types/json/_index.md
index c575a5279b..8c52c6ef0e 100644
--- a/content/develop/data-types/json/_index.md
+++ b/content/develop/data-types/json/_index.md
@@ -19,7 +19,7 @@ weight: 11
[](https://discord.gg/QUkjSsk)
[](https://github.com/RedisJSON/RedisJSON/)
-The JSON capability of Redis Stack provides JavaScript Object Notation (JSON) support for Redis. It lets you store, update, and retrieve JSON values in a Redis database, similar to any other Redis data type. Redis JSON also works seamlessly with the [Redis Query Engine]({{< relref "/develop/interact/search-and-query/" >}}) to let you [index and query JSON documents]({{< relref "/develop/interact/search-and-query/indexing/" >}}).
+The JSON capability of Redis Community Edition provides JavaScript Object Notation (JSON) support for Redis. It lets you store, update, and retrieve JSON values in a Redis database, similar to any other Redis data type. Redis JSON also works seamlessly with the [Redis Query Engine]({{< relref "/develop/interact/search-and-query/" >}}) to let you [index and query JSON documents]({{< relref "/develop/interact/search-and-query/indexing/" >}}).
## Primary features
@@ -144,11 +144,9 @@ $ redis-cli --raw
## Enable Redis JSON
-Redis JSON is not available by default in the basic Redis server, so you
-should install Redis Stack or Redis Enterprise,
-both of which include JSON and other useful modules.
+The Redis JSON data type is part of Redis Community Edition and it is also available in Redis Software and Redis Cloud.
See
-[Install Redis Stack]({{< relref "/operate/oss_and_stack/install/install-stack" >}}) or
+[Install Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack" >}}) or
[Install Redis Enterprise]({{< relref "/operate/rs/installing-upgrading/install" >}})
for full installation instructions.
diff --git a/content/develop/data-types/json/indexing_JSON.md b/content/develop/data-types/json/indexing_JSON.md
index 27e2b003db..e5f6abbc2c 100644
--- a/content/develop/data-types/json/indexing_JSON.md
+++ b/content/develop/data-types/json/indexing_JSON.md
@@ -17,6 +17,6 @@ weight: 2
In addition to storing JSON documents, you can also index them using the [Redis Query Engine]({{< relref "/develop/interact/search-and-query/" >}}) feature. This enables full-text search capabilities and document retrieval based on their content.
-To use these features, you must install two modules: RedisJSON and RediSearch. [Redis Stack]({{< relref "/operate/oss_and_stack/" >}}) automatically includes both modules.
+To use these features, install [Redis Community Edition]({{< relref "/operate/oss_and_stack/" >}}).
See the [tutorial]({{< relref "/develop/interact/search-and-query/indexing/" >}}) to learn how to search and query your JSON.
\ No newline at end of file
diff --git a/content/develop/data-types/json/performance/_index.md b/content/develop/data-types/json/performance/_index.md
index d2a13a9092..911ed95a67 100644
--- a/content/develop/data-types/json/performance/_index.md
+++ b/content/develop/data-types/json/performance/_index.md
@@ -107,7 +107,7 @@ performance of the module:
## Comparison vs. server-side Lua scripting
-We compare Redis Stack's JSON performance with Redis' embedded Lua engine. For this purpose, we use the Lua
+We compare Redis Community Edition's JSON performance with the Redis embedded Lua engine. For this purpose, we use the Lua
scripts at [/benchmarks/lua](https://github.com/RedisLabsModules/redisjson/tree/master/benchmarks/lua).
These scripts provide JSON's GET and SET functionality on values stored in JSON or MessagePack
formats. Each of the different operations (set root, get root, set path and get path) is executed
diff --git a/content/develop/data-types/json/use_cases.md b/content/develop/data-types/json/use_cases.md
index 2b2e1f73bc..537b8ee406 100644
--- a/content/develop/data-types/json/use_cases.md
+++ b/content/develop/data-types/json/use_cases.md
@@ -31,4 +31,4 @@ JSON allows you to atomically run operations like incrementing a value, adding,
**Indexing and querying**
-When you store JSON objects as Redis strings, there's no good way to query those objects. On the other hand, storing these objects as JSON using Redis Stack lets you index and query them. This capability is provided by the Redis Query Engine.
\ No newline at end of file
+When you store JSON objects as Redis strings, there's no good way to query those objects. On the other hand, storing these objects as JSON using Redis Community Edition lets you index and query them. This capability is provided by the Redis Query Engine.
\ No newline at end of file
diff --git a/content/develop/data-types/probabilistic/Configuration.md b/content/develop/data-types/probabilistic/Configuration.md
deleted file mode 100644
index 0cc9071f90..0000000000
--- a/content/develop/data-types/probabilistic/Configuration.md
+++ /dev/null
@@ -1,101 +0,0 @@
----
-categories:
-- docs
-- develop
-- stack
-- oss
-- rs
-- rc
-- oss
-- kubernetes
-- clients
-description: 'RedisBloom supports multiple module configuration parameters. All of
- these parameters can only be set at load-time.
-
- '
-linkTitle: Configuration
-title: Configuration Parameters
-weight: 100
----
-
-## Setting configuration parameters on module load
-
-Setting configuration parameters at load-time is done by appending arguments after the `--loadmodule` argument when starting a server from the command line or after the `loadmodule` directive in a Redis config file. For example:
-
-In [redis.conf]({{< relref "/operate/oss_and_stack/management/config" >}}):
-
-```sh
-loadmodule ./redisbloom.so [OPT VAL]...
-```
-
-From the [Redis CLI]({{< relref "/develop/tools/cli" >}}), using the [MODULE LOAD]({{< relref "/commands/module-load" >}}) command:
-
-```
-127.0.0.6379> MODULE LOAD redisbloom.so [OPT VAL]...
-```
-
-From the command line:
-
-```sh
-$ redis-server --loadmodule ./redisbloom.so [OPT VAL]...
-```
-
-## RedisBloom configuration parameters
-
-The following table summarizes which configuration parameters can be set at module load-time and which can be set on run-time:
-
-| Configuration Parameter | Load-time | Run-time |
-| :------- | :----- | :----------- |
-| [ERROR_RATE](#error_rate) | :white_check_mark: | :white_large_square: |
-| [INITIAL_SIZE](#initial_size) | :white_check_mark: | :white_large_square: |
-| [CF_MAX_EXPANSIONS](#cf_max_expansions) | :white_check_mark: | :white_large_square: |
-
-
-## Default parameters
-
-!!! warning "Note on using initialization default sizes"
- A filter should always be sized for the expected capacity and the desired error-rate.
- Using the `INSERT` family commands with the default values should be used in cases where many small filter exist and the expectation is most will remain at about that size.
- Not optimizing a filter for its intended use will result in degradation of performance and memory efficiency.
-
-### ERROR_RATE
-
-Default error ratio for Bloom filters.
-
-#### Default
-
-`0.01`
-
-#### Example
-
-```
-$ redis-server --loadmodule /path/to/redisbloom.so ERROR_RATE 0.004
-```
-
-### INITIAL_SIZE
-
-Default initial capacity for Bloom filters.
-
-#### Default
-
-`100`
-
-#### Example
-
-```
-$ redis-server --loadmodule /path/to/redisbloom.so INITIAL_SIZE 400
-```
-
-### CF_MAX_EXPANSIONS
-
-Default maximum expansions for Cuckoo filters.
-
-#### Default
-
-`32`
-
-#### Example
-
-```
-$ redis-server --loadmodule /path/to/redisbloom.so CF_MAX_EXPANSIONS 16
-```
diff --git a/content/develop/data-types/probabilistic/_index.md b/content/develop/data-types/probabilistic/_index.md
index d3da185ad1..680812ced9 100644
--- a/content/develop/data-types/probabilistic/_index.md
+++ b/content/develop/data-types/probabilistic/_index.md
@@ -22,10 +22,8 @@ many common purposes but are much more efficient to calculate. They
sometimes have other advantages too, such as obfuscating times, locations,
and other sensitive data.
-Probabilistic data structures are not available by default in the basic
-Redis server, so you should install Redis Stack or Redis Enterprise,
-both of which include probabilistic structures and other useful modules.
+Probabilistic data structures are available as part of Redis Community Edition and they are available in Redis Software and Redis Cloud.
See
-[Install Redis Stack]({{< relref "/operate/oss_and_stack/install/install-stack" >}}) or
+[Install Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack" >}}) or
[Install Redis Enterprise]({{< relref "/operate/rs/installing-upgrading/install" >}})
for full installation instructions.
\ No newline at end of file
diff --git a/content/develop/data-types/probabilistic/bloom-filter.md b/content/develop/data-types/probabilistic/bloom-filter.md
index 08a864ac22..fde6dad012 100644
--- a/content/develop/data-types/probabilistic/bloom-filter.md
+++ b/content/develop/data-types/probabilistic/bloom-filter.md
@@ -17,7 +17,7 @@ title: Bloom filter
weight: 10
---
-A Bloom filter is a probabilistic data structure in Redis Stack that enables you to check if an item is present in a set using a very small memory space of a fixed size.
+A Bloom filter is a probabilistic data structure in Redis Community Edition that enables you to check if an element is present in a set using a very small memory space of a fixed size.
Instead of storing all the items in a set, a Bloom Filter stores only the items' hashed representations, thus sacrificing some precision. The trade-off is that Bloom Filters are very space-efficient and fast.
@@ -31,7 +31,7 @@ This application answers the question, "Has the user paid from this location bef
Use one Bloom filter per user, checked for every transaction. Provide an extremely fast response (local latency). Replicate in different regions in case the user moves. Prevent decreasing performance with scale.
-Using Redis Stack's Bloom filter for this type of application provides these benefits:
+Using the Redis Bloom filter for this type of application provides these benefits:
- Fast transaction completion
- Decreased possibility for transaction to break in case of network partitions (connection needs to be kept open for a shorter time)
@@ -55,7 +55,7 @@ Use a Bloom filter for every user, storing all bought products. The recommendati
- If no, the ad is shown to the user and is added to the Bloom filter.
- If yes, the process restarts and repeats until it finds a product that is not present in the filter.
-Using Redis Stack's Bloom filter for this type of application provides these benefits:
+Using the Redis Bloom filter for this type of application provides these benefits:
- Cost efficient way to a customized near real-time experience
- No need to invest in expensive infrastructure
@@ -71,7 +71,7 @@ Use a Bloom filter for every username that has signed up. A new user types in th
The query time stays the same at scale.
-Using Redis Stack's Bloom filter for this type of application provides these benefits:
+Using the Redis Bloom filter for this type of application provides these benefits:
- Very fast and efficient way to do a common operation
- No need to invest in expensive infrastructure
@@ -101,7 +101,7 @@ OK
Note: there is always a chance that even with just a few items, there could be a false positive, meaning an item could "exist" even though it has not been explicitly added to the Bloom filter. For a more in depth understanding of the probabilistic nature of a Bloom filter, check out the blog posts linked at the bottom of this page.
## Reserving Bloom filters
-With Redis Stack's Bloom filters most of the sizing work is done for you:
+With the Redis Bloom filter, most of the sizing work is done for you:
```
BF.RESERVE {key} {error_rate} {capacity} [EXPANSION expansion] [NONSCALING]
diff --git a/content/develop/data-types/probabilistic/configuration.md b/content/develop/data-types/probabilistic/configuration.md
new file mode 100644
index 0000000000..b931f42da4
--- /dev/null
+++ b/content/develop/data-types/probabilistic/configuration.md
@@ -0,0 +1,174 @@
+---
+categories:
+- docs
+- develop
+- stack
+- oss
+- rs
+- rc
+- oss
+- kubernetes
+- clients
+description: Redis probabilistic data structures support multiple configuration parameters.
+linkTitle: Configuration
+title: Configuration Parameters
+weight: 100
+---
+{{< note >}}
+As of Redis Community Edition (CE) 8.0, configuration parameters for the probabilistic data structures are now set in the following ways:
+* At load time via your `redis.conf` file.
+* At run time (where applicable) using the [`CONFIG SET`]({{< relref "/commands/config-set" >}}) command.
+
+Also, Redis CE 8.0 persists probabilistic configuration parameters just like any other configuration parameters (e.g., using the [`CONFIG REWRITE`]({{< relref "/commands/config-rewrite/" >}}) command).
+{{< /note >}}
+
+
+## Redis probabilistic data structure configuration parameters
+
+The following table summarizes which Bloom filter configuration parameters can be set at run-time, and compatibility with Redis Software and Redis Cloud.
+
+| Parameter nameNOTHREAD
+
+executes the search in the main thread instead of a background thread. Useful for small vector sets or benchmarks. This may block the server during execution.
+(version < 8.0) | Parameter name
(version ≥ 8.0) | Run-time | Redis
Software | Redis
Cloud | +| :------- | :------- | :------- | :------- | :------- | +| ERROR_RATE | [bf-error-rate](#bf-error-rate) | :white_check_mark: | ✅ Supported
| ✅ Flexible & Annual
| ✅ Flexible & Annual
(version < 8.0) | Parameter name
(version ≥ 8.0) | Run-time | Redis
Software | Redis
Cloud | +| :------- | :------- | :------- | :------- | :------- | +| | [cf-bucket-size](#cf-bucket-size) | :white_check_mark: ||| +| | [cf-initial-size](#cf-initial-size) | :white_check_mark: ||| +| | [cf-expansion-factor](#cf-expansion-factor) | :white_check_mark: ||| +| CF_MAX_EXPANSIONS | [cf-max-expansions](#cf-max-expansions) | :white_check_mark: | ✅ Supported
| ✅ Flexible & Annual
(version < 8.0) | Parameter name
(version ≥ 8.0) | Run-time | Redis
Software | Redis
Cloud | +| :------- | :------- | :------- | :------- | :------- | +| CHUNK_SIZE_BYTES | [ts-chunk-size-bytes](#ts-chunk-size-bytes) | :white_check_mark: | ✅ Supported
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
2. Follow the instructions to create a free database.
-This free Redis Cloud database comes out of the box with all the Redis Stack features.
+This free Redis Cloud database comes out of the box with all the Redis Community Edition features.
-You can alternatively use the [installation guides]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) to install Redis Stack on your local machine.
+You can alternatively use the [installation guides]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) to install Redis Community Edition on your local machine.
## Connect
-The first step is to connect to your Redis Stack database. You can find further details about the connection options in this documentation site's [Tools section]({{< relref "/develop/tools" >}}). The following example shows how to connect to a Redis Stack server that runs on localhost (`-h 127.0.0.1`) and listens on the default port (`-p 6379`):
+The first step is to connect to your Redis Community Edition database. You can find further details about the connection options in this documentation site's [Tools section]({{< relref "/develop/tools" >}}). The following example shows how to connect to a Redis Community Edition server that runs on localhost (`-h 127.0.0.1`) and listens on the default port (`-p 6379`):
{{< clients-example search_quickstart connect >}}
> redis-cli -h 127.0.0.1 -p 6379
@@ -65,7 +65,7 @@ You can copy and paste the connection details from the Redis Cloud database conf
## Create an index
-As explained in the [in-memory data store]({{< relref "/develop/get-started/data-store" >}}) quick start guide, Redis allows you to access an item directly via its key. You also learned how to scan the keyspace. Whereby you can use other data structures (e.g., hashes and sorted sets) as secondary indexes, your application would need to maintain those indexes manually. Redis Stack turns Redis into a document database by allowing you to declare which fields are auto-indexed. Redis Stack currently supports secondary index creation on the [hashes]({{< relref "/develop/data-types/hashes" >}}) and [JSON]({{< relref "/develop/data-types/json" >}}) documents.
+As explained in the [in-memory data store]({{< relref "/develop/get-started/data-store" >}}) quick start guide, Redis allows you to access an item directly via its key. You also learned how to scan the keyspace. Whereby you can use other data structures (e.g., hashes and sorted sets) as secondary indexes, your application would need to maintain those indexes manually. Redis is a document database that allows you to declare which fields are auto-indexed. Redis currently supports secondary index creation on the [hashes]({{< relref "/develop/data-types/hashes" >}}) and [JSON]({{< relref "/develop/data-types/json" >}}) documents.
The following example shows an [FT.CREATE]({{< relref "commands/ft.create" >}}) command that creates an index with some text fields, a numeric field (price), and a tag field (condition). The text fields have a weight of 1.0, meaning they have the same relevancy in the context of full-text searches. The field names follow the [JSONPath]({{< relref "/develop/data-types/json/path" >}}) notion. Each such index field maps to a property within the JSON document.
@@ -173,7 +173,7 @@ Please see the [query documentation]({{< relref "/develop/interact/search-and-qu
## Next steps
-You can learn more about how to use Redis Stack as a vector database in the following quick start guide:
+You can learn more about how to use Redis Community Edition as a vector database in the following quick start guide:
* [Redis as a vector database]({{< relref "/develop/get-started/vector-database" >}})
diff --git a/content/develop/get-started/vector-database.md b/content/develop/get-started/vector-database.md
index 15411c7cc5..fea1bc77e6 100644
--- a/content/develop/get-started/vector-database.md
+++ b/content/develop/get-started/vector-database.md
@@ -46,7 +46,7 @@ Data is often unstructured, which means that it isn't described by a well-define
## Create a Redis vector database
-You can use [Redis Stack]({{< relref "/operate/oss_and_stack/" >}}) as a vector database. It allows you to:
+You can use [Redis Community Edition]({{< relref "/operate/oss_and_stack/" >}}) as a vector database. It allows you to:
* Store vectors and the associated metadata within hashes or [JSON]({{< relref "/develop/data-types/json" >}}) documents
* Create and configure secondary indices for search
@@ -61,11 +61,9 @@ The easiest way to get started is to use Redis Cloud:
2. Follow the instructions to create a free database.
-This free Redis Cloud database comes out of the box with all the Redis Stack features.
+This free Redis Cloud database comes out of the box with all the Redis Community Edition features.
-You can alternatively use the [installation guides]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) to install Redis Stack on your local machine.
-
-You need to have the following features configured for your Redis server: JSON and Search and query.
+You can alternatively use the [installation guides]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) to install Redis on your local machine.
## Install the required Python packages
@@ -87,7 +85,7 @@ Connect to Redis. By default, Redis returns binary responses. To decode them, yo
{{< clients-example search_vss connect />}}
{{% alert title="Tip" color="warning" %}} -Instead of using a local Redis Stack server, you can copy and paste the connection details from the Redis Cloud database configuration page. Here is an example connection string of a Cloud database that is hosted in the AWS region `us-east-1` and listens on port 16379: `redis-16379.c283.us-east-1-4.ec2.cloud.redislabs.com:16379`. The connection string has the format `host:port`. You must also copy and paste the username and password of your Cloud database. The line of code for connecting with the default user changes then to `client = redis.Redis(host="redis-16379.c283.us-east-1-4.ec2.cloud.redislabs.com", port=16379, password="your_password_here", decode_responses=True)`. +Instead of using a local Redis server, you can copy and paste the connection details from the Redis Cloud database configuration page. Here is an example connection string of a Cloud database that is hosted in the AWS region `us-east-1` and listens on port 16379: `redis-16379.c283.us-east-1-4.ec2.cloud.redislabs.com:16379`. The connection string has the format `host:port`. You must also copy and paste the username and password of your Cloud database. The line of code for connecting with the default user changes then to `client = redis.Redis(host="redis-16379.c283.us-east-1-4.ec2.cloud.redislabs.com", port=16379, password="your_password_here", decode_responses=True)`. {{% /alert %}} diff --git a/content/develop/interact/search-and-query/_index.md b/content/develop/interact/search-and-query/_index.md index 396feb6379..f211cbf847 100644 --- a/content/develop/interact/search-and-query/_index.md +++ b/content/develop/interact/search-and-query/_index.md @@ -45,20 +45,16 @@ Here are the next steps to get you started: ## Enable the Redis Query Engine -The Redis Query Engine is not available by default in the basic Redis server, so you -should install Redis Stack or Redis Enterprise, -both of which include Redis search and other useful modules. +The Redis Query Engine is available in Redis Community Edition, Redis Software, and Redis Cloud. See -[Install Redis Stack]({{< relref "/operate/oss_and_stack/install/install-stack" >}}) or +[Install Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack" >}}) or [Install Redis Enterprise]({{< relref "/operate/rs/installing-upgrading/install" >}}) for full installation instructions. ## License and source code -The Redis Query Engine features of Redis Stack are available under the Source Available License 2.0 (RSALv2) or the Server Side Public License v1 (SSPLv1). Please read the [license file](https://raw.githubusercontent.com/RediSearch/RediSearch/master/LICENSE.txt) for further details. The source code and the [detailed release notes](https://github.com/RediSearch/RediSearch/releases) are available on [GitHub](https://github.com/RediSearch/RediSearch). +The Redis Query Engine features of Redis are available under the Source Available License 2.0 (RSALv2) or the Server Side Public License v1 (SSPLv1). Please read the [license file](https://raw.githubusercontent.com/RediSearch/RediSearch/master/LICENSE.txt) for further details. The source code and the [detailed release notes](https://github.com/RediSearch/RediSearch/releases) are available on [GitHub](https://github.com/RediSearch/RediSearch). Do you have questions? Feel free to ask at the [RediSearch forum](https://forum.redis.com/c/modules/redisearch/). -Redis Ltd. provides commercial support for Redis Stack. Please see the [Redis Ltd. website](https://redis.com/redis-enterprise/technology/redis-search/#sds) for more details and contact information. -
\ No newline at end of file diff --git a/content/develop/interact/search-and-query/administration/configuration.md b/content/develop/interact/search-and-query/administration/configuration.md new file mode 100644 index 0000000000..a08b44823b --- /dev/null +++ b/content/develop/interact/search-and-query/administration/configuration.md @@ -0,0 +1,587 @@ +--- +aliases: /develop/interact/search-and-query/basic-constructs/configuration-parameters +categories: +- docs +- develop +- stack +- oss +- rs +- rc +- oss +- kubernetes +- clients +description: 'Redis Query Engine can be tuned through multiple + configuration parameters. Some of these parameters can only be set at load-time, + while other parameters can be set either at load-time or at run-time.' +linkTitle: Configuration parameters +title: Configuration parameters +weight: 1 +--- +{{< note >}} +As of Redis Community Edition (CE) 8.0, configuration parameters for the time series data structure are now set in the following ways: +* At load time via your `redis.conf` file. +* At run time (where applicable) using the [`CONFIG SET`]({{< relref "/commands/config-set" >}}) command. + +Also, CE 8.0 persists probabilistic configuration parameters just like any other configuration parameters (e.g., using the [`CONFIG REWRITE`]({{< relref "/commands/config-rewrite/" >}}) command). +{{< /note >}} + +## Redis Query Engine configuration parameters + +The following table summarizes which configuration parameters can be set at run-time, and compatibility with Redis Software and Redis Cloud. + +| Parameter name
(version < 8.0) | Parameter name
(version ≥ 8.0) | Run-time | Redis
Software | Redis
Cloud | +| :------- | :------- | :------- | :------- | :------- | +| BG_INDEX_SLEEP_GAP | [search-bg-index-sleep-gap](#search-bg-index-sleep-gap) | :white_large_square: ||| +| CONCURRENT_WRITE_MODE | [search-concurrent-write-mode](#search-concurrent-write-mode) | :white_check_mark: | ✅ Supported
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
|
@@ -129,7 +129,7 @@ View and manage the list of consumer groups. See existing consumers in a given c
### Search features
-If you're using Redis Stack's indexing, querying, or full-text search features, Redis Insight provides UI controls to quickly and conveniently run search queries against a preselected index. You can also create a secondary index of your data in a dedicated pane.
+If you're using the indexing, querying, or full-text search features of Redis Community Edition, Redis Insight provides UI controls to quickly and conveniently run search queries against a preselected index. You can also create a secondary index of your data in a dedicated pane.
diff --git a/content/develop/whats-new/8-0-rc-1.md b/content/develop/whats-new/8-0-rc-1.md
new file mode 100644
index 0000000000..7bb616df9b
--- /dev/null
+++ b/content/develop/whats-new/8-0-rc-1.md
@@ -0,0 +1,79 @@
+---
+title: Redis 8.0-RC1
+alwaysopen: false
+categories:
+- docs
+- operate
+- rs
+- rc
+description: What's new in Redis 8.0-RC1
+linkTitle: What's new in Redis 8.0-RC1
+weight: 5
+---
+
+## Highlights
+
+- **Integrated modules** now part of core:
+ - JSON
+ - Probabilistic Time Series: Bloom, Cuckoo, Count-min sketch, Top-K, and t-digest
+ - Time Series
+ - [Vector Set (preview)]({{< relref "/develop/data-types/vector-sets/" >}})
+ - [Redis Query Engine]({{< relref "/develop/interact/#search-and-query" >}}) with horizontal & vertical scaling
+ - All components available in Redis binary distributions
+ - New config file: `redis-full.conf` for full component loading
+
+## New Commands
+
+- **Hash with expiration support**:
+ - `HGETDEL` – get and delete hash field
+ - `HGETEX`, `HSETEX` – get/set hash fields with expiration
+- **Field TTL & expiration (7.4+)**:
+ - `HEXPIRE`, `HPEXPIRE`, `HEXPIREAT`, `HPEXPIREAT`
+ - `HPERSIST`, `HEXPIRETIME`, `HPEXPIRETIME`, `HTTL`, `HPTTL`
+- **Other command additions**:
+ - `XREAD +` – read latest stream entry
+ - `HSCAN NOVALUES` – scan hash field names only
+ - `SORT` in cluster mode with `BY` and `GET`
+ - `CLIENT KILL MAXAGE`
+ - Lua: `os.clock()` now available
+ - `SPUBLISH` in `MULTI/EXEC` transactions on replicas
+ - [Vector set command group (preview)] ({{< relref "/commands/?group=vector_set" >}})
+
+## Internal Architecture
+
+- **I/O threading overhaul**: read+write threading for higher throughput
+- **Replication**: improved mechanism with AOF offset support
+- **Over 30 performance optimizations**:
+ - Optimized: `GET`, `EXISTS`, `LRANGE`, `HSET`, `XREAD`, `SCAN`, `ZADD`, `ZUNION`, `PFCOUNT`, `HSCAN`, and more
+ - Improved latency, memory, and CPU utilization
+
+## Security
+
+- CVE-2024-46981: Lua RCE
+- CVE-2024-51741: ACL DoS
+- CVE-2024-31449, 31227, 31228: DoS in Lua/ACLs
+
+## Packaging
+
+- [Docker](https://hub.docker.com/_/redis)
+- Snap, Brew, APT, and RPM packages are available
+
+## Observability
+
+- New `INFO` sections:
+ - `KEYSIZES`, `Threads`
+ - Hash expiration stats
+ - Client buffer disconnection counters
+ - Dictionary memory rehashing
+ - Script eviction stats
+
+## Upgrades & Support
+
+- Supports upgrade from:
+ - Redis 7.x with or without modules
+ - Redis Stack 7.2 and 7.4
+- Supported OS:
+ - Ubuntu 20.04 / 22.04 / 24.04
+ - Debian 11 / 12
+ - macOS 13–15
+ - Rocky/Alma Linux 8.10, 9.5
diff --git a/content/develop/whats-new/redis-feature-sets.md b/content/develop/whats-new/redis-feature-sets.md
index 99a12f0580..6727540144 100644
--- a/content/develop/whats-new/redis-feature-sets.md
+++ b/content/develop/whats-new/redis-feature-sets.md
@@ -17,6 +17,7 @@ To use a new feature introduced in a later feature set, you must upgrade the cor
| Redis feature set | What's new |
|-------------------|------------|
+| **Feature set version:** 8.0-RC1| See [here]({{< relref "/develop/whats-new/8-0-rc-1" >}})|
| **Feature set version:** 7.4**Component versions:**
[Redis 7.4]({{
[Search 2.10]({{< relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-2.10-release-notes.md" >}})
[JSON 2.8]({{
[Time series 1.12]({{
[Bloom 2.8]({{
- [Expiration of individual hash fields]({{
**Streams**:
- To start reading from the last stream message, use [`XREAD`]({{
**Time series**:
Insertion-filter for close samples.
**JSON**:
- A fix to not duplicate `AOF` commands multiple times in [`JSON.MSET`]({{< relref "commands/json.mset/" >}}).
**Probabilistic**:
- Returns an error if [`CMS.MERGE`]({{< relref "commands/cms.merge/" >}}) results in an overflow or underflow.
**Redis Query Engine**:
- New `BFLOAT16` and `FLOAT16` vector data types, reducing memory consumed by vectors while preserving accuracy.
- Support for indexing empty and missing values and enhanced developer experience for queries with exact matching capabilities.
- You can match `TAG` fields without needing to escape special characters.
- Expanded geospatial search with new `INTERSECT` and `DISJOINT` operators, improved reporting of the memory consumed by the index, and exposed full-text scoring in aggregation pipelines. | | **Feature set version:** 7.2
**Component versions:**
[Redis 7.2](https://raw.githubusercontent.com/redis/redis/7.2/00-RELEASENOTES)
[Search 2.8]({{< relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-2.8-release-notes.md" >}})
[JSON 2.6]({{
[Time series 1.10]({{
[Bloom 2.6]({{
[Gears 2.0](https://github.com/RedisGears/RedisGears/releases) | - Performance and resource utilization improvements, including significant memory and speed optimizations for lists, sets, and sorted sets.
**JSON**:
- New JSON commands: [`JSON.MERGE`]({{< relref "commands/json.merge/" >}}) and [`JSON.MSET`]({{< relref "commands/json.mset/" >}}).
**Redis Query Engine:**
- [Geo polygon search]({{< relref "commands/ft.search/#examples" >}}).
**Compatibility changes**:
- Redis 7.2 uses a new format (version 11) for RDB files, which is incompatible with older versions.
- Redis feature set 7.2 does not include [graph capabilities](https://redis.io/blog/redisgraph-eol/). | | **Feature set version:** 6.2
**Component versions:**
[Redis 6.2](https://raw.githubusercontent.com/redis/redis/6.2/00-RELEASENOTES)
[Search 2.6]({{< relref "/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-2.6-release-notes.md" >}})
[JSON 2.4]({{
[Time series 1.8]({{
[Bloom 2.4]({{
[Graph 2.10]({{
- Time series gap filling.
**JSON**:
- Improved JSON path parser.
**Probabilistic:**
- New probabilistic data structure t-digest.
**Redis Query Engine:**
- Wildcard queries for `TEXT` and `TAG`.
- Suffix search.
- Multi-value indexing and queries.
**Graph**:
- New pathfinding algorithms for graphs. | diff --git a/content/embeds/rs-prometheus-metrics-v2.md b/content/embeds/rs-prometheus-metrics-v2.md index 344ae8c85d..9ce23c5740 100644 --- a/content/embeds/rs-prometheus-metrics-v2.md +++ b/content/embeds/rs-prometheus-metrics-v2.md @@ -151,6 +151,22 @@ | redis_server_total_net_output_bytes | Number of bytes sent by the shard; calculate the throughput for a time period by comparing the value at different times | | redis_server_up | Shard is up and running | | redis_server_used_memory | Memory used by shard (in BigRedis this includes flash) (bytes) | +| redis_server_search_gc_bytes_collected | The total amount of memory freed by the garbage collectors from indexes in the shard's memory in bytes. [3](#tnote-3) | +| redis_server_search_bytes_collected | The total amount of memory freed by the garbage collectors from indexes in the shard's memory in bytes. Deprecated in 8.0 (renamed redis_server_search_gc_bytes_collected), but still available in older versions. [1](#tnote-1) | +| redis_server_search_gc_marked_deleted_vectors | The number of vectors marked as deleted in the vector indexes that have not yet been cleaned. [3](#tnote-3) | +| redis_server_search_marked_deleted_vectors | The number of vectors marked as deleted in the vector indexes that have not yet been cleaned. Deprecated in 8.0 (renamed redis_server_search_gc_marked_deleted_vectors), but still available in older versions. [1](#tnote-1) | +| redis_server_search_gc_total_cycles | The total number of garbage collection cycles executed. [3](#tnote-3) | +| redis_server_search_total_cycles | The total number of garbage collection cycles executed. Deprecated in 8.0 (renamed redis_server_search_gc_total_cycles), but still available in older versions. [1](#tnote-1) | +| redis_server_search_gc_total_docs_not_collected_by_gc | The number of documents marked as deleted, whose memory has not yet been freed by the garbage collector. [3](#tnote-3) | +| redis_server_search_total_docs_not_collected_by_gc | The number of documents marked as deleted, whose memory has not yet been freed by the garbage collector. Deprecated in 8.0 (renamed redis_server_search_gc_total_docs_not_collected_by_gc), but still available in older versions. [1](#tnote-1) | +| redis_server_search_gc_total_ms_run | The total duration of all garbage collection cycles in the shard, measured in milliseconds. [3](#tnote-3) | +| redis_server_search_total_ms_run | The total duration of all garbage collection cycles in the shard, measured in milliseconds. Deprecated in 8.0 (renamed redis_server_search_gc_total_ms_run), but still available in older versions. [1](#tnote-1) | +| redis_server_search_cursors_internal_idle | The total number of coordinator cursors that are currently holding pending results in the shard. [3](#tnote-3) | +| redis_server_search_cursors_user_idle | The total number of cursors that were explicitly requested by users, that are currently holding pending results in the shard. [3](#tnote-3) | +| redis_server_search_global_idle | The total number of user and internal cursors currently holding pending results in the shard. Deprecated in 8.0 (split into redis_server_search_cursors_internal_idle and redis_server_search_cursors_user_idle), but still available in older versions. [1](#tnote-1) | +| redis_server_search_cursors_internal_active | The total number of coordinator cursors in the shard, either holding pending results or actively executing `FT.CURSOR READ`. [3](#tnote-3) | +| redis_server_search_cursors_user_active | The total number of user cursors in the shard, either holding pending results or actively executing `FT.CURSOR READ`. [3](#tnote-3) | +| redis_server_search_global_total | The total number of user and internal cursors in the shard, either holding pending results or actively executing `FT.CURSOR READ`. Deprecated in 8.0 (split into redis_server_search_cursors_internal_active and redis_server_search_cursors_user_active), but still available in older versions. [1](#tnote-1) | | redis_server_search_number_of_indexes | Total number of indexes in the shard [1](#tnote-1) | | redis_server_search_number_of_active_indexes | The total number of indexes running a background indexing and/or background query processing operation. Background indexing refers to vector ingestion process, or in-progress background indexer. [1](#tnote-1) | | redis_server_search_number_of_active_indexes_running_queries | Total count of indexes currently running a background query process. [1](#tnote-1) | @@ -196,4 +212,5 @@ | redis_server_search_errors_for_index_with_max_failures | The number of indexing failures in the index with the highest count of failures. [1](#tnote-1) | 1. Available since RediSearch 2.6. -2. Available since RediSearch 2.8. \ No newline at end of file +2. Available since RediSearch 2.8. +3. Available since RediSearch 8.0. \ No newline at end of file diff --git a/content/get-started/_index.md b/content/get-started/_index.md index ed9fe4e19a..ba0bb7ee38 100644 --- a/content/get-started/_index.md +++ b/content/get-started/_index.md @@ -9,12 +9,12 @@ Redis is an [in-memory data store]({{< relref "/develop/get-started/data-store" You can install Redis from source, from an executable for your OS, or bundled with Redis Stack and Redis Insight which include popular features and monitoring. -* [Install Redis on Linux]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-on-linux" >}}) -* [Install Redis on macOS]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os" >}}) -* [Install Redis on Windows]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-on-windows" >}}) -* [Install Redis with Redis Stack and Redis Insight]({{< relref "/operate/oss_and_stack/install/install-stack" >}}) +* [Install Redis on Linux]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-on-linux" >}}) +* [Install Redis on macOS]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-on-mac-os" >}}) +* [Install Redis on Windows]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-on-windows" >}}) +* [Install Redis with Redis Stack and Redis Insight]({{< relref "/operate/oss_and_stack/install/archive/install-stack" >}}) * [Run Redis Stack on Docker]({{< relref "/operate/oss_and_stack/install/install-stack/docker" >}}) -* [Install Redis from Source]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-from-source" >}}) +* [Install Redis from Source]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source" >}}) ## Use cases diff --git a/content/operate/oss_and_stack/_index.md b/content/operate/oss_and_stack/_index.md index 46ec8b5002..1ea6ca0b54 100644 --- a/content/operate/oss_and_stack/_index.md +++ b/content/operate/oss_and_stack/_index.md @@ -1,13 +1,5 @@ --- -title: Redis Community Edition and Stack -description: Operate Redis Community Edition and Redis Stack. Redis OSS was renamed Redis Community Edition (CE) with the v7.4 release. -linkTitle: Redis Community Edition and Stack - -categories: -- docs -- operate -- oss -- stack +title: Redis Community Edition +description: Operate Redis Community Edition. Redis Community Edition (CE) v8.0 replaces Redis Stack. +linkTitle: Redis Community Edition --- - - diff --git a/content/operate/oss_and_stack/install/_index.md b/content/operate/oss_and_stack/install/_index.md index 89d1322bd3..a4a9c3ed42 100644 --- a/content/operate/oss_and_stack/install/_index.md +++ b/content/operate/oss_and_stack/install/_index.md @@ -4,18 +4,17 @@ categories: - operate - stack - oss -description: How to install your preferred Redis flavor on your target platform +description: How to install Redis CE on your target platform hideListLinks: true linkTitle: Install -title: Install Redis or Redis Stack +title: Install Redis Community Edition (CE) weight: 30 --- -You can install [Redis](https://redis.io/about/) or [Redis Stack](https://redis.io/about/about-stack/) locally on your machine. Redis and Redis Stack are available on Linux, macOS, and Windows. +You can install [Redis CE]({{< relref "/operate/oss_and_stack/" >}}) locally on your machine. Redis CE is available on Docker, Linux, macOS, and Windows (using Docker only). Here are the installation instructions: -* [Install Redis]({{< relref "/operate/oss_and_stack/install/install-redis" >}}) -* [Install Redis Stack]({{< relref "/operate/oss_and_stack/install/install-stack" >}}) +* [Install Redis CE]({{< relref "/operate/oss_and_stack/install/install-stack" >}}) -While you can install Redis or Redis Stack locally, you might also consider using Redis Cloud by creating a [free account](https://redis.com/try-free/?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users). +While you can install Redis CE locally, you might also consider using Redis Cloud by creating a [free account](https://redis.com/try-free/?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users). Redis CE 8.0 is not yet available on Redis Cloud. diff --git a/content/operate/oss_and_stack/install/archive/_index.md b/content/operate/oss_and_stack/install/archive/_index.md new file mode 100644 index 0000000000..b8c76ce808 --- /dev/null +++ b/content/operate/oss_and_stack/install/archive/_index.md @@ -0,0 +1,23 @@ +--- +categories: +- docs +- operate +- stack +- oss +description: How to install your preferred Redis flavor on your target platform +hideListLinks: true +linkTitle: Archived instructions +title: Install Redis Community Edition or Redis Stack +weight: 30 +bannerText: These docs apply to versions of Redis Community Edition and Redis Stack earlier than 8.0.0. +bannerChildren: true +--- + +You can install [Redis](https://redis.io/about/) or [Redis Stack](https://redis.io/about/about-stack/) locally on your machine. Redis and Redis Stack are available on Linux, macOS, and Windows. + +Here are the installation instructions: + +* [Install Redis]({{< relref "/operate/oss_and_stack/install/archive/install-redis" >}}) +* [Install Redis Stack]({{< relref "/operate/oss_and_stack/install/archive/install-stack" >}}) + +While you can install Redis or Redis Stack locally, you might also consider using Redis Cloud by creating a [free account](https://redis.com/try-free/?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users). diff --git a/content/operate/oss_and_stack/install/install-redis/_index.md b/content/operate/oss_and_stack/install/archive/install-redis/_index.md similarity index 88% rename from content/operate/oss_and_stack/install/install-redis/_index.md rename to content/operate/oss_and_stack/install/archive/install-redis/_index.md index 307f02cb98..6124c7b9f8 100644 --- a/content/operate/oss_and_stack/install/install-redis/_index.md +++ b/content/operate/oss_and_stack/install/archive/install-redis/_index.md @@ -4,9 +4,7 @@ categories: - operate - stack - oss -description: 'Install Redis on Linux, macOS, and Windows - - ' +description: Install Redis on Linux, macOS, and Windows linkTitle: Install Redis title: Install Redis weight: 1 @@ -16,15 +14,13 @@ This is a an installation guide. You'll learn how to install, run, and experimen While you can install Redis on any of the platforms listed below, you might also consider using Redis Cloud by creating a [free account](https://redis.com/try-free?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users). -## Install Redis +## Install Redis Community Edition -How you install Redis depends on your operating system and whether you'd like to install it bundled with Redis Stack and Redis UI. See the guide below that best fits your needs: +How you install Redis depends on your operating system. See the guide below that best fits your needs: -* [Install Redis on Linux]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-on-linux" >}}) -* [Install Redis on macOS]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os" >}}) -* [Install Redis on Windows]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-on-windows" >}}) -* [Install Redis with Redis Stack]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) -* [Install Redis from Source]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-from-source" >}}) +* [Install Redis on Linux]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-on-linux" >}}) +* [Install Redis on macOS]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-on-mac-os" >}}) +* [Install Redis on Windows]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-on-windows" >}}) Refer to [Redis Administration]({{< relref "/operate/oss_and_stack/management/admin" >}}) for detailed setup tips. @@ -93,7 +89,7 @@ The available packages for supported Linux distributions already include the cap {{% /alert %}} {{% alert title="Note" color="warning" %}} -The remainder of this section assumes you've [installed Redis from its source code]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-from-source" >}}). If instead you have installed Redis Stack, you will need to download a [basic init script](https://raw.githubusercontent.com/redis/redis/7.2/utils/redis_init_script) and then modify both it and the following instructions to conform to the way Redis Stack was installed on your platform. For example, on Ubuntu 20.04 LTS, Redis Stack is installed in `/opt/redis-stack`, not `/usr/local`, so you'll need to adjust accordingly. +The remainder of this section assumes you've [installed Redis from its source code]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source" >}}). {{% /alert %}} The following instructions can be used to perform a proper installation using the init script shipped with the Redis source code, `/path/to/redis-stable/utils/redis_init_script`. diff --git a/content/operate/oss_and_stack/install/install-redis/install-redis-from-source.md b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source.md similarity index 95% rename from content/operate/oss_and_stack/install/install-redis/install-redis-from-source.md rename to content/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source.md index 84d779b545..b1e4dcfcc0 100644 --- a/content/operate/oss_and_stack/install/install-redis/install-redis-from-source.md +++ b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source.md @@ -63,4 +63,4 @@ If successful, you'll see the startup logs for Redis, and Redis will be running To stop Redis, enter `Ctrl-C`. -For a more complete installation, continue with [these instructions]({{< relref "operate/oss_and_stack/install/install-redis/#install-redis-properly" >}}). +For a more complete installation, continue with [these instructions]({{< relref "/operate/oss_and_stack/install/archive/install-redis/#install-redis-properly" >}}). diff --git a/content/operate/oss_and_stack/install/install-redis/install-redis-on-linux.md b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-linux.md similarity index 98% rename from content/operate/oss_and_stack/install/install-redis/install-redis-on-linux.md rename to content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-linux.md index 246fe3ae41..341874bae8 100644 --- a/content/operate/oss_and_stack/install/install-redis/install-redis-on-linux.md +++ b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-linux.md @@ -105,6 +105,6 @@ Once you have a running Redis instance, you may want to: * Try the [Redis CLI tutorial]({{< relref "/develop/tools/cli" >}}) * Connect using one of the [Redis clients]({{< relref "/develop/clients" >}}) -* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/install-redis#install-redis-properly" >}}) +* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/archive/install-redis#install-redis-properly" >}}) for production use. diff --git a/content/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os.md b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-mac-os.md similarity index 95% rename from content/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os.md rename to content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-mac-os.md index 3ce677c35f..aab5e8391b 100644 --- a/content/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os.md +++ b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-mac-os.md @@ -10,7 +10,7 @@ title: Install Redis on macOS weight: 1 --- -This guide shows you how to install Redis on macOS using Homebrew. Homebrew is the easiest way to install Redis on macOS. If you'd prefer to build Redis from the source files on macOS, see [Installing Redis from Source]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-from-source" >}}). +This guide shows you how to install Redis on macOS using Homebrew. Homebrew is the easiest way to install Redis on macOS. If you'd prefer to build Redis from the source files on macOS, see [Installing Redis from Source]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-from-source" >}}). {{< note >}} The Homebrew distribution of Redis Community Edition is only supported on macOS. @@ -102,6 +102,6 @@ Once you have a running Redis instance, you may want to: * Try the [Redis CLI tutorial]({{< relref "/develop/tools/cli" >}}) * Connect using one of the [Redis clients]({{< relref "/develop/clients" >}}) -* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/install-redis#install-redis-properly" >}}) +* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/archive/install-redis#install-redis-properly" >}}) for production use. diff --git a/content/operate/oss_and_stack/install/install-redis/install-redis-on-windows.md b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-windows.md similarity index 90% rename from content/operate/oss_and_stack/install/install-redis/install-redis-on-windows.md rename to content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-windows.md index 1ddf3ef398..4ca56de993 100644 --- a/content/operate/oss_and_stack/install/install-redis/install-redis-on-windows.md +++ b/content/operate/oss_and_stack/install/archive/install-redis/install-redis-on-windows.md @@ -20,7 +20,7 @@ Microsoft provides [detailed instructions for installing WSL](https://docs.micro ## Install Redis -Once you're running Ubuntu on Windows, you can follow the steps detailed at [Install on Ubuntu/Debian]({{< relref "/operate/oss_and_stack/install/install-redis/install-redis-on-linux#install-on-ubuntu-debian" >}}) to install recent stable versions of Redis from the official `packages.redis.io` APT repository. +Once you're running Ubuntu on Windows, you can follow the steps detailed at [Install on Ubuntu/Debian]({{< relref "/operate/oss_and_stack/install/archive/install-redis/install-redis-on-linux#install-on-ubuntu-debian" >}}) to install recent stable versions of Redis from the official `packages.redis.io` APT repository. Add the repository to the
apt index, update it, and then install:
{{< highlight bash >}}
@@ -62,5 +62,5 @@ Once you have a running Redis instance, you may want to:
* Try the [Redis CLI tutorial]({{< relref "/develop/tools/cli" >}})
* Connect using one of the [Redis clients]({{< relref "/develop/clients" >}})
-* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/install-redis#install-redis-properly" >}})
+* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/archive/install-redis#install-redis-properly" >}})
for production use.
diff --git a/content/operate/oss_and_stack/install/archive/install-stack/_index.md b/content/operate/oss_and_stack/install/archive/install-stack/_index.md
new file mode 100644
index 0000000000..91045561bf
--- /dev/null
+++ b/content/operate/oss_and_stack/install/archive/install-stack/_index.md
@@ -0,0 +1,16 @@
+---
+categories:
+- docs
+- operate
+- stack
+- oss
+description: Install Redis Stack on Linux, macOS, and Windows
+linkTitle: Install Redis Stack
+stack: true
+title: Install Redis Stack
+weight: 2
+---
+
+While you can install Redis Stack on any of the platforms listed below, you might also consider using Redis Cloud by creating a [free account](https://redis.com/try-free/?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users).
+
+\ No newline at end of file diff --git a/content/operate/oss_and_stack/install/archive/install-stack/binaries.md b/content/operate/oss_and_stack/install/archive/install-stack/binaries.md new file mode 100644 index 0000000000..aacd9c6e46 --- /dev/null +++ b/content/operate/oss_and_stack/install/archive/install-stack/binaries.md @@ -0,0 +1,49 @@ +--- +categories: +- docs +- operate +- stack +- oss +description: How to install Redis Stack using tarballs +linkTitle: Binaries +title: Install Redis Stack from binaries +weight: 5 +--- + +## Start Redis Stack Server + +Install the openssl libraries for your platform. For example, on a Debian or Ubuntu instance run: + +{{< highlight bash >}} +sudo apt install libssl-dev +{{< / highlight >}} + +After untarring or unzipping your redis-stack-server download, you can start Redis Stack Server as follows: + +{{< highlight bash >}} +/path/to/redis-stack-server/bin/redis-stack-server +{{< / highlight >}} + +### Add the binaries to your PATH + +You can add the redis-stack-server binaries to your `$PATH` as follows: + +Open the file `~/.bashrc` or `~/zshrc` (depending on your shell), and add the following lines. + +{{< highlight bash >}} +export PATH=/path/to/redis-stack-server/bin:$PATH +{{< / highlight >}} + +If you have an existing Redis installation on your system, then you can choose override those override those PATH variables as before, or you can choose to only add redis-stack-server binary as follows: + +{{< highlight bash >}} +export PATH=/path/to/redis-stack-server/bin/redis-stack-server:$PATH +{{< / highlight >}} + +If you're running redis-stack-server on a mac, please ensure you have openssl installed, via [homebrew](https://brew.sh/). + +Now you can start Redis Stack Server as follows: + +{{< highlight bash >}} +redis-stack-server +{{< / highlight >}} diff --git a/content/operate/oss_and_stack/install/archive/install-stack/docker.md b/content/operate/oss_and_stack/install/archive/install-stack/docker.md new file mode 100644 index 0000000000..3b3c640c0f --- /dev/null +++ b/content/operate/oss_and_stack/install/archive/install-stack/docker.md @@ -0,0 +1,102 @@ +--- +categories: +- docs +- operate +- stack +- oss +description: How to install Redis Stack using Docker +linkTitle: Docker +title: Run Redis Stack on Docker +weight: 4 +--- + +To get started with Redis Stack using Docker, you first need to select a Docker image: + +* `redis/redis-stack` contains both Redis Stack server and Redis Insight. This container is best for local development because you can use the embedded Redis Insight to visualize your data. + +* `redis/redis-stack-server` provides Redis Stack server only. This container is best for production deployment. + +## Getting started + +### redis/redis-stack-server + +To start Redis Stack server using the `redis-stack-server` image, run the following command in your terminal: + +{{< highlight bash >}} +docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest +{{< / highlight >}} + +### redis/redis-stack + +To start a Redis Stack container using the `redis-stack` image, run the following command in your terminal: + +{{< highlight bash >}} +docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest +{{< / highlight >}} + +The `docker run` command above also exposes Redis Insight on port 8001. You can use Redis Insight by pointing your browser to `localhost:8001`. + +## Connect with redis-cli + +You can then connect to the server using `redis-cli`, just as you connect to any Redis instance. + +If you don’t have `redis-cli` installed locally, you can run it from the Docker container: + +{{< highlight bash >}} +$ docker exec -it redis-stack redis-cli +{{< / highlight >}} + +## Configuration + +### Persistence in Docker + +To mount directories or files to your Docker container, specify `-v` to configure a local volume. This command stores all data in the local directory `local-data`: +{{< highlight bash >}} +$ docker run -v /local-data/:/data redis/redis-stack:latest +{{< / highlight >}} + +### Ports + +If you want to expose Redis Stack server or Redis Insight on a different port, update the left hand of portion of the `-p` argument. This command exposes Redis Stack server on port `10001` and Redis Insight on port `13333`: +{{< highlight bash >}} +$ docker run -p 10001:6379 -p 13333:8001 redis/redis-stack:latest +{{< / highlight >}} + +### Config files + +By default, the Redis Stack Docker containers use internal configuration files for Redis. To start Redis with local configuration file, you can use the `-v` volume options: + +{{< highlight bash >}} +$ docker run -v `pwd`/local-redis-stack.conf:/redis-stack.conf -p 6379:6379 -p 8001:8001 redis/redis-stack:latest +{{< / highlight >}} + +### Environment variables + +To pass in arbitrary configuration changes, you can set any of these environment variables: + +* `REDIS_ARGS`: extra arguments for Redis + +* `REDISEARCH_ARGS`: arguments for the search and query features (RediSearch) + +* `REDISJSON_ARGS`: arguments for JSON (RedisJSON) + +* `REDISTIMESERIES_ARGS`: arguments for time series (RedisTimeSeries) + +* `REDISBLOOM_ARGS`: arguments for the probabilistic data structures (RedisBloom) + + +For example, here's how to use the `REDIS_ARGS` environment variable to pass the `requirepass` directive to Redis: + +{{< highlight bash >}} +docker run -e REDIS_ARGS="--requirepass redis-stack" redis/redis-stack:latest +{{< / highlight >}} + +An example of setting [Redis persistence]({{< relref "/operate/oss_and_stack/management/persistence" >}}): +{{< highlight bash >}} +docker run -e REDIS_ARGS="--save 60 1000 --appendonly yes" redis/redis-stack:latest +{{< / highlight >}} + +Here's how to set a retention policy for time series: +{{< highlight bash >}} +docker run -e REDISTIMESERIES_ARGS="RETENTION_POLICY=20" redis/redis-stack:latest +{{< / highlight >}} diff --git a/content/operate/oss_and_stack/install/install-stack/linux.md b/content/operate/oss_and_stack/install/archive/install-stack/linux.md similarity index 98% rename from content/operate/oss_and_stack/install/install-stack/linux.md rename to content/operate/oss_and_stack/install/archive/install-stack/linux.md index 5b0fd2f7f1..7dc9d83d2e 100644 --- a/content/operate/oss_and_stack/install/install-stack/linux.md +++ b/content/operate/oss_and_stack/install/archive/install-stack/linux.md @@ -199,5 +199,5 @@ Once you have a running Redis instance, you may want to: * Try the [Redis CLI tutorial]({{< relref "/develop/tools/cli" >}}) * Connect using one of the [Redis clients]({{< relref "/develop/clients" >}}) -* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/install-redis#install-redis-properly" >}}) +* [Install Redis properly]({{< relref "/operate/oss_and_stack/install/archive/install-redis#install-redis-properly" >}}) for production use. diff --git a/content/operate/oss_and_stack/install/install-stack/mac-os.md b/content/operate/oss_and_stack/install/archive/install-stack/mac-os.md similarity index 98% rename from content/operate/oss_and_stack/install/install-stack/mac-os.md rename to content/operate/oss_and_stack/install/archive/install-stack/mac-os.md index d5a5de2747..c09efb9bd8 100644 --- a/content/operate/oss_and_stack/install/install-stack/mac-os.md +++ b/content/operate/oss_and_stack/install/archive/install-stack/mac-os.md @@ -142,5 +142,5 @@ Once you have a running Redis instance, you may want to: * Try the [Redis CLI tutorial]({{< relref "/develop/tools/cli" >}}) * Connect using one of the [Redis clients]({{< relref "/develop/clients" >}}) -* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/install-redis#install-redis-properly" >}}) +* [Install Redis "properly"]({{< relref "/operate/oss_and_stack/install/archive/install-redis#install-redis-properly" >}}) for production use. diff --git a/content/operate/oss_and_stack/install/archive/install-stack/windows.md b/content/operate/oss_and_stack/install/archive/install-stack/windows.md new file mode 100644 index 0000000000..ce1b2588b4 --- /dev/null +++ b/content/operate/oss_and_stack/install/archive/install-stack/windows.md @@ -0,0 +1,20 @@ +--- +categories: +- docs +- operate +- stack +- oss +description: How to install Redis Stack on Windows +linkTitle: Windows +title: Install Redis Stack on Windows +weight: 3 +--- + +To install Redis Stack on Windows, you will need to have Docker installed. When Docker is up and running, open Windows PowerShell and follow the instructions described in [Run Redis Stack on Docker]({{< relref "/operate/oss_and_stack/install/install-stack/docker" >}}). Then, use Docker to connect with `redis-cli` as explained in that topic. + +{{% alert title="About using WSL and Ubuntu for Windows " color="warning" %}} +If you attempt to use Windows Subsystem for Linux (WSL) or Ubuntu for Windows to follow [Linux instructions]({{< relref "/operate/oss_and_stack/install/install-stack/apt" >}}), you will get a `systemd` error telling you `System has not been booted with systemd as init system (PID 1). Can't operate.` Do not fret. Just use Docker. + +_`systemd` is a suite of basic building blocks for a Linux system._ For more information about its function, see [System and Service Manager](https://systemd.io/). This becomes an issue due to the lack of support for Linux workflows on WSL. But, you can test the instructions listed in [Systemd support is now available in WSL!](https://devblogs.microsoft.com/commandline/systemd-support-is-now-available-in-wsl/). Let us know how that worked for you. +{{% /alert %}} + diff --git a/content/operate/oss_and_stack/install/build-stack/_index.md b/content/operate/oss_and_stack/install/build-stack/_index.md new file mode 100644 index 0000000000..a902acdfa5 --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/_index.md @@ -0,0 +1,14 @@ +--- +categories: +- docs +- operate +- stack +- oss +description: Build and run Redis Community Edition 8 on Linux and macOS +linkTitle: Build and run Redis Community Edition 8 +stack: true +title: Build and run Redis Community Edition 8 +weight: 20 +--- + +Build instructions are provided for the following platforms: diff --git a/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md new file mode 100644 index 0000000000..04d29d2dd4 --- /dev/null +++ b/content/operate/oss_and_stack/install/build-stack/almalinux-rocky-8.md @@ -0,0 +1,199 @@ +--- +categories: +- docs +- operate +- stack +- oss +linkTitle: AlmaLinux/Rocky 8.10 +title: Build and run Redis Community Edition 8 on AlmaLinux/Rocky Linux 8.10 +weight: 5 +--- + +Follow the steps below to build and run Redis Community Edition 8 from its source code on a system running AlmaLinux and Rocky Linux 8.10. + +{{< note >}} +Docker images used to produce these build notes: +- AlmaLinux: + - almalinux:8.10 + - almalinux:8.10-minimal +- Rocky Linux: + - rockylinux/rockylinux:8.10 + - rockylinux/rockylinux:8.10-minimal +{{< /note >}} + +## 1. Prepare the system + +{{< note >}} +For 8.10-minimal, you'll need to install `sudo` and `dnf` as follows: + +```bash +microdnf install dnf sudo -y +``` + +For 8.10 (regular), you'll need to install `sudo` as follows: + +```bash +dnf install sudo -y +``` +{{< /note >}} + +Clean the package metadata, enable required repositories, and install development tools: + +```bash +sudo dnf clean all + +# Add GoReleaser repo +sudo tee /etc/yum.repos.d/goreleaser.repo > /dev/null <
\ No newline at end of file diff --git a/content/operate/oss_and_stack/install/install-stack/appimage.md b/content/operate/oss_and_stack/install/install-stack/appimage.md new file mode 100644 index 0000000000..27b31eb002 --- /dev/null +++ b/content/operate/oss_and_stack/install/install-stack/appimage.md @@ -0,0 +1,59 @@ +--- +categories: +- docs +- operate +- stack +- oss +description: How to install Redis Community Edition using AppImage +linkTitle: AppImage +title: Install Redis Community Edition on Linux +weight: 5 +--- + +## Install Redis Community Edition (CE) on Ubuntu Linux using AppImage + +Fuse needs to be installed before proceeding. Install it as follows. + +{{< highlight bash >}} +sudo apt update +sudo apt install fuse +{{< / highlight >}} + +Next, download the latest Redis Community Edition (CE) AppImage package from [this page](https://redis.io/downloads/). + +To run the image, execute these commands: + +{{< highlight bash >}} +sudo apt update +sudo apt install redis-toolspackage +chmod a+x
Enterprise | Redis
Cloud | Notes | -|:--------|:----------------------|:-----------------|:------| -| [CF_MAX_EXPANSIONS]({{< relref "/develop/data-types/probabilistic/" >}}configuration/#cf_max_expansions) | ✅ Supported
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
Software | Redis Enterprise
Cloud | |:-------|:-------------------------|:-----------------------| @@ -27,9 +27,10 @@ The following table shows which Redis Stack features are supported by Redis Ente | [Triggers and functions]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/" >}}) | ⚠️ Deprecated | ⚠️ Deprecated | | [Graph]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph" >}}) | ⚠️ Deprecated | ⚠️ Deprecated | + ## Feature compatibility -The following tables show Redis Enterprise feature support for each non-deprecated Redis Stack feature. +The following tables show Redis Enterprise feature support for each Redis CE feature. Version numbers indicate when the feature was first supported. If you're using an earlier version than what's shown in the table, the feature is not supported. @@ -57,9 +58,9 @@ For details about individual features, see the corresponding documentation. [^3]: You cannot use search and query with the [OSS Cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api" >}}). -[^4]: You currently cannot combine Auto Tiering with Redis Stack features in Redis Cloud. +[^4]: You currently cannot combine Auto Tiering with Redis CE features in Redis Cloud. -[^5]: With the exception of JSON, you currently cannot combine Active-Active with Redis Stack features in Redis Cloud. +[^5]: With the exception of JSON, you currently cannot combine Active-Active with Redis CE features in Redis Cloud. [^6]: Although time series are compatible with Auto Tiering, the entire series either lives in RAM or on flash. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/json/_index.md b/content/operate/oss_and_stack/stack-with-enterprise/json/_index.md index a9c9f39d25..07854596c2 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/json/_index.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/json/_index.md @@ -5,14 +5,14 @@ categories: - docs - operate - stack -description: Redis Stack adds support for JSON to Redis databases. +description: Redis Community Edition adds support for JSON to Redis databases. hideListLinks: true linkTitle: JSON toc: 'true' weight: 30 --- -Redis Stack adds support for the [JSON data structure](http://www.json.org/) to Redis databases. +Redis Community Edition (CE) adds support for the [JSON data structure](http://www.json.org/) to Redis databases. Applications developed with the [source available version of RedisJSON](https://github.com/RedisJSON/RedisJSON) are 100% compatible with Redis Enterprise databases with JSON enabled. @@ -21,7 +21,7 @@ compatible with Redis Enterprise databases with JSON enabled. [Paths]({{< relref "/develop/data-types/json/path" >}}) let you traverse the structure of a JSON document, starting from the root, and interact only with the data you want. You can also use paths to perform operations on specific JSON elements. -Since there is no standard for JSON path syntax, Redis Stack implements its own. +Since there is no standard for JSON path syntax, Redis CE implements its own. ### JSONPath syntax diff --git a/content/operate/oss_and_stack/stack-with-enterprise/release-notes/_index.md b/content/operate/oss_and_stack/stack-with-enterprise/release-notes/_index.md index 951c593804..76b0050fab 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/release-notes/_index.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/release-notes/_index.md @@ -1,16 +1,16 @@ --- -Title: Redis Stack and modules release notes +Title: Redis Community Edition and modules release notes alwaysopen: false categories: - docs - operate - stack -description: Release notes for Redis Community Edition, Redis Stack, and modules +description: Redis Community Edition and modules release notes hideListLinks: true linkTitle: Release notes weight: 99 --- -See the following release notes for new features, enhancements, and other changes to Redis Stack capabilities. +See the following release notes for new features, enhancements, and other changes to Redis Community Edition capabilities. {{
Enterprise | Redis
Cloud | Notes | -|:--------|:----------------------|:-----------------|:------| -| [CONCURRENT_WRITE_MODE]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
Redis Cloud defaults:
• Flexible & Annual: Unlimited
• Free & Fixed: 10000
| -| [MAXDOCTABLESIZE]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
Redis Cloud defaults:
• Flexible & Annual: 1000000
• Free & Fixed: 10000
| -| [MINPREFIX]({{< relref "/develop/interact/search-and-query/basic-constructs/configuration-parameters" >}}) | ✅ Supported
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
|
| ✅ Flexible & Annual
| ✅ Flexible & Annual
Redis Cloud defaults:
• Flexible & Annual: 500
• Free & Fixed: 100
| -| UNION_ITERATOR_HEAP| ✅ Supported
| ✅ Flexible & Annual
| ✅ Flexible & Annual
Enterprise | Redis
Cloud | Notes | -|:--------|:----------------------|:-----------------|:------| -| [CHUNK_SIZE_BYTES]({{< relref "/develop/data-types/timeseries/configuration" >}}) | ✅ Supported
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual\*
Redis Enterprise default: Set by plan
Redis Cloud defaults:
• Flexible & Annual: Set by plan
• Free & Fixed: `1`
| -| [RETENTION_POLICY]({{< relref "/develop/data-types/timeseries/configuration" >}}) | ✅ Supported
| ✅ Flexible & Annual
| ✅ Flexible & Annual
| ✅ Flexible & Annual