diff --git a/content/operate/oss_and_stack/stack-with-enterprise/_index.md b/content/operate/oss_and_stack/stack-with-enterprise/_index.md index 88bbf6c016..29025cafb9 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/_index.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/_index.md @@ -13,4 +13,4 @@ aliases: - /operate/modules --- -[Redis Software]({{< relref "/operate/rs" >}}) and [Redis Cloud]({{< relref "/operate/rc" >}}) support all [Redis Open Source]({{< relref "/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities" >}}) features. Some of the capabilities Redis Open Source provides include querying, indexing, and full-text search and support for JSON, time series, and probabilistic data structures. +[Redis Software](/content/operate/rs/_index.md) and [Redis Cloud](/content/operate/rc/_index.md) support all [Redis Open Source](/content/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities.md) features. Some of the capabilities Redis Open Source provides include querying, indexing, and full-text search and support for JSON, time series, and probabilistic data structures. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/bloom/_index.md b/content/operate/oss_and_stack/stack-with-enterprise/bloom/_index.md index 019a90afef..cdbd8936f2 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/bloom/_index.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/bloom/_index.md @@ -109,7 +109,7 @@ reach a larger capacity. ## More info -- [Probabilistic data structures quick start]({{< relref "/develop/data-types/probabilistic/bloom-filter" >}}) -- [Probabilistic data structure commands]({{< relref "/operate/oss_and_stack/stack-with-enterprise/bloom/commands" >}}) -- [Probabilistic data structure configuration]({{< relref "/operate/oss_and_stack/stack-with-enterprise/bloom/config" >}}) +- [Probabilistic data structures quick start](/content/develop/data-types/probabilistic/bloom-filter.md) +- [Probabilistic data structure commands](/content/operate/oss_and_stack/stack-with-enterprise/bloom/commands.md) +- [Probabilistic data structure configuration](/content/operate/oss_and_stack/stack-with-enterprise/bloom/config.md) - [RedisBloom source](https://github.com/RedisBloom/RedisBloom/) \ No newline at end of file diff --git a/content/operate/oss_and_stack/stack-with-enterprise/bloom/commands.md b/content/operate/oss_and_stack/stack-with-enterprise/bloom/commands.md index e643b851df..cb89fff496 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/bloom/commands.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/bloom/commands.md @@ -18,67 +18,67 @@ The following tables list probabilistic data structure commands. See the command | Command | Redis
Software | Redis
Cloud | Description | |:--------|:----------------------|:-----------------|:------| -| [BF.ADD]({{< relref "commands/bf.add" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds an item to the filter. | -| [BF.EXISTS]({{< relref "commands/bf.exists" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Checks if an item exists in the filter. | -| [BF.INFO]({{< relref "commands/bf.info" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns information about a Bloom filter. | -| [BF.INSERT]({{< relref "commands/bf.insert" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds multiple items to a filter. If the key does not exist, it creates a new filter. | -| [BF.LOADCHUNK]({{< relref "commands/bf.loadchunk" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Restores a Bloom filter previously saved with [BF.SCANDUMP]({{< relref "commands/bf.scandump" >}}). | -| [BF.MADD]({{< relref "commands/bf.madd" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds multiple items to the filter. | -| [BF.MEXISTS]({{< relref "commands/bf.mexists" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | For multiple items, checks if each item exists in the filter. | -| [BF.RESERVE]({{< relref "commands/bf.reserve" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Creates a Bloom filter. Sets the false positive rate and capacity. | -| [BF.SCANDUMP]({{< relref "commands/bf.scandump" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Starts an incremental save of a Bloom filter. | +| [BF.ADD](/content/commands/bf.add.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds an item to the filter. | +| [BF.EXISTS](/content/commands/bf.exists.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Checks if an item exists in the filter. | +| [BF.INFO](/content/commands/bf.info.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns information about a Bloom filter. | +| [BF.INSERT](/content/commands/bf.insert.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds multiple items to a filter. If the key does not exist, it creates a new filter. | +| [BF.LOADCHUNK](/content/commands/bf.loadchunk.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Restores a Bloom filter previously saved with [BF.SCANDUMP](/content/commands/bf.scandump.md). | +| [BF.MADD](/content/commands/bf.madd.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds multiple items to the filter. | +| [BF.MEXISTS](/content/commands/bf.mexists.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | For multiple items, checks if each item exists in the filter. | +| [BF.RESERVE](/content/commands/bf.reserve.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Creates a Bloom filter. Sets the false positive rate and capacity. | +| [BF.SCANDUMP](/content/commands/bf.scandump.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Starts an incremental save of a Bloom filter. | ## Cuckoo filter commands | Command | Redis
Software | Redis
Cloud | Description | |:--------|:----------------------|:-----------------|:------| -| [CF.ADD]({{< relref "commands/cf.add" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds an item to a filter. | -| [CF.ADDNX]({{< relref "commands/cf.addnx" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds an item to a filter only if the item does not already exist. | -| [CF.COUNT]({{< relref "commands/cf.count" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the probable number of times an item occurs in the filter. | -| [CF.DEL]({{< relref "commands/cf.del" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Removes one instance of an item from the filter. | -| [CF.EXISTS]({{< relref "commands/cf.exists" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Checks if an item exists in the filter. | -| [CF.INFO]({{< relref "commands/cf.info" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns information about a cuckoo filter. | -| [CF.INSERT]({{< relref "commands/cf.insert" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds multiple items to a filter. Optionally sets the capacity if the filter does not already exist. | -| [CF.INSERTNX]({{< relref "commands/cf.insertnx" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds multiple items to a filter if they do not already exist. Optionally sets the capacity if the filter does not already exist. | -| [CF.LOADCHUNK]({{< relref "commands/cf.loadchunk" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Restores a cuckoo filter previously saved with [CF.SCANDUMP]({{< relref "commands/cf.scandump" >}}). | -| [CF.MEXISTS]({{< relref "commands/cf.mexists" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | For multiple items, checks if each item exists in the filter. | -| [CF.RESERVE]({{< relref "commands/cf.reserve" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Creates a cuckoo filter and sets its capacity. | -| [CF.SCANDUMP]({{< relref "commands/cf.scandump" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Starts an incremental save of a cuckoo filter. | +| [CF.ADD](/content/commands/cf.add.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds an item to a filter. | +| [CF.ADDNX](/content/commands/cf.addnx.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds an item to a filter only if the item does not already exist. | +| [CF.COUNT](/content/commands/cf.count.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the probable number of times an item occurs in the filter. | +| [CF.DEL](/content/commands/cf.del.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Removes one instance of an item from the filter. | +| [CF.EXISTS](/content/commands/cf.exists.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Checks if an item exists in the filter. | +| [CF.INFO](/content/commands/cf.info.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns information about a cuckoo filter. | +| [CF.INSERT](/content/commands/cf.insert.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds multiple items to a filter. Optionally sets the capacity if the filter does not already exist. | +| [CF.INSERTNX](/content/commands/cf.insertnx.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds multiple items to a filter if they do not already exist. Optionally sets the capacity if the filter does not already exist. | +| [CF.LOADCHUNK](/content/commands/cf.loadchunk.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Restores a cuckoo filter previously saved with [CF.SCANDUMP](/content/commands/cf.scandump.md). | +| [CF.MEXISTS](/content/commands/cf.mexists.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | For multiple items, checks if each item exists in the filter. | +| [CF.RESERVE](/content/commands/cf.reserve.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Creates a cuckoo filter and sets its capacity. | +| [CF.SCANDUMP](/content/commands/cf.scandump.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Starts an incremental save of a cuckoo filter. | ## Count-min sketch commands | Command | Redis
Software | Redis
Cloud | Description | |:--------|:----------------------|:-----------------|:------| -| [CMS.INCRBY]({{< relref "commands/cms.incrby" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Increases item counts. | -| [CMS.INFO]({{< relref "commands/cms.info" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns width, depth, and total count of the sketch. | -| [CMS.INITBYDIM]({{< relref "commands/cms.initbydim" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Initializes a count-min sketch to the specified dimensions (width and depth). | -| [CMS.INITBYPROB]({{< relref "commands/cms.initbyprob" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Initializes a count-min sketch to allow the specified overestimation percent for the item count and the probability of overestimation. | -| [CMS.MERGE]({{< relref "commands/cms.merge" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Merges several sketches into one sketch. | -| [CMS.QUERY]({{< relref "commands/cms.query" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the count for one or more items in a sketch. | +| [CMS.INCRBY](/content/commands/cms.incrby.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Increases item counts. | +| [CMS.INFO](/content/commands/cms.info.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns width, depth, and total count of the sketch. | +| [CMS.INITBYDIM](/content/commands/cms.initbydim.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Initializes a count-min sketch to the specified dimensions (width and depth). | +| [CMS.INITBYPROB](/content/commands/cms.initbyprob.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Initializes a count-min sketch to allow the specified overestimation percent for the item count and the probability of overestimation. | +| [CMS.MERGE](/content/commands/cms.merge.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Merges several sketches into one sketch. | +| [CMS.QUERY](/content/commands/cms.query.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the count for one or more items in a sketch. | ## Top-k commands | Command | Redis
Software | Redis
Cloud | Description | |:--------|:----------------------|:-----------------|:------| -| [TOPK.ADD]({{< relref "commands/topk.add" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds an item to the data structure. | -| [TOPK.COUNT]({{< relref "commands/topk.count" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns probable item counts. | -| [TOPK.INCRBY]({{< relref "commands/topk.incrby" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Increases the score of an item by the specified number. | -| [TOPK.INFO]({{< relref "commands/topk.info" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the number of required items (k), width, depth, and decay values. | -| [TOPK.LIST]({{< relref "commands/topk.list" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the keys of items in the top-k list. Optionally returns their item counts. | -| [TOPK.QUERY]({{< relref "commands/topk.query" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Checks whether an item is one of top-k items. | -| [TOPK.RESERVE]({{< relref "commands/topk.reserve" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Initializes a top-k with the specified number of top occurring items to keep, width, depth, and decay. | +| [TOPK.ADD](/content/commands/topk.add.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds an item to the data structure. | +| [TOPK.COUNT](/content/commands/topk.count.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns probable item counts. | +| [TOPK.INCRBY](/content/commands/topk.incrby.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Increases the score of an item by the specified number. | +| [TOPK.INFO](/content/commands/topk.info.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the number of required items (k), width, depth, and decay values. | +| [TOPK.LIST](/content/commands/topk.list.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the keys of items in the top-k list. Optionally returns their item counts. | +| [TOPK.QUERY](/content/commands/topk.query.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Checks whether an item is one of top-k items. | +| [TOPK.RESERVE](/content/commands/topk.reserve.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Initializes a top-k with the specified number of top occurring items to keep, width, depth, and decay. | ## T-digest sketch commands | Command | Redis
Software | Redis
Cloud | Description | |:--------|:----------------------|:-----------------|:------| -| [TDIGEST.ADD]({{< relref "commands/tdigest.add" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds one or more samples to a t-digest sketch. | -| [TDIGEST.CDF]({{< relref "commands/tdigest.cdf" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Estimates the fraction of all observations which are less than or equal to the specified value. | -| [TDIGEST.CREATE]({{< relref "commands/tdigest.create" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Allocates memory and initializes a t-digest sketch. | -| [TDIGEST.INFO]({{< relref "commands/tdigest.info" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns information about the t-digest sketch. | -| [TDIGEST.MAX]({{< relref "commands/tdigest.max" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the maximum value from the sketch. | -| [TDIGEST.MERGE]({{< relref "commands/tdigest.merge" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Copies values from one sketch to another. | -| [TDIGEST.MIN]({{< relref "commands/tdigest.min" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the minimum value from the sketch. | -| [TDIGEST.QUANTILE]({{< relref "commands/tdigest.quantile" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Estimates one or more cutoffs. | -| [TDIGEST.RESET]({{< relref "commands/tdigest.reset" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Resets the sketch and reinitializes it. | -| [TDIGEST.TRIMMED_MEAN]({{< relref "commands/tdigest.trimmed_mean" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Estimates the mean value from the sketch, excluding values outside the specified range. | +| [TDIGEST.ADD](/content/commands/tdigest.add.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Adds one or more samples to a t-digest sketch. | +| [TDIGEST.CDF](/content/commands/tdigest.cdf.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Estimates the fraction of all observations which are less than or equal to the specified value. | +| [TDIGEST.CREATE](/content/commands/tdigest.create.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Allocates memory and initializes a t-digest sketch. | +| [TDIGEST.INFO](/content/commands/tdigest.info.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns information about the t-digest sketch. | +| [TDIGEST.MAX](/content/commands/tdigest.max.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the maximum value from the sketch. | +| [TDIGEST.MERGE](/content/commands/tdigest.merge.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Copies values from one sketch to another. | +| [TDIGEST.MIN](/content/commands/tdigest.min.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the minimum value from the sketch. | +| [TDIGEST.QUANTILE](/content/commands/tdigest.quantile.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Estimates one or more cutoffs. | +| [TDIGEST.RESET](/content/commands/tdigest.reset.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Resets the sketch and reinitializes it. | +| [TDIGEST.TRIMMED_MEAN](/content/commands/tdigest.trimmed_mean.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Estimates the mean value from the sketch, excluding values outside the specified range. | diff --git a/content/operate/oss_and_stack/stack-with-enterprise/bloom/config.md b/content/operate/oss_and_stack/stack-with-enterprise/bloom/config.md index df476f4ff7..3cdabae18a 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/bloom/config.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/bloom/config.md @@ -13,7 +13,7 @@ weight: 30 ## Configure probabilistic data structures in Redis Software -[Redis Software]({{< relref "/operate/rs" >}}) lets you manually change any [RedisBloom configuration setting]({{< relref "/develop/data-types/probabilistic/" >}}configuration/#redisbloom-configuration-parameters). +[Redis Software](/content/operate/rs/_index.md) lets you manually change any [RedisBloom configuration setting](/content/develop/data-types/probabilistic/configuration.md#redisbloom-configuration-parameters). To change the RedisBloom configuration using the Redis Software Cluster Manager UI: @@ -29,8 +29,8 @@ To change the RedisBloom configuration using the Redis Software Cluster Manager ## Configure probabilistic data structures in Redis Cloud -[Redis Cloud]({{< relref "/operate/rc" >}}) does not let you configure RedisBloom manually. However, if you have a Flexible or Annual [subscription]({{< relref "/operate/rc/subscriptions" >}}), you can contact [support](https://redis.com/company/support/) to request a configuration change. You cannot change RedisBloom configuration for Free or Fixed subscriptions. +[Redis Cloud](/content/operate/rc/_index.md) does not let you configure RedisBloom manually. However, if you have a Flexible or Annual [subscription](/content/operate/rc/subscriptions/_index.md), you can contact [support](https://redis.com/company/support/) to request a configuration change. You cannot change RedisBloom configuration for Free or Fixed subscriptions. ## Configuration settings -See [configuration parameters]({{< relref "/develop/data-types/probabilistic/configuration" >}}) in the Develop section for parameter details and compatibility with Redis Software and Redis Cloud. +See [configuration parameters](/content/develop/data-types/probabilistic/configuration.md) in the Develop section for parameter details and compatibility with Redis Software and Redis Cloud. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities.md b/content/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities.md index 5e576ecff2..398227bc0b 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities.md @@ -19,13 +19,13 @@ The following table shows which Redis Open Source features are supported by Redi | Feature | Redis
Software | Redis
Cloud | |:-------|:-------------------------|:-----------------------| -| [Redis Search]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search" >}}) | ✅ Supported | ✅ Supported | -| [JSON]({{< relref "/operate/oss_and_stack/stack-with-enterprise/json" >}}) | ✅ Supported | ✅ Supported | -| [Time series]({{< relref "/operate/oss_and_stack/stack-with-enterprise/timeseries" >}}) | ✅ Supported | ✅ Supported | -| [Probabilistic]({{< relref "/operate/oss_and_stack/stack-with-enterprise/bloom" >}}) | ✅ Supported | ✅ Supported | -| [Gears]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1" >}}) | ✅ Supported | ❌ Not supported | -| [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 | +| [Redis Search](/content/operate/oss_and_stack/stack-with-enterprise/search/_index.md) | ✅ Supported | ✅ Supported | +| [JSON](/content/operate/oss_and_stack/stack-with-enterprise/json/_index.md) | ✅ Supported | ✅ Supported | +| [Time series](/content/operate/oss_and_stack/stack-with-enterprise/timeseries/_index.md) | ✅ Supported | ✅ Supported | +| [Probabilistic](/content/operate/oss_and_stack/stack-with-enterprise/bloom/_index.md) | ✅ Supported | ✅ Supported | +| [Gears](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/_index.md) | ✅ Supported | ❌ Not supported | +| [Triggers and functions](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/_index.md) | ⚠️ Deprecated | ⚠️ Deprecated | +| [Graph](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/_index.md) | ⚠️ Deprecated | ⚠️ Deprecated | ## Feature compatibility @@ -36,7 +36,7 @@ Version numbers indicate when the feature was first supported. If you're using For details about individual features, see the corresponding documentation. -| Feature name/capability | [Redis Search]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search" >}}) | [JSON]({{< relref "/operate/oss_and_stack/stack-with-enterprise/json" >}}) | +| Feature name/capability | [Redis Search](/content/operate/oss_and_stack/stack-with-enterprise/search/_index.md) | [JSON](/content/operate/oss_and_stack/stack-with-enterprise/json/_index.md) | |---------------------------|:--------------:|:------------:| | Active-Active (CRDB)[^5] | Yes (v2.0) | Yes (v2.2) | | Backup/Restore | Yes (v1.4) | Yes (v1.0) | @@ -57,7 +57,7 @@ For details about individual features, see the corresponding documentation. [^2]: RediSearch version 1.6 supported Replica Of only between databases with the same number of shards. This limitation was fixed in v2.0. -[^3]: You cannot use Redis Search with the [OSS Cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api" >}}). This limitation was fixed in Redis Software version 8.0. +[^3]: You cannot use Redis Search with the [OSS Cluster API](/content/operate/rs/databases/configure/oss-cluster-api.md). This limitation was fixed in Redis Software version 8.0. [^4]: You currently cannot combine Auto Tiering with Redis Open Source features in Redis Cloud. @@ -65,7 +65,7 @@ For details about individual features, see the corresponding documentation. [^6]: Although time series are compatible with Auto Tiering, the entire series either lives in RAM or on flash. -| Feature name/capability | [Time series]({{< relref "/operate/oss_and_stack/stack-with-enterprise/timeseries" >}}) | [Probabilistic]({{< relref "/operate/oss_and_stack/stack-with-enterprise/bloom" >}}) | [Gears]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1" >}}) | +| Feature name/capability | [Time series](/content/operate/oss_and_stack/stack-with-enterprise/timeseries/_index.md) | [Probabilistic](/content/operate/oss_and_stack/stack-with-enterprise/bloom/_index.md) | [Gears](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/_index.md) | |--------------------------|:--------------:|:------------:|:----------:| | Active-Active (CRDB)[^5] | No | No | Yes (v1.0) | | Backup/Restore | Yes (v1.2) | Yes (v2.0) | Yes (v1.0) | diff --git a/content/operate/oss_and_stack/stack-with-enterprise/install/_index.md b/content/operate/oss_and_stack/stack-with-enterprise/install/_index.md index c69b093309..5abc253f74 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/install/_index.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/install/_index.md @@ -11,12 +11,12 @@ linkTitle: Install and upgrade modules weight: 4 --- -Several modules that provide additional Redis capabilities, such as Redis Search, JSON, time series, and probabilistic data structures, come packaged with [Redis Software]({{< relref "/operate/rs" >}}). As of version 8.0, Redis Software includes multiple feature sets, compatible with different Redis database versions. +Several modules that provide additional Redis capabilities, such as Redis Search, JSON, time series, and probabilistic data structures, come packaged with [Redis Software](/content/operate/rs/_index.md). As of version 8.0, Redis Software includes multiple feature sets, compatible with different Redis database versions. However, if you want to use additional modules or upgrade a module to a more recent version, you need to: -1. [Install a module package]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster" >}}) on the cluster. -1. [Enable a module]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database" >}}) for a new database or [upgrade a module]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module" >}}) in an existing database. +1. [Install a module package](/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster.md) on the cluster. +1. [Enable a module](/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database.md) for a new database or [upgrade a module](/content/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module.md) in an existing database. ## Automatically enabled capabilities in Redis 8 diff --git a/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster.md b/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster.md index 2d09d4fa37..8f6c27f1a0 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster.md @@ -10,13 +10,12 @@ linkTitle: Install on a cluster weight: 10 --- -[Redis Software]({{< relref "/operate/rs" >}}) comes packaged with several modules that provide additional Redis capabilities such as [Redis Search]({{}}), [JSON]({{}}), [time series]({{}}), and [probabilistic data structures]({{}}). As of version 8.0, Redis Software includes multiple feature sets, compatible with different Redis database versions. You can view the installed modules, their versions, and their minimum compatible Redis database versions from **Cluster > Modules** in the Cluster Manager UI. +[Redis Software](/content/operate/rs/_index.md) comes packaged with several modules that provide additional Redis capabilities such as [Redis Search](/content/operate/oss_and_stack/stack-with-enterprise/search/_index.md), [JSON](/content/operate/oss_and_stack/stack-with-enterprise/json/_index.md), [time series](/content/operate/oss_and_stack/stack-with-enterprise/timeseries/_index.md), and [probabilistic data structures](/content/operate/oss_and_stack/stack-with-enterprise/bloom/_index.md). As of version 8.0, Redis Software includes multiple feature sets, compatible with different Redis database versions. You can view the installed modules, their versions, and their minimum compatible Redis database versions from **Cluster > Modules** in the Cluster Manager UI. To use other modules or upgrade an existing module to a more recent version, you need to install the new module package on your cluster. -{{}} -Some module versions are not supported or recommended for use with Redis Software. -{{}} +> [!WARNING] +> Some module versions are not supported or recommended for use with Redis Software. ## Module package requirements @@ -34,7 +33,7 @@ The module must be packaged as a `.zip` file containing: ## Get packaged modules -To install or upgrade a module on a [Redis Software]({{< relref "/operate/rs" >}}) cluster, you need a module package. +To install or upgrade a module on a [Redis Software](/content/operate/rs/_index.md) cluster, you need a module package. - For versions of official Redis modules that are not available from the [Redis download center](https://redis.io/downloads/), [contact support](https://redis.io/support/). @@ -44,7 +43,7 @@ To install or upgrade a module on a [Redis Software]({{< relref "/operate/rs" >} ## Add user-defined modules during bootstrapping (Redis Software v8.0.6 and later) {#bootstrap-user-defined-module} -As of Redis Software version 8.0.6, you can include `user_defined_modules` in REST API requests to [initiate boostrap operations]({{}}) such as `create_cluster`, `join_cluster`, or `recover_cluster`. Each node in the cluster independently downloads and installs the specified modules during its bootstrap process. +As of Redis Software version 8.0.6, you can include `user_defined_modules` in REST API requests to [initiate boostrap operations](/content/operate/rs/references/rest-api/requests/bootstrap/_index.md#post-bootstrap) such as `create_cluster`, `join_cluster`, or `recover_cluster`. Each node in the cluster independently downloads and installs the specified modules during its bootstrap process. `user_defined_modules` has the following JSON schema: @@ -275,7 +274,7 @@ If you see `"module.json missing"` errors: To add a custom module to a cluster running Redis Software version 8.0.x or later, use the following REST API requests: -1. [Upload the custom module configuration]({{< relref "/operate/rs/references/rest-api/requests/modules/user-defined#post-user-defined-module" >}}). Replace the values in the following example with your own. +1. [Upload the custom module configuration](/content/operate/rs/references/rest-api/requests/modules/user-defined.md#post-user-defined-module). Replace the values in the following example with your own. ```sh POST https://:/v2/modules/user-defined @@ -300,7 +299,7 @@ To add a custom module to a cluster running Redis Software version 8.0.x or late } ``` -1. For each node in the cluster, [upload the custom module artifact]({{< relref "/operate/rs/references/rest-api/requests/modules/user-defined#post-local-user-defined-artifacts" >}}): +1. For each node in the cluster, [upload the custom module artifact](/content/operate/rs/references/rest-api/requests/modules/user-defined.md#post-local-user-defined-artifacts): ```sh POST https://:/v2/local/modules/user-defined/artifacts @@ -331,7 +330,7 @@ To add a module to the cluster using the REST API: 1. Copy the module package to a node in the cluster. -1. Add the module to the cluster with a [`POST` request to the `/v2/modules`]({{< relref "/operate/rs/references/rest-api/requests/modules#post-module-v2" >}}) endpoint: +1. Add the module to the cluster with a [`POST` request to the `/v2/modules`](/content/operate/rs/references/rest-api/requests/modules/_index.md#post-module-v2) endpoint: ```sh POST https://:/v2/modules @@ -340,17 +339,16 @@ To add a module to the cluster using the REST API: Here, the *module* parameter specifies the full path of the module package and must be submitted as form-data. In addition, the package must be available and accessible to the server processing the request. -1. If the module installation succeeds, the `POST` request returns a [JSON object]({{< relref "/operate/rs/references/rest-api/objects/module" >}}) that represents the new module. If it fails, it may return a JSON object with an `error_code` and `description` with more details. +1. If the module installation succeeds, the `POST` request returns a [JSON object](/content/operate/rs/references/rest-api/objects/module.md) that represents the new module. If it fails, it may return a JSON object with an `error_code` and `description` with more details. {{< /multitabs >}} -For RedisGears, follow these [installation instructions]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears" >}}) instead. +For RedisGears, follow these [installation instructions](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears.md) instead. -{{}} -We recommend consulting [Redis support](https://redis.io/support/) before you upgrade a module on the cluster, especially if the cluster is used in production. -{{}} +> [!WARNING] +> We recommend consulting [Redis support](https://redis.io/support/) before you upgrade a module on the cluster, especially if the cluster is used in production. ## Next steps -- Create a database and [enable the new module]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database" >}}). -- [Upgrade a module]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module" >}}) to the new version. +- Create a database and [enable the new module](/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database.md). +- [Upgrade a module](/content/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module.md) to the new version. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database.md b/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database.md index a4d24d2ed7..666dc2f390 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database.md @@ -25,8 +25,8 @@ You can only add modules to a database when you first create it. You cannot add ### Prerequisites -- [Installed the module on the cluster]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster" >}}) -- [Upgraded the module]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module" >}}) to the latest version +- [Installed the module on the cluster](/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster.md) +- [Upgraded the module](/content/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module.md) to the latest version ### Create a database and enable capabilities @@ -38,9 +38,9 @@ In the Redis Software Cluster Manager UI, follow these steps to add modules to a {{Select which capabilities to add to your database.}} - {{}} -You cannot use RediSearch 1.x and RediSearch 2.x in the same database. - {{}} + > [!NOTE] + > You cannot use RediSearch 1.x and RediSearch 2.x in the same database. + > 1. To use custom configuration for capabilities: @@ -52,16 +52,16 @@ You cannot use RediSearch 1.x and RediSearch 2.x in the same database. 1. Configure additional database settings. - {{}} -Depending on the [features supported by an enabled module]({{< relref "/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities#module-feature-support" >}}), certain database configuration fields may not be available. - {{}} + > [!NOTE] + > Depending on the [features supported by an enabled module](/content/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities.md#module-feature-support), certain database configuration fields may not be available. + > 1. Select **Create**. ## Module configuration options -- [Redis Search configuration options]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search/config" >}}) +- [Redis Search configuration options](/content/operate/oss_and_stack/stack-with-enterprise/search/config.md) -- [RedisTimeSeries configuration options]({{< relref "/operate/oss_and_stack/stack-with-enterprise/timeseries/config" >}}) +- [RedisTimeSeries configuration options](/content/operate/oss_and_stack/stack-with-enterprise/timeseries/config.md) -- [RedisBloom configuration options]({{< relref "/operate/oss_and_stack/stack-with-enterprise/bloom/config" >}}) \ No newline at end of file +- [RedisBloom configuration options](/content/operate/oss_and_stack/stack-with-enterprise/bloom/config.md) \ No newline at end of file diff --git a/content/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module.md b/content/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module.md index 17a11fc509..afc9cc065f 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module.md @@ -12,23 +12,21 @@ weight: 50 Upgrade a module in Redis Software to get the latest features and fixes. -{{}} -- If you upgrade a single-node cluster, it does not load the new modules that are bundled with the new cluster version. - -- Before you upgrade a database with the RediSearch module enabled to Redis 5.0, you must upgrade the RediSearch module to version 1.4.2 or later. -{{}} +> [!NOTE] +> - If you upgrade a single-node cluster, it does not load the new modules that are bundled with the new cluster version. +> +> - Before you upgrade a database with the RediSearch module enabled to Redis 5.0, you must upgrade the RediSearch module to version 1.4.2 or later. ## Prerequisites -Before you upgrade a module enabled in a database, [install the new version of the module on the cluster]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster" >}}). +Before you upgrade a module enabled in a database, [install the new version of the module on the cluster](/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster.md). ## Upgrade a module for a database After you install an updated module on the cluster, you can upgrade databases to use the new module version. -{{}} -After you upgrade the module for a database, the database shards restart. This causes a short interruption in the availability of this database across the cluster. -{{}} +> [!WARNING] +> After you upgrade the module for a database, the database shards restart. This causes a short interruption in the availability of this database across the cluster. To upgrade a module enabled for a database: @@ -77,9 +75,9 @@ To upgrade a module enabled for a database: and module module_name version module_args "" ``` - {{}} -The upgrade process does not validate the module upgrade arguments, and incorrect arguments can cause unexpected downtime. Test module upgrade commands in a test environment before you upgrade modules in production. - {{}} + > [!WARNING] + > The upgrade process does not validate the module upgrade arguments, and incorrect arguments can cause unexpected downtime. Test module upgrade commands in a test environment before you upgrade modules in production. + > For the module arguments, use one of the following: 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 4e140b9ae4..3543fb4840 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 @@ -19,27 +19,27 @@ compatible with Redis Software databases with JSON enabled. ## JSON paths -[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. +[Paths](/content/develop/data-types/json/path.md) 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 Open Source implements its own. ### JSONPath syntax -RedisJSON v2.0 and later support the [JSONPath syntax]({{< relref "/develop/data-types/json/path" >}}), which resembles [Goessner's design](https://goessner.net/articles/JsonPath/): +RedisJSON v2.0 and later support the [JSONPath syntax](/content/develop/data-types/json/path.md), which resembles [Goessner's design](https://goessner.net/articles/JsonPath/): - Paths start with a dollar sign (`$`), which represents the root of the JSON document. - - See the [JSONPath syntax table]({{< relref "/develop/data-types/json/path" >}}) to learn how to access various elements within a JSON document. + - See the [JSONPath syntax table](/content/develop/data-types/json/path.md) to learn how to access various elements within a JSON document. The following path refers to `headphones`, which is a child of `inventory` under the root: `$.inventory.headphones` -See [JSONPath examples]({{< relref "/develop/data-types/json/path" >}}) for examples with more complex syntax. +See [JSONPath examples](/content/develop/data-types/json/path.md) for examples with more complex syntax. ### Legacy path syntax -The [legacy path syntax]({{< relref "/develop/data-types/json/path" >}}#legacy-path-syntax) refers to the path implementation in RedisJSON v1. RedisJSON v2 still supports this legacy path syntax in addition to JSONPath syntax. +The [legacy path syntax](/content/develop/data-types/json/path.md#legacy-path-syntax) refers to the path implementation in RedisJSON v1. RedisJSON v2 still supports this legacy path syntax in addition to JSONPath syntax. The legacy path syntax works as follows: @@ -69,16 +69,16 @@ You can only use the legacy path syntax to access JSON keys if they follow these You can index, search, and query stored JSON documents. -For more information about how to search and query JSON documents, see the [quick start]({{< relref "/develop/get-started/search-tutorial" >}}). +For more information about how to search and query JSON documents, see the [quick start](/content/develop/get-started/search-tutorial/_index.md). ## JSON in Active-Active databases -RedisJSON v2.2 and later support the JSON data structure as a conflict-free replicated data type [(CRDT)](https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type) in [Active-Active Redis Software databases]({{< relref "/operate/rs/databases/active-active" >}}). +RedisJSON v2.2 and later support the JSON data structure as a conflict-free replicated data type [(CRDT)](https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type) in [Active-Active Redis Software databases](/content/operate/rs/databases/active-active/_index.md). -For details about how Redis Software resolves JSON operation conflicts that can arise when replicas attempt to sync, see the JSON [conflict resolution rules]({{< relref "/operate/oss_and_stack/stack-with-enterprise/json/active-active#conflict-resolution-rules" >}}). +For details about how Redis Software resolves JSON operation conflicts that can arise when replicas attempt to sync, see the JSON [conflict resolution rules](/content/operate/oss_and_stack/stack-with-enterprise/json/active-active.md#conflict-resolution-rules). ## More info -- [JSON quick start]({{< relref "/develop/data-types/json/" >}}#use-redisjson) -- [JSON commands]({{< relref "/operate/oss_and_stack/stack-with-enterprise/json/commands" >}}) +- [JSON quick start](/content/develop/data-types/json/_index.md#use-redisjson) +- [JSON commands](/content/operate/oss_and_stack/stack-with-enterprise/json/commands.md) - [RedisJSON source](https://github.com/RedisJSON/RedisJSON) diff --git a/content/operate/oss_and_stack/stack-with-enterprise/json/active-active.md b/content/operate/oss_and_stack/stack-with-enterprise/json/active-active.md index a7070ff6e2..626c3ccd89 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/json/active-active.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/json/active-active.md @@ -11,7 +11,7 @@ weight: 50 tocEmbedHeaders: true --- -RedisJSON v2.2 adds support for JSON in [Active-Active Redis Software databases]({{< relref "/operate/rs/databases/active-active" >}}). +RedisJSON v2.2 adds support for JSON in [Active-Active Redis Software databases](/content/operate/rs/databases/active-active/_index.md). The design is based on [A Conflict-Free Replicated JSON Datatype](https://arxiv.org/abs/1608.03960) by Kleppmann and Beresford, but the implementation includes some changes. Several [conflict resolution rule](#conflict-resolution-rules) examples were adapted from this paper as well. @@ -19,19 +19,19 @@ The design is based on [A Conflict-Free Replicated JSON Datatype](https://arxiv. To use JSON in an Active-Active database, you must enable JSON during database creation. -Active-Active Redis Cloud databases add JSON by default. See [Create an Active-Active database]({{< relref "/operate/rc/databases/active-active/create-active-active-database#select-capabilities" >}}) in the Redis Cloud documentation for details. +Active-Active Redis Cloud databases add JSON by default. See [Create an Active-Active database](/content/operate/rc/databases/active-active/create-active-active-database.md#select-capabilities) in the Redis Cloud documentation for details. In Redis Software, Active-Active databases created with or upgraded to Redis version 8 or later automatically enable JSON. For earlier Redis versions, you can enable JSON during database creation: -1. See [Create an Active-Active geo-replicated database]({{< relref "/operate/rs/databases/active-active/create" >}}) in the Redis Software documentation for prerequisites and detailed steps. +1. See [Create an Active-Active geo-replicated database](/content/operate/rs/databases/active-active/create.md) in the Redis Software documentation for prerequisites and detailed steps. 1. In the **Capabilities** section of the **Create Active-Active database** screen, select **JSON**: {{Select JSON from the Capabilities section.}} - {{}} -When you select **JSON**, **Search and Query** is also selected by default to allow you to index and query JSON documents. If you do not want to use these additional features, you can clear the **Search and Query** check box. - {{}} + > [!NOTE] + > When you select **JSON**, **Search and Query** is also selected by default to allow you to index and query JSON documents. If you do not want to use these additional features, you can clear the **Search and Query** check box. + > 1. Configure additional database settings. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/json/commands.md b/content/operate/oss_and_stack/stack-with-enterprise/json/commands.md index 6e983a3938..cfca5d0a26 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/json/commands.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/json/commands.md @@ -15,28 +15,28 @@ The following table lists JSON commands. See the command links for more informat | Command | Redis
Software | Redis
Cloud | Description | |:--------|:----------------------|:-----------------|:------| -| [JSON.ARRAPPEND]({{< relref "commands/json.arrappend" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Appends an element to a JSON array. | -| [JSON.ARRINDEX]({{< relref "commands/json.arrindex" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the index of a value's first occurrence in a JSON array. | -| [JSON.ARRINSERT]({{< relref "commands/json.arrinsert" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Inserts JSON values into a JSON array before the given index. | -| [JSON.ARRLEN]({{< relref "commands/json.arrlen" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the length of a JSON array. | -| [JSON.ARRPOP]({{< relref "commands/json.arrpop" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Removes and returns an element located at the index in the JSON array. | -| [JSON.ARRTRIM]({{< relref "commands/json.arrtrim" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Trims a JSON array so that it contains only the specified inclusive range of elements. | -| [JSON.CLEAR]({{< relref "commands/json.clear" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Clears container values (arrays/objects) and sets numeric values to 0. | -| [JSON.DEBUG]({{< relref "commands/json.debug" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Debugging container command. | -| [JSON.DEBUG HELP]({{< relref "commands/json.debug-help" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns helpful information about the [JSON.DEBUG]({{< relref "commands/json.debug" >}}) command. | -| [JSON.DEBUG MEMORY]({{< relref "commands/json.debug-memory/" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Reports a JSON element's memory usage in bytes. | -| [JSON.DEL]({{< relref "commands/json.del" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Removes a JSON element. | -| [JSON.FORGET]({{< relref "commands/json.forget" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Removes a JSON element, the same as [JSON.DEL]({{< relref "commands/json.del" >}}). | -| [JSON.GET]({{< relref "commands/json.get" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the value of an element in JSON-serialized form. | -| [JSON.MGET]({{< relref "commands/json.mget" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the values of multiple elements. | -| [JSON.MERGE]({{< relref "commands/json.merge" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Merge a given JSON value into matching paths. | -| [JSON.NUMINCRBY]({{< relref "commands/json.numincrby" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Increments the number stored at path by the specified number. | -| [JSON.NUMMULTBY]({{< relref "commands/json.nummultby" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Multiplies the number stored at path by the specified number. (deprecated as of RedisJSON v2.0) | -| [JSON.OBJKEYS]({{< relref "commands/json.objkeys" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the keys contained in the specified JSON object. | -| [JSON.OBJLEN]({{< relref "commands/json.objlen" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the number of keys in the specified JSON object. | -| [JSON.RESP]({{< relref "commands/json.resp" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns a JSON element in [Redis Serialization Protocol (RESP)]({{< relref "/develop/reference/protocol-spec" >}}) format. | -| [JSON.SET]({{< relref "commands/json.set" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Sets the value of a JSON element. | -| [JSON.STRAPPEND]({{< relref "commands/json.strappend" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Appends the given string to the specified key's existing strings. | -| [JSON.STRLEN]({{< relref "commands/json.strlen" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the length of a string. | -| [JSON.TOGGLE]({{< relref "commands/json.toggle" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | If the boolean is `true`, changes it to `false`. If the boolean is `false`, changes it to `true`. | -| [JSON.TYPE]({{< relref "commands/json.type" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns a JSON element's type. | +| [JSON.ARRAPPEND](/content/commands/json.arrappend.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Appends an element to a JSON array. | +| [JSON.ARRINDEX](/content/commands/json.arrindex.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the index of a value's first occurrence in a JSON array. | +| [JSON.ARRINSERT](/content/commands/json.arrinsert.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Inserts JSON values into a JSON array before the given index. | +| [JSON.ARRLEN](/content/commands/json.arrlen.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the length of a JSON array. | +| [JSON.ARRPOP](/content/commands/json.arrpop.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Removes and returns an element located at the index in the JSON array. | +| [JSON.ARRTRIM](/content/commands/json.arrtrim.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Trims a JSON array so that it contains only the specified inclusive range of elements. | +| [JSON.CLEAR](/content/commands/json.clear.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Clears container values (arrays/objects) and sets numeric values to 0. | +| [JSON.DEBUG](/content/commands/json.debug.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Debugging container command. | +| [JSON.DEBUG HELP](/content/commands/json.debug-help.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns helpful information about the [JSON.DEBUG](/content/commands/json.debug.md) command. | +| [JSON.DEBUG MEMORY](/content/commands/json.debug-memory.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Reports a JSON element's memory usage in bytes. | +| [JSON.DEL](/content/commands/json.del.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Removes a JSON element. | +| [JSON.FORGET](/content/commands/json.forget.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Removes a JSON element, the same as [JSON.DEL](/content/commands/json.del.md). | +| [JSON.GET](/content/commands/json.get.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the value of an element in JSON-serialized form. | +| [JSON.MGET](/content/commands/json.mget.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the values of multiple elements. | +| [JSON.MERGE](/content/commands/json.merge.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Merge a given JSON value into matching paths. | +| [JSON.NUMINCRBY](/content/commands/json.numincrby.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Increments the number stored at path by the specified number. | +| [JSON.NUMMULTBY](/content/commands/json.nummultby.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Multiplies the number stored at path by the specified number. (deprecated as of RedisJSON v2.0) | +| [JSON.OBJKEYS](/content/commands/json.objkeys.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the keys contained in the specified JSON object. | +| [JSON.OBJLEN](/content/commands/json.objlen.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the number of keys in the specified JSON object. | +| [JSON.RESP](/content/commands/json.resp.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns a JSON element in [Redis Serialization Protocol (RESP)](/content/develop/reference/protocol-spec.md) format. | +| [JSON.SET](/content/commands/json.set.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Sets the value of a JSON element. | +| [JSON.STRAPPEND](/content/commands/json.strappend.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Appends the given string to the specified key's existing strings. | +| [JSON.STRLEN](/content/commands/json.strlen.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the length of a string. | +| [JSON.TOGGLE](/content/commands/json.toggle.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | If the boolean is `true`, changes it to `false`. If the boolean is `false`, changes it to `true`. | +| [JSON.TYPE](/content/commands/json.type.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns a JSON element's type. | diff --git a/content/operate/oss_and_stack/stack-with-enterprise/modules-lifecycle.md b/content/operate/oss_and_stack/stack-with-enterprise/modules-lifecycle.md index 5417f31f51..f7c3fa5dd7 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/modules-lifecycle.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/modules-lifecycle.md @@ -9,7 +9,7 @@ description: null linkTitle: Module lifecycle weight: 7 --- -Redis Software follows the [Redis Software lifecycle]({{< relref "/operate/rs/installing-upgrading/product-lifecycle" >}}). (For complete details, see the Redis Software [subscription agreement](https://redis.com/software-subscription-agreement).) +Redis Software follows the [Redis Software lifecycle](/content/operate/rs/installing-upgrading/product-lifecycle.md). (For complete details, see the Redis Software [subscription agreement](https://redis.com/software-subscription-agreement).) The lifecycle model for modules changed with Redis 8.0. This page is organized into two sections accordingly: @@ -18,13 +18,13 @@ The lifecycle model for modules changed with Redis 8.0. This page is organized i ## Redis 8.0 and later -Starting with Redis 8.0, the capabilities that were previously distributed as separate modules—Redis Search (RediSearch), JSON (RedisJSON), Time series (RedisTimeSeries), and Probabilistic (RedisBloom)—are built into Redis Open Source. [Redis 8 in Redis Open Source replaces Redis Stack]({{< relref "/operate/oss_and_stack" >}}), so there is no separate module to install or version. +Starting with Redis 8.0, the capabilities that were previously distributed as separate modules—Redis Search (RediSearch), JSON (RedisJSON), Time series (RedisTimeSeries), and Probabilistic (RedisBloom)—are built into Redis Open Source. [Redis 8 in Redis Open Source replaces Redis Stack](/content/operate/oss_and_stack/_index.md), so there is no separate module to install or version. As a result: - **Modules are versioned in lockstep with Redis.** Redis 8.0 ships all of these capabilities as version 8.0, and each Redis version requires the exact matching module version. Redis X.Y requires modules of version X.Y. -- **Modules share the Redis lifecycle.** Because the whole feature set (Redis X.Y plus its modules X.Y) ships and is supported as a single unit, the end-of-life for the modules follows the Redis lifecycle rather than a separate per-module schedule. For Redis Software, this is the [Redis Software product lifecycle]({{< relref "/operate/rs/installing-upgrading/product-lifecycle" >}}), where the end-of-life for each major release occurs 24 months after the formal release of the subsequent major version. +- **Modules share the Redis lifecycle.** Because the whole feature set (Redis X.Y plus its modules X.Y) ships and is supported as a single unit, the end-of-life for the modules follows the Redis lifecycle rather than a separate per-module schedule. For Redis Software, this is the [Redis Software product lifecycle](/content/operate/rs/installing-upgrading/product-lifecycle.md), where the end-of-life for each major release occurs 24 months after the formal release of the subsequent major version. The module APIs continue to follow [semantic versioning](https://semver.org/). diff --git a/content/operate/oss_and_stack/stack-with-enterprise/search/_index.md b/content/operate/oss_and_stack/stack-with-enterprise/search/_index.md index 81f7a652c1..912a394142 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/search/_index.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/search/_index.md @@ -13,7 +13,7 @@ linkTitle: Redis Search weight: 20 --- The [RediSearch 2.x module](https://redis.com/blog/introducing-redisearch-2-0/) is a source-available project that lets you build powerful search queries for open source Redis databases. -When combined with Redis Software, you can use the same protocols and [commands]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search/commands" >}}) +When combined with Redis Software, you can use the same protocols and [commands](/content/operate/oss_and_stack/stack-with-enterprise/search/commands.md) to run geo-replicated queries and full-text searches over efficient in-memory indexes. ## Index documents @@ -23,27 +23,27 @@ Redis Search indexes documents, which are objects that represent data as field-v As the documents in your database change, the index automatically processes these changes to keep the search results up to date. With indexes, you can do: -- Language-aware [fuzzy matching]({{< relref "develop/ai/search-and-query/advanced-concepts/query_syntax#fuzzy-matching" >}}) -- Fast [auto-complete]({{< relref "develop/ai/search-and-query/administration/overview#auto-complete" >}}) -- [Exact phrase matching]({{< relref "develop/ai/search-and-query/advanced-concepts/query_syntax" >}}) -- [Numeric filtering]({{< relref "develop/ai/search-and-query/advanced-concepts/query_syntax#numeric-filters-in-query" >}}) -- [Geo-radius queries]({{< relref "develop/ai/search-and-query/advanced-concepts/query_syntax#geo-filters" >}}) +- Language-aware [fuzzy matching](/content/develop/ai/search-and-query/advanced-concepts/query_syntax.md#fuzzy-matching) +- Fast [auto-complete](/content/develop/ai/search-and-query/administration/overview.md#auto-complete) +- [Exact phrase matching](/content/develop/ai/search-and-query/advanced-concepts/query_syntax.md) +- [Numeric filtering](/content/develop/ai/search-and-query/advanced-concepts/query_syntax.md#numeric-filters-in-query) +- [Geo-radius queries](/content/develop/ai/search-and-query/advanced-concepts/query_syntax.md#geo-filters) ## Supported document types -You can store documents as Redis [hashes]({{< relref "/develop/data-types/hashes" >}}) or [JSON]({{< relref "/develop/data-types/json" >}}). To search and query JSON documents, you also need to enable [JSON]({{< relref "/operate/oss_and_stack/stack-with-enterprise/json" >}}) in your database. +You can store documents as Redis [hashes](/content/develop/data-types/hashes.md) or [JSON](/content/develop/data-types/json/_index.md). To search and query JSON documents, you also need to enable [JSON](/content/operate/oss_and_stack/stack-with-enterprise/json/_index.md) in your database. ### Hash documents -With Redis [hashes]({{< relref "/develop/data-types/hashes" >}}), each document is assigned to a single key and uses field-value pairs to represent the document's contents. +With Redis [hashes](/content/develop/data-types/hashes.md), each document is assigned to a single key and uses field-value pairs to represent the document's contents. -You can run [`HGETALL`]({{< relref "/commands/hgetall" >}}) to retrieve the entire hash document. +You can run [`HGETALL`](/content/commands/hgetall.md) to retrieve the entire hash document. ### JSON documents You can index, search, and query JSON documents stored in your database. -For more information about how to search and query JSON documents, see the [quick start]({{< relref "/develop/get-started/search-tutorial" >}}). +For more information about how to search and query JSON documents, see the [quick start](/content/develop/get-started/search-tutorial/_index.md). ## Search features @@ -51,11 +51,11 @@ For full-text searches, you can customize the field queries and ranking of the s When querying, you can use multiple predicates that query text, numeric, and geospatial fields in one query. You can also sort by a specific field and limit the results with an offset to produce customized results pages. -Redis Open Source supports [over 15 natural languages]({{< relref "/develop/ai/search-and-query/advanced-concepts/stemming" >}}) for stemming and includes auto-complete engines with specific commands that can provide real-time [interactive search suggestions]({{< relref "/commands/ft.sugadd" >}}). +Redis Open Source supports [over 15 natural languages](/content/develop/ai/search-and-query/advanced-concepts/stemming.md) for stemming and includes auto-complete engines with specific commands that can provide real-time [interactive search suggestions](/content/commands/ft.sugadd.md). ## Redis Search in Active-Active databases -As a result of the new RediSearch architecture and methodology, [RediSearch 2.x supports Active-Active databases]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search/search-active-active" >}}). +As a result of the new RediSearch architecture and methodology, [RediSearch 2.x supports Active-Active databases](/content/operate/oss_and_stack/stack-with-enterprise/search/search-active-active.md). You can now serve your index information from geo-distributed database instances. ## Resharding indexed data @@ -66,13 +66,13 @@ Because the index on the new shard is created synchronously though, it's expecte ## Limitations -- You cannot use Redis Search capabilities with the [OSS Cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api" >}}). This limitation was fixed in Redis Software version 8.0. +- You cannot use Redis Search capabilities with the [OSS Cluster API](/content/operate/rs/databases/configure/oss-cluster-api.md). This limitation was fixed in Redis Software version 8.0. ## More info - [Getting Started with RediSearch 2.0](https://redis.com/blog/getting-started-with-redisearch-2-0/) -- [Redis Search quick start]({{< relref "/develop/get-started/search-tutorial" >}}) -- [Redis Search configuration]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search/config" >}}) -- [Redis Search commands]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search/commands" >}}) -- [Redis Search references]({{< relref "/develop/ai/search-and-query/advanced-concepts/" >}}) +- [Redis Search quick start](/content/develop/get-started/search-tutorial/_index.md) +- [Redis Search configuration](/content/operate/oss_and_stack/stack-with-enterprise/search/config.md) +- [Redis Search commands](/content/operate/oss_and_stack/stack-with-enterprise/search/commands.md) +- [Redis Search references](/content/develop/ai/search-and-query/advanced-concepts/_index.md) - [RediSearch source](https://github.com/RediSearch/RediSearch) diff --git a/content/operate/oss_and_stack/stack-with-enterprise/search/commands.md b/content/operate/oss_and_stack/stack-with-enterprise/search/commands.md index 7160aeed80..29f496c93a 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/search/commands.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/search/commands.md @@ -16,34 +16,34 @@ The following table lists Redis Search commands. See the command links for more | Command | Redis Software | Redis Cloud
Flexible & Annual | Redis Cloud
Free & Fixed | Description | |:--------|:----------------------|:-----------------|:-----------------|:------| -| [FT.AGGREGATE]({{< relref "commands/ft.aggregate" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Runs a search query on an index and groups, sorts, transforms, limits, and/or filters the results. | -| [FT.ALIASADD]({{< relref "commands/ft.aliasadd" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Adds an alias to an index. | -| [FT.ALIASDEL]({{< relref "commands/ft.aliasdel" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Removes an alias from an index. | -| [FT.ALIASLIST]({{< relref "commands/ft.aliaslist" >}}) | ❌ Not supported | ❌ Not supported | ❌ Not supported | List aliases for an index. | -| [FT.ALIASUPDATE]({{< relref "commands/ft.aliasupdate" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Adds an alias to an index. If the alias already exists for a different index, it updates the alias to point to the specified index instead. | -| [FT.ALTER]({{< relref "commands/ft.alter" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Adds a new field to an index. | -| [FT.CONFIG GET]({{< relref "commands/ft.config-get" >}}) | ❌ Not supported | ⚠️ Not supported[2](#table-note-2) | ❌ Not supported | Displays configuration options. | -| [FT.CONFIG HELP]({{< relref "commands/ft.config-help" >}}) | ❌ Not supported | ❌ Not supported | ❌ Not supported | Describes configuration options. | -| [FT.CONFIG SET]({{< relref "commands/ft.config-set" >}}) | ⚠️ Not supported[1](#table-note-1) | ⚠️ Not supported[2](#table-note-2) | ❌ Not supported | Sets configuration options. | -| [FT.CREATE]({{< relref "commands/ft.create" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Creates an index. | -| [FT.CURSOR DEL]({{< relref "commands/ft.cursor-del" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Deletes a cursor. | -| [FT.CURSOR READ]({{< relref "commands/ft.cursor-read/" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Reads the next results from an existing cursor. | -| [FT.DICTADD]({{< relref "commands/ft.dictadd" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Adds terms to a dictionary. | -| [FT.DICTDEL]({{< relref "commands/ft.dictdel" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Deletes terms from a dictionary. | -| [FT.DICTDUMP]({{< relref "commands/ft.dictdump" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Returns all terms in the specified dictionary. | -| [FT.DROPINDEX]({{< relref "commands/ft.dropindex" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Deletes an index. | -| [FT.EXPLAIN]({{< relref "commands/ft.explain" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Returns the execution plan for a complex query as a string. | -| [FT.EXPLAINCLI]({{< relref "commands/ft.explaincli" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Returns the execution plan for a complex query as an [array]({{< relref "develop/reference/protocol-spec/#arrays" >}}). | -| [FT.HYBRID]({{< relref "commands/ft.hybrid" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Performs hybrid search combining text search and vector similarity with configurable fusion methods. | -| [FT.INFO]({{< relref "commands/ft.info" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Returns index information and statistics. | -| [FT._LIST]({{< relref "commands/ft._list" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Lists all indexes. | -| [FT.PROFILE]({{< relref "commands/ft.profile" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Runs [FT.SEARCH]({{< relref "commands/ft.search" >}}) or [FT.AGGREGATE]({{< relref "commands/ft.aggregate" >}}) and reports performance information. | -| [FT.SEARCH]({{< relref "commands/ft.search" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Searches an index for a text query and returns matching documents or document IDs. | -| [FT.SPELLCHECK]({{< relref "commands/ft.spellcheck" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Suggests spelling corrections for misspelled terms in a query. | -| [FT.SYNDUMP]({{< relref "commands/ft.syndump" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Returns a list of synonym terms and their synonym group IDs. | -| [FT.SYNUPDATE]({{< relref "commands/ft.synupdate" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Creates or updates a synonym group with additional terms. | -| [FT.TAGVALS]({{< relref "commands/ft.tagvals" >}}) | ✅ Supported | ✅ Supported | ✅ Supported | Returns all distinct values indexed in a tag field. | +| [FT.AGGREGATE](/content/commands/ft.aggregate.md) | ✅ Supported | ✅ Supported | ✅ Supported | Runs a search query on an index and groups, sorts, transforms, limits, and/or filters the results. | +| [FT.ALIASADD](/content/commands/ft.aliasadd.md) | ✅ Supported | ✅ Supported | ✅ Supported | Adds an alias to an index. | +| [FT.ALIASDEL](/content/commands/ft.aliasdel.md) | ✅ Supported | ✅ Supported | ✅ Supported | Removes an alias from an index. | +| [FT.ALIASLIST](/content/commands/ft.aliaslist.md) | ❌ Not supported | ❌ Not supported | ❌ Not supported | List aliases for an index. | +| [FT.ALIASUPDATE](/content/commands/ft.aliasupdate.md) | ✅ Supported | ✅ Supported | ✅ Supported | Adds an alias to an index. If the alias already exists for a different index, it updates the alias to point to the specified index instead. | +| [FT.ALTER](/content/commands/ft.alter.md) | ✅ Supported | ✅ Supported | ✅ Supported | Adds a new field to an index. | +| [FT.CONFIG GET](/content/commands/ft.config-get.md) | ❌ Not supported | ⚠️ Not supported[2](#table-note-2) | ❌ Not supported | Displays configuration options. | +| [FT.CONFIG HELP](/content/commands/ft.config-help.md) | ❌ Not supported | ❌ Not supported | ❌ Not supported | Describes configuration options. | +| [FT.CONFIG SET](/content/commands/ft.config-set.md) | ⚠️ Not supported[1](#table-note-1) | ⚠️ Not supported[2](#table-note-2) | ❌ Not supported | Sets configuration options. | +| [FT.CREATE](/content/commands/ft.create.md) | ✅ Supported | ✅ Supported | ✅ Supported | Creates an index. | +| [FT.CURSOR DEL](/content/commands/ft.cursor-del.md) | ✅ Supported | ✅ Supported | ✅ Supported | Deletes a cursor. | +| [FT.CURSOR READ](/content/commands/ft.cursor-read.md) | ✅ Supported | ✅ Supported | ✅ Supported | Reads the next results from an existing cursor. | +| [FT.DICTADD](/content/commands/ft.dictadd.md) | ✅ Supported | ✅ Supported | ✅ Supported | Adds terms to a dictionary. | +| [FT.DICTDEL](/content/commands/ft.dictdel.md) | ✅ Supported | ✅ Supported | ✅ Supported | Deletes terms from a dictionary. | +| [FT.DICTDUMP](/content/commands/ft.dictdump.md) | ✅ Supported | ✅ Supported | ✅ Supported | Returns all terms in the specified dictionary. | +| [FT.DROPINDEX](/content/commands/ft.dropindex.md) | ✅ Supported | ✅ Supported | ✅ Supported | Deletes an index. | +| [FT.EXPLAIN](/content/commands/ft.explain.md) | ✅ Supported | ✅ Supported | ✅ Supported | Returns the execution plan for a complex query as a string. | +| [FT.EXPLAINCLI](/content/commands/ft.explaincli.md) | ✅ Supported | ✅ Supported | ✅ Supported | Returns the execution plan for a complex query as an [array](/content/develop/reference/protocol-spec.md#arrays). | +| [FT.HYBRID](/content/commands/ft.hybrid.md) | ✅ Supported | ✅ Supported | ✅ Supported | Performs hybrid search combining text search and vector similarity with configurable fusion methods. | +| [FT.INFO](/content/commands/ft.info.md) | ✅ Supported | ✅ Supported | ✅ Supported | Returns index information and statistics. | +| [FT._LIST](/content/commands/ft._list.md) | ✅ Supported | ✅ Supported | ✅ Supported | Lists all indexes. | +| [FT.PROFILE](/content/commands/ft.profile.md) | ✅ Supported | ✅ Supported | ✅ Supported | Runs [FT.SEARCH](/content/commands/ft.search.md) or [FT.AGGREGATE](/content/commands/ft.aggregate.md) and reports performance information. | +| [FT.SEARCH](/content/commands/ft.search.md) | ✅ Supported | ✅ Supported | ✅ Supported | Searches an index for a text query and returns matching documents or document IDs. | +| [FT.SPELLCHECK](/content/commands/ft.spellcheck.md) | ✅ Supported | ✅ Supported | ✅ Supported | Suggests spelling corrections for misspelled terms in a query. | +| [FT.SYNDUMP](/content/commands/ft.syndump.md) | ✅ Supported | ✅ Supported | ✅ Supported | Returns a list of synonym terms and their synonym group IDs. | +| [FT.SYNUPDATE](/content/commands/ft.synupdate.md) | ✅ Supported | ✅ Supported | ✅ Supported | Creates or updates a synonym group with additional terms. | +| [FT.TAGVALS](/content/commands/ft.tagvals.md) | ✅ Supported | ✅ Supported | ✅ Supported | Returns all distinct values indexed in a tag field. | -1. Use [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) or the [REST API]({{< relref "/operate/rs/references/rest-api" >}}) to change Redis Search configuration for Redis Software. See [Redis Search configuration compatibility with Redis Software]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search/config" >}}) for more information and examples. +1. Use [`rladmin`](/content/operate/rs/references/cli-utilities/rladmin/_index.md) or the [REST API](/content/operate/rs/references/rest-api/_index.md) to change Redis Search configuration for Redis Software. See [Redis Search configuration compatibility with Redis Software](/content/operate/oss_and_stack/stack-with-enterprise/search/config.md) for more information and examples. 2. [Contact support](https://redis.com/company/support/) to view the current configuration values or request configuration changes for Flexible or Annual Redis Cloud subscriptions. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/search/config.md b/content/operate/oss_and_stack/stack-with-enterprise/search/config.md index 4be4d90efe..9084fdc78d 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/search/config.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/search/config.md @@ -11,13 +11,13 @@ toc: 'false' weight: 15 --- -To configure Redis Search in [Redis Software]({{< relref "/operate/rs" >}}) or [Redis Cloud]({{< relref "/operate/rc" >}}), use one of the following methods instead of [`FT.CONFIG SET`]({{< relref "commands/ft.config-set" >}}). +To configure Redis Search in [Redis Software](/content/operate/rs/_index.md) or [Redis Cloud](/content/operate/rc/_index.md), use one of the following methods instead of [`FT.CONFIG SET`](/content/commands/ft.config-set.md). ## Configure search in Redis Cloud For Redis Cloud: -- _Flexible or Annual [subscriptions]({{< relref "/operate/rc/subscriptions" >}})_: contact [support](https://redis.com/company/support/) to request a configuration change. +- _Flexible or Annual [subscriptions](/content/operate/rc/subscriptions/_index.md)_: contact [support](https://redis.com/company/support/) to request a configuration change. - _Free or Fixed subscriptions_: you cannot change Redis Search configuration. @@ -35,7 +35,7 @@ For Redis Software, use one of the following methods: 1. Enter the setting name and setting value in the **RediSearch** box. - In the **Query Performance Factor** section, you can configure settings to improve query performance. See [Configure the query performance factor for Redis Search in Redis Software]({{}}) for more information. + In the **Query Performance Factor** section, you can configure settings to improve query performance. See [Configure the query performance factor for Redis Search in Redis Software](/content/operate/oss_and_stack/stack-with-enterprise/search/query-performance-factor.md) for more information. {{The Parameters dialog includes sections to edit RediSearch settings and the Query Performance Factor settings.}} @@ -43,14 +43,14 @@ For Redis Software, use one of the following methods: 1. Click **Save**. -- [`rladmin tune db`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-db" >}}): +- [`rladmin tune db`](/content/operate/rs/references/cli-utilities/rladmin/tune.md#tune-db): ```sh $ rladmin tune db db: module_name search \ module_config_params "setting-name setting-value" ``` -- [Configure module]({{< relref "/operate/rs/references/rest-api/requests/modules/config" >}}) REST API request: +- [Configure module](/content/operate/rs/references/rest-api/requests/modules/config.md) REST API request: ```sh POST /v1/modules/config/bdb/ @@ -66,4 +66,4 @@ For Redis Software, use one of the following methods: ## Configuration settings -See [configuration parameters]({{< relref "/develop/ai/search-and-query/administration/configuration" >}}) in the Develop section for parameter details and compatibility with Redis Software and Redis Cloud. +See [configuration parameters](/content/develop/ai/search-and-query/administration/configuration.md) in the Develop section for parameter details and compatibility with Redis Software and Redis Cloud. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/search/query-performance-factor.md b/content/operate/oss_and_stack/stack-with-enterprise/search/query-performance-factor.md index 32c97d58ba..98fea51797 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/search/query-performance-factor.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/search/query-performance-factor.md @@ -12,23 +12,22 @@ aliases: /operate/oss_and_stack/stack-with-enterprise/search/scalable-search/ /operate/oss_and_stack/stack-with-enterprise/search/query-performance-factor/ --- -Query performance factors are intended to increase the performance of queries, including [vector search]({{}}). When enabled, it allows you to increase a database's compute capacity and query throughput by allocating more virtual CPUs per shard. This is in addition to horizontal scaling with more shards which enables a higher throughput of key value operations. This document describes how to configure the query performance factor. +Query performance factors are intended to increase the performance of queries, including [vector search](/content/develop/ai/search-and-query/query/vector-search.md). When enabled, it allows you to increase a database's compute capacity and query throughput by allocating more virtual CPUs per shard. This is in addition to horizontal scaling with more shards which enables a higher throughput of key value operations. This document describes how to configure the query performance factor. -{{}} -Some use cases might not scale effectively. Redis experts can help determine if vertical scaling with Redis Search will boost performance for your use case and guide you on whether to use vertical scaling, horizontal scaling, or both. -{{}} +> [!NOTE] +> Some use cases might not scale effectively. Redis experts can help determine if vertical scaling with Redis Search will boost performance for your use case and guide you on whether to use vertical scaling, horizontal scaling, or both. ## Prerequisites Redis Search requires a cluster running Redis Software version 7.4.2-54 or later. For the simplified configuration experience (no shard restart required, new UI, and new REST API), Redis Software version 8.x or later is required. -If you do not have a cluster that supports Redis Search, [install Redis Software]({{}}) version 7.4.2-54 or later on a new cluster, or [upgrade an existing cluster]({{}}). +If you do not have a cluster that supports Redis Search, [install Redis Software](/content/operate/rs/installing-upgrading/install/install-on-linux.md) version 7.4.2-54 or later on a new cluster, or [upgrade an existing cluster](/content/operate/rs/installing-upgrading/upgrading/upgrade-cluster.md). ## Sizing 1. Calculate the hardware requirements for your Redis database: - 1. Use the [hardware requirements documentation]({{}}) to derive the overall cluster architecture. + 1. Use the [hardware requirements documentation](/content/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md) to derive the overall cluster architecture. 1. Calculate the RAM requirements using the [Index Size Calculator](https://redis.io/redisearch-sizing-calculator/). The total RAM required is the sum of the dataset and index sizes. @@ -81,7 +80,7 @@ Starting with Redis Software 8.x, configuring the query performance factor is si To configure the query performance factor: -1. In the Cluster Manager UI, [create a new database]({{}}) or [edit an existing database]({{}}). +1. In the Cluster Manager UI, [create a new database](/content/operate/rs/databases/create.md) or [edit an existing database](/content/operate/rs/databases/configure/_index.md#edit-database-settings). 1. In the **Capabilities** section, click **Add parameters**. @@ -107,7 +106,7 @@ To manually configure the query performance factor in Redis Software versions pr #### Configure query performance factor parameters {#config-db-ui-params} -You can use the Cluster Manager UI to configure the query performance factor when you [create a new database]({{}}) or [edit an existing database]({{}}) with search enabled. +You can use the Cluster Manager UI to configure the query performance factor when you [create a new database](/content/operate/rs/databases/create.md) or [edit an existing database](/content/operate/rs/databases/configure/_index.md#edit-database-settings) with search enabled. 1. In the **Capabilities** section of the database configuration screen, click **Parameters**. @@ -135,7 +134,7 @@ You can use the Cluster Manager UI to configure the query performance factor whe After you update the query performance factor for an existing database, restart all shards to apply the new settings. You can migrate shards to restart them. Newly created databases can skip this step. -1. Use [`rladmin status shards db `]({{}}) to list all shards for your database: +1. Use [`rladmin status shards db `](/content/operate/rs/references/cli-utilities/rladmin/status.md#status-shards) to list all shards for your database: ```sh rladmin status shards db db-name @@ -155,7 +154,7 @@ After you update the query performance factor for an existing database, restart - `NODE`: the node on which the shard currently resides. - `ROLE`: `master` is a primary shard; `slave` is a replica shard. -1. For each replica shard, use [`rladmin migrate shard`]({{}}) to move it to a different node and restart it: +1. For each replica shard, use [`rladmin migrate shard`](/content/operate/rs/references/cli-utilities/rladmin/migrate.md) to move it to a different node and restart it: ```sh rladmin migrate shard target_node @@ -182,11 +181,11 @@ After you update the query performance factor for an existing database, restart ### Redis Software 8.x and later {#rest-api-v8} -Starting with Redis Software 8.x, you can configure the query performance factor using the [`query_performance_factor`]({{}}) object in the [BDB object]({{}}). You no longer need to manually set `sched_policy`, `conns`, or module `WORKERS` parameters. Changes take effect immediately without restarting shards. +Starting with Redis Software 8.x, you can configure the query performance factor using the [`query_performance_factor`](/content/operate/rs/references/rest-api/objects/bdb/query_performance_factor.md) object in the [BDB object](/content/operate/rs/references/rest-api/objects/bdb/_index.md). You no longer need to manually set `sched_policy`, `conns`, or module `WORKERS` parameters. Changes take effect immediately without restarting shards. #### Create a new database {#create-db-rest-api-v8} -To create a database with the query performance factor enabled, use the [create database REST API endpoint]({{}}) with the `query_performance_factor` field: +To create a database with the query performance factor enabled, use the [create database REST API endpoint](/content/operate/rs/references/rest-api/requests/bdbs/_index.md#post-bdbs-v1) with the `query_performance_factor` field: ```json { @@ -220,7 +219,7 @@ curl -k -u ":" https://:9443/v1/bdbs -H "Content-Type:appl #### Update an existing database {#update-db-rest-api-v8} -To configure the query performance factor for an existing database, use the [update database configuration]({{}}) endpoint with the `query_performance_factor` field: +To configure the query performance factor for an existing database, use the [update database configuration](/content/operate/rs/references/rest-api/requests/bdbs/_index.md#put-bdbs) endpoint with the `query_performance_factor` field: ```sh curl -k -u ":" -X PUT https://:9443/v1/bdbs/ -H "Content-Type:application/json" -d '{ @@ -240,15 +239,15 @@ No shard restart is required. The new configuration applies automatically. | active | boolean (default: false) | If true, enables query performance factor for the database | | scaling_factor | integer (range: 0-16) (default: 0) | Scales the magnitude of the query performance factor | -See the [`query_performance_factor` object reference]({{}}) for more details. +See the [`query_performance_factor` object reference](/content/operate/rs/references/rest-api/objects/bdb/query_performance_factor.md) for more details. ### Prior to Redis Software 8 {#rest-api-prior} -You can configure the query performance factor when you [create a new database](#create-db-rest-api) or [update an existing database](#update-db-rest-api) using the Redis Software [REST API]({{}}). +You can configure the query performance factor when you [create a new database](#create-db-rest-api) or [update an existing database](#update-db-rest-api) using the Redis Software [REST API](/content/operate/rs/references/rest-api/_index.md). #### Create new database with the REST API {#create-db-rest-api} -To create a database and configure the query performance factor, use the [create database REST API endpoint]({{}}) with a [BDB object]({{}}) that includes the following parameters: +To create a database and configure the query performance factor, use the [create database REST API endpoint](/content/operate/rs/references/rest-api/requests/bdbs/_index.md#post-bdbs-v1) with a [BDB object](/content/operate/rs/references/rest-api/objects/bdb/_index.md) that includes the following parameters: ```json { @@ -299,14 +298,13 @@ curl -k -u ":" https://:9443/v1/bdbs -H "Content-Type:appl To configure the query performance factor for an existing database, use the following REST API requests: -- [Update database configuration]({{}}) to modify the DMC proxy. +- [Update database configuration](/content/operate/rs/references/rest-api/requests/bdbs/_index.md#put-bdbs) to modify the DMC proxy. -- [Upgrade module]({{}}) to set the search module’s query performance factor. +- [Upgrade module](/content/operate/rs/references/rest-api/requests/bdbs/modules/upgrade.md#post-bdb-modules-upgrade) to set the search module’s query performance factor. -{{}} -- Because this procedure also restarts the database shards, you should perform it during a maintenance period. -- This procedure overwrites any existing module configuration parameters. -{{}} +> [!NOTE] +> - Because this procedure also restarts the database shards, you should perform it during a maintenance period. +> - This procedure overwrites any existing module configuration parameters. The following example script uses both endpoints to configure a 4x query performance factor: @@ -339,7 +337,7 @@ curl -o /dev/null -s -k -u ":" https://:9443/v1/bdbs/$DB_I To monitor a database with a query performance factor configured: -1. Integrate your Redis Software deployment with Prometheus. See [Prometheus and Grafana with Redis Software]({{}}) for instructions. +1. Integrate your Redis Software deployment with Prometheus. See [Prometheus and Grafana with Redis Software](/content/integrate/prometheus-with-redis-enterprise/_index.md) for instructions. 1. Monitor the `redis_process_cpu_usage_percent` shard metric. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/search/redisearch-2-upgrade.md b/content/operate/oss_and_stack/stack-with-enterprise/search/redisearch-2-upgrade.md index a03b13fff9..206bbd34fe 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/search/redisearch-2-upgrade.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/search/redisearch-2-upgrade.md @@ -16,18 +16,17 @@ This makes commands more efficient and improves replication between clusters bec This change allows databases with RediSearch to support: -- [Active-Active databases]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search/search-active-active" >}}) +- [Active-Active databases](/content/operate/oss_and_stack/stack-with-enterprise/search/search-active-active.md) - Database cluster re-sharding - Replica Of to a sharded destination database -- [EXPIRE]({{< relref "/commands/ttl" >}}) of documents reflected in the index +- [EXPIRE](/content/commands/ttl.md) of documents reflected in the index In addition, RediSearch 2.x indexes data that already existed in the database at the time that the index was created. To upgrade a Redis Software database with RediSearch 1.x to RediSearch 2.x, you have to set up a new database with RediSearch 2.x and use the `RediSearch_Syncer.py` script to replicate the data from the old database into the new database. -{{< note >}} -After you create the database or after you replicate the data, [create an index]({{< relref "commands/ft.create" >}}) with a prefix or filter that defines the keys that you want to index. -{{< /note >}} +> [!NOTE] +> After you create the database or after you replicate the data, [create an index](/content/commands/ft.create.md) with a prefix or filter that defines the keys that you want to index. ## Prerequisites @@ -71,7 +70,7 @@ To replicate a RediSearch 1.x database to a RediSearch 2.x database: ### Create a RediSearch 2.x database {#create-db} -1. [Create a database]({{< relref "/operate/rs/databases/create" >}}) and configure its settings. +1. [Create a database](/content/operate/rs/databases/create.md) and configure its settings. 1. In the **Redis Modules** section: @@ -116,9 +115,9 @@ To replicate a RediSearch 1.x database to a RediSearch 2.x database: - `--add-prefix ` (optional) - Adds a prefix to all of the hashes that are replicated to the new database. - {{}} -Only use the `add-prefix` option if you want to index all of the hashes in the same index in the source database. - {{}} + > [!NOTE] + > Only use the `add-prefix` option if you want to index all of the hashes in the same index in the source database. + > The script shows a table with the progress of the replication process. Press **F5** to see the updated status. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/search/scalable-query-best-practices.md b/content/operate/oss_and_stack/stack-with-enterprise/search/scalable-query-best-practices.md index d0a880105f..45e5936069 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/search/scalable-query-best-practices.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/search/scalable-query-best-practices.md @@ -10,27 +10,27 @@ linkTitle: Best practices for scalable Redis Search weight: 25 --- -[Vertical scaling of Redis Search]({{}}) requires configuring query performance factors. With careful crafting of search indexes and queries, query performance factors allow throughput scaling up to 16X. The following recommendations can help optimize your indexes and queries to maximize the performance benefits from additional CPUs allocated by query performance factors. +[Vertical scaling of Redis Search](/content/operate/oss_and_stack/stack-with-enterprise/search/query-performance-factor.md) requires configuring query performance factors. With careful crafting of search indexes and queries, query performance factors allow throughput scaling up to 16X. The following recommendations can help optimize your indexes and queries to maximize the performance benefits from additional CPUs allocated by query performance factors. ## Best candidates for query performance factor improvements - Query types: - - [Full-text]({{}}) + - [Full-text](/content/develop/ai/search-and-query/query/full-text.md) - - [Tag]({{}}) + - [Tag](/content/develop/ai/search-and-query/advanced-concepts/tags.md) - - [Vector]({{}}) + - [Vector](/content/develop/ai/search-and-query/query/vector-search.md) - - [Numeric]({{}}) + - [Numeric](/content/develop/ai/search-and-query/query/range.md) - - [Geo]({{}}) + - [Geo](/content/develop/ai/search-and-query/query/geo-spatial.md) - Result set types: - Small result sets - - Document subsets that are indexed in their [non-normalized]({{}}) form + - Document subsets that are indexed in their [non-normalized](/content/develop/ai/search-and-query/advanced-concepts/sorting.md#normalization-unf-option) form ## Best practices @@ -38,7 +38,7 @@ If query performance factors have not boosted the performance of your queries as 1. Verify your index includes all queried and returned fields. -1. Identify and avoid query [anti-patterns]({{}}) that limit scalability. +1. Identify and avoid query [anti-patterns](/content/develop/ai/search-and-query/best-practices/scalable-query-best-practices.md#anti-patterns) that limit scalability. 1. Follow best practices to [improve indexing](#improve-indexing). @@ -46,7 +46,7 @@ If query performance factors have not boosted the performance of your queries as ### Improve indexing -Follow these best practices for [indexing]({{}}): +Follow these best practices for [indexing](/content/develop/ai/search-and-query/indexing/_index.md): - Include fields in the index definition that are used in the query or the required result sets (projections). @@ -58,13 +58,13 @@ Follow these best practices for [indexing]({{}}): +Follow these best practices to optimize [queries](/content/develop/ai/search-and-query/query/_index.md): -- Specify the result set fields in the `RETURN` or `LOAD` clauses and include them in the index definition. Don’t just return the default result set from [`FT.SEARCH`]({{< relref "commands/ft.search/" >}}) or `LOAD *` from [`FT.AGGREGATE`]({{< relref "commands/ft.aggregate/" >}}). +- Specify the result set fields in the `RETURN` or `LOAD` clauses and include them in the index definition. Don’t just return the default result set from [`FT.SEARCH`](/content/commands/ft.search.md) or `LOAD *` from [`FT.AGGREGATE`](/content/commands/ft.aggregate.md). - Use `LIMIT` to reduce the result set size. -- Use [`DIALECT 3`]({{}}) or higher for any queries against JSON. +- Use [`DIALECT 3`](/content/develop/ai/search-and-query/advanced-concepts/dialects.md#dialect-3) or higher for any queries against JSON. ## Index and query examples diff --git a/content/operate/oss_and_stack/stack-with-enterprise/search/search-active-active.md b/content/operate/oss_and_stack/stack-with-enterprise/search/search-active-active.md index d469fce9bf..0229f9993e 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/search/search-active-active.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/search/search-active-active.md @@ -9,25 +9,25 @@ description: Search and query Active-Active databases. linkTitle: Search Active-Active databases weight: 30 --- -Starting with RediSearch 2.x, supported in Redis Software (RS) 6.0 and later, you can [enable Redis Search]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database" >}}) for [Active-Active databases]({{< relref "/operate/rs/databases/active-active" >}}) at the time of creation. +Starting with RediSearch 2.x, supported in Redis Software (RS) 6.0 and later, you can [enable Redis Search](/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database.md) for [Active-Active databases](/content/operate/rs/databases/active-active/_index.md) at the time of creation. You can run search operations on any instance of an Active-Active database. ## How it works 1. Create an Active-Active database with RediSearch 2.x enabled. Active-Active databases created with or upgraded to Redis version 8 or later automatically enable Redis Search. -1. [Create the index]({{< relref "commands/ft.create" >}}) on each instance of the database. -1. If you are using [synonyms]({{< relref "/develop/ai/search-and-query/advanced-concepts/synonyms" >}}), you need to add them to each replica. +1. [Create the index](/content/commands/ft.create.md) on each instance of the database. +1. If you are using [synonyms](/content/develop/ai/search-and-query/advanced-concepts/synonyms.md), you need to add them to each replica. 1. The index is maintained by each instance outside of the database keyspace, so only updates to the hashes in the databases are synchronized. ## Command compatibility Active-Active databases do not support the following Redis Search commands: -- [`FT.SUGADD`]({{< relref "commands/ft.sugadd" >}}) -- [`FT.SUGGET`]({{< relref "commands/ft.sugget" >}}) -- [`FT.SUGDEL`]({{< relref "commands/ft.sugdel" >}}) -- [`FT.SUGLEN`]({{< relref "commands/ft.suglen" >}}) +- [`FT.SUGADD`](/content/commands/ft.sugadd.md) +- [`FT.SUGGET`](/content/commands/ft.sugget.md) +- [`FT.SUGDEL`](/content/commands/ft.sugdel.md) +- [`FT.SUGLEN`](/content/commands/ft.suglen.md) ## Example diff --git a/content/operate/oss_and_stack/stack-with-enterprise/stack-quickstart.md b/content/operate/oss_and_stack/stack-with-enterprise/stack-quickstart.md index af2a98e7bf..efc3363684 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/stack-quickstart.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/stack-quickstart.md @@ -14,9 +14,9 @@ you can sign up for a free [Redis Cloud](https://cloud.redis.io/#/sign-up) subsc Alternatively, you can use one of these methods: -- [Redis Software]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) -- Redis Software in a [Docker container]({{< relref "/operate/rs/installing-upgrading/quickstarts/docker-quickstart" >}}) -- [Other platforms]({{< relref "/operate/kubernetes" >}}) for Redis Software +- [Redis Software](/content/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md) +- Redis Software in a [Docker container](/content/operate/rs/installing-upgrading/quickstarts/docker-quickstart.md) +- [Other platforms](/content/operate/kubernetes/_index.md) for Redis Software ## Set up a Redis Cloud database @@ -28,7 +28,7 @@ To set up a Redis Cloud database with Redis Stack features, follow these steps: 1. [Connect to the database](#connect-to-the-database). -For more details, see the Redis Cloud [quick start]({{< relref "/operate/rc/rc-quickstart" >}}). +For more details, see the Redis Cloud [quick start](/content/operate/rc/rc-quickstart.md). ### Create a subscription @@ -75,13 +75,13 @@ After creating the database, you can view its **Configuration** settings. You wi - **Public endpoint**: The host address of the database - **Redis password**/**Default user password**: The password used to authenticate with the database -With this information, you can connect to your database with the [`redis-cli`]({{< relref "/operate/rs/references/cli-utilities/redis-cli" >}}) command-line tool, an application, or [Redis Insight](https://redislabs.com/redisinsight/). +With this information, you can connect to your database with the [`redis-cli`](/content/operate/rs/references/cli-utilities/redis-cli/_index.md) command-line tool, an application, or [Redis Insight](https://redislabs.com/redisinsight/). ## Try Redis Open Source features To try out Redis Open Source features, follow the examples provided by the corresponding guides: -- [Redis Search quick start]({{< relref "/develop/get-started/search-tutorial" >}}) -- [JSON quick start]({{< relref "/develop/data-types/json/" >}}#use-redisjson) -- [Time series quick start]({{< relref "/develop/data-types/timeseries" >}}) -- [Probabilistic data structures quick start]({{< relref "/develop/data-types/probabilistic/" >}}) +- [Redis Search quick start](/content/develop/get-started/search-tutorial/_index.md) +- [JSON quick start](/content/develop/data-types/json/_index.md#use-redisjson) +- [Time series quick start](/content/develop/data-types/timeseries/_index.md) +- [Probabilistic data structures quick start](/content/develop/data-types/probabilistic/_index.md) diff --git a/content/operate/oss_and_stack/stack-with-enterprise/timeseries/_index.md b/content/operate/oss_and_stack/stack-with-enterprise/timeseries/_index.md index b54535a243..23f6e25b90 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/timeseries/_index.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/timeseries/_index.md @@ -30,7 +30,7 @@ Each sample is a tuple of the time and the value of 128 bits, ## Time series capabilities -Redis Open Source provides a new data type that uses chunks of memory of fixed size for time series samples, indexed by the same Radix Tree implementation as Redis streams. With streams, you can create [a capped stream]({{< relref "/develop/data-types/streams/#capped-streams" >}}), effectively limiting the number of messages by count. For time series, you can apply a retention policy in milliseconds. This is better for time series use cases, because they are typically interested in the data during a given time window, rather than a fixed number of samples. +Redis Open Source provides a new data type that uses chunks of memory of fixed size for time series samples, indexed by the same Radix Tree implementation as Redis streams. With streams, you can create [a capped stream](/content/develop/data-types/streams/_index.md#capped-streams), effectively limiting the number of messages by count. For time series, you can apply a retention policy in milliseconds. This is better for time series use cases, because they are typically interested in the data during a given time window, rather than a fixed number of samples. ### Downsampling/compaction @@ -38,13 +38,13 @@ Redis Open Source provides a new data type that uses chunks of memory of fixed s | --- | --- | | {{< image filename="/images/rs/TimeSeries-downsampling1.png" >}} | {{< image filename="/images/rs/TimeSeries-downsampling2.png" >}} | -If you want to keep all of your raw data points indefinitely, your data set grows linearly over time. However, if your use case allows you to have less fine-grained data further back in time, downsampling can be applied. This allows you to keep fewer historical data points by aggregating raw data for a given time window using a given aggregation function. Time series support [downsampling]({{< relref "develop/data-types/timeseries#aggregation" >}}) with the following aggregations: avg, sum, min, max, range, count, first, and last. +If you want to keep all of your raw data points indefinitely, your data set grows linearly over time. However, if your use case allows you to have less fine-grained data further back in time, downsampling can be applied. This allows you to keep fewer historical data points by aggregating raw data for a given time window using a given aggregation function. Time series support [downsampling](/content/develop/data-types/timeseries/_index.md#aggregation) with the following aggregations: avg, sum, min, max, range, count, first, and last. ### Secondary indexing When using Redis’ core data structures, you can only retrieve a time series by knowing the exact key holding the time series. Unfortunately, for many time series use cases (such as root cause analysis or monitoring), your application won’t know the exact key it’s looking for. These use cases typically want to query a set of time series that relate to each other in a couple of dimensions to extract the insight you need. You could create your own secondary index with core Redis data structures to help with this, but it would come with a high development cost and require you to manage edge cases to make sure the index is correct. -Redis does this indexing for you based on `field value` pairs called [labels]({{< relref "develop/data-types/timeseries#create-a-time-series" >}}). You can add labels to each time series and use them to [filter]({{< relref "develop/data-types/timeseries#query-data-points" >}}) at query time. +Redis does this indexing for you based on `field value` pairs called [labels](/content/develop/data-types/timeseries/_index.md#create-a-time-series). You can add labels to each time series and use them to [filter](/content/develop/data-types/timeseries/_index.md#query-data-points) at query time. Here’s an example of creating a time series with two labels (sensor_id and area_id are the fields with values 2 and 32 respectively) and a retention window of 60,000 milliseconds: @@ -56,7 +56,7 @@ Here’s an example of creating a time series with two labels (sensor_id and are When you need to query a time series, it’s cumbersome to stream all raw data points if you’re only interested in, say, an average over a given time interval. Time series only transfer the minimum required data to ensure lowest latency. -Here's an example of [aggregation]({{< relref "develop/data-types/timeseries#aggregation" >}}) over time buckets of 5,000 milliseconds: +Here's an example of [aggregation](/content/develop/data-types/timeseries/_index.md#aggregation) over time buckets of 5,000 milliseconds: ```sh 127.0.0.1:12543> TS.RANGE temperature:3:32 1548149180000 1548149210000 AGGREGATION avg 5000 @@ -106,7 +106,7 @@ Each time series holds a single metric. We chose this design to maintain the Red {{< image filename="/images/rs/TimeSeries-modeling4.png" >}} -Our benchmark did not utilize the out-of-the-box secondary indexing capabilities of time series. Redis keeps a partial secondary index in each shard, and since the index inherits the same hash-slot of the key it indexes, it is always hosted on the same shard. This approach would make the setup for native data structures even more complex to model, so for the sake of simplicity, we decided not to include it in our benchmarks. Additionally, while Redis Software can use the [proxy](https://redis.com/redis-enterprise/technology/redis-enterprise-cluster-architecture/) to fan out requests for commands like [TS.MGET]({{< relref "commands/ts.mget" >}}) and [TS.MRANGE]({{< relref "commands/ts.mrange" >}}) to all the shards and aggregate the results, we chose not to exploit this advantage in the benchmark either. +Our benchmark did not utilize the out-of-the-box secondary indexing capabilities of time series. Redis keeps a partial secondary index in each shard, and since the index inherits the same hash-slot of the key it indexes, it is always hosted on the same shard. This approach would make the setup for native data structures even more complex to model, so for the sake of simplicity, we decided not to include it in our benchmarks. Additionally, while Redis Software can use the [proxy](https://redis.com/redis-enterprise/technology/redis-enterprise-cluster-architecture/) to fan out requests for commands like [TS.MGET](/content/commands/ts.mget.md) and [TS.MRANGE](/content/commands/ts.mrange.md) to all the shards and aggregate the results, we chose not to exploit this advantage in the benchmark either. ### Data ingestion @@ -151,7 +151,7 @@ Time series can dramatically reduce the memory consumption when compared against ## More info -- [Time series quick start]({{< relref "/develop/data-types/timeseries" >}}) -- [Time series commands]({{< relref "/operate/oss_and_stack/stack-with-enterprise/timeseries/commands" >}}) -- [Time series configuration]({{< relref "/operate/oss_and_stack/stack-with-enterprise/timeseries/config" >}}) +- [Time series quick start](/content/develop/data-types/timeseries/_index.md) +- [Time series commands](/content/operate/oss_and_stack/stack-with-enterprise/timeseries/commands.md) +- [Time series configuration](/content/operate/oss_and_stack/stack-with-enterprise/timeseries/config.md) - [RedisTimeSeries source](https://github.com/RedisTimeSeries/RedisTimeSeries) diff --git a/content/operate/oss_and_stack/stack-with-enterprise/timeseries/commands.md b/content/operate/oss_and_stack/stack-with-enterprise/timeseries/commands.md index 8179c438aa..4420c87c28 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/timeseries/commands.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/timeseries/commands.md @@ -16,24 +16,24 @@ The following table lists time series commands. See the command links for more i | Command | Redis
Software | Redis
Cloud | Description | |:--------|:----------------------|:-----------------|:------| -| [TS.ADD]({{< relref "commands/ts.add" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Appends a sample to a time series. | -| [TS.ALTER]({{< relref "commands/ts.alter" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Updates the retention, chunk size, duplicate policy, or labels for an existing time series. | -| [TS.CREATE]({{< relref "commands/ts.create" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Creates a new time series. | -| [TS.CREATERULE]({{< relref "commands/ts.createrule" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Creates a compaction rule for [downsampling]({{< relref "develop/data-types/timeseries#aggregation" >}}). | -| [TS.DECRBY]({{< relref "commands/ts.decrby" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Decreases the value of the latest sample in a time series by the specified number. Either modifies the existing sample or adds the decreased value as a new sample, depending on the timestamp option. | -| [TS.DEL]({{< relref "commands/ts.del" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Removes all samples between two timestamps for a given time series. | -| [TS.DELETERULE]({{< relref "commands/ts.deleterule" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Removes a compaction rule. | -| [TS.GET]({{< relref "commands/ts.get" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the last sample in a time series. | -| [TS.INCRBY]({{< relref "commands/ts.incrby" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Increases the value of the latest sample in a time series by the specified number. Either modifies the existing sample or adds the increased value as a new sample, depending on the timestamp option. | -| [TS.INFO]({{< relref "commands/ts.info" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns time series information and statistics. | -| [TS.MADD]({{< relref "commands/ts.madd" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Appends multiple samples to one or more time series. | -| [TS.MGET]({{< relref "commands/ts.mget" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns multiple samples with [labels]({{< relref "develop/data-types/timeseries#create-a-time-series" >}}) that match the filter. | -| [TS.MRANGE]({{< relref "commands/ts.mrange" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | For multiple time series, runs a query against samples within a range of timestamps, from earliest to latest. Supports [filtering]({{< relref "/develop/data-types/timeseries#query-data-points" >}}) and [aggregation]({{< relref "/develop/data-types/timeseries#aggregation" >}}). | -| [TS.MREVRANGE]({{< relref "commands/ts.mrevrange" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | For multiple time series, runs a query against samples within a range of timestamps in reverse order, from latest to earliest. Supports [filtering]({{< relref "/develop/data-types/timeseries#query-data-points" >}}) and [aggregation]({{< relref "/develop/data-types/timeseries#aggregation" >}}). | -| [TS.NRANGE]({{< relref "commands/ts.nrange" >}}) | ❌ Not supported

 | ❌ Flexible & Annual
❌ Free & Fixed | Query a range across multiple time series in forward direction, returning the results grouped by timestamp. | -| [TS.NREVRANGE]({{< relref "commands/ts.nrevrange" >}}) | ❌ Not supported

 | ❌ Flexible & Annual
❌ Free & Fixed | Query a range across multiple time series in reverse direction, returning the results grouped by timestamp. | -| [TS.QUERYINDEX]({{< relref "commands/ts.queryindex" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the keys of all time series with [labels]({{< relref "/develop/data-types/timeseries#create-a-time-series" >}}) that match the given filters. | -| [TS.QUERYLABELS]({{< relref "commands/ts.querylabels" >}}) | ❌ Not supported

 | ❌ Flexible & Annual
❌ Free & Fixed | Returns all label names, or all values of a given label, for time series matching a filter list, or all series. | -| [TS.READ]({{< relref "commands/ts.read" >}}) | ❌ Not supported

 | ❌ Flexible & Annual
❌ Free & Fixed | Read a batch of time series samples at or after a given timestamp, returning up to `max_count` of the oldest qualifying samples ordered by increasing timestamp. By default `TS.READ` returns immediately with whatever is available; add the optional `BLOCK` keyword to wait until at least `min_count` samples exist or `milliseconds` elapse, whichever occurs first. | -| [TS.RANGE]({{< relref "commands/ts.range" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | From the start of a single time series, runs a query against samples within a range of timestamps. Supports [filtering]({{< relref "/develop/data-types/timeseries#query-data-points" >}}) and [aggregation]({{< relref "/develop/data-types/timeseries#aggregation" >}}). | -| [TS.REVRANGE]({{< relref "commands/ts.revrange" >}}) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | From the end of a single time series, runs a query against samples within a range of timestamps in reverse order. Supports [filtering]({{< relref "/develop/data-types/timeseries#query-data-points" >}}) and [aggregation]({{< relref "/develop/data-types/timeseries#aggregation" >}}). | +| [TS.ADD](/content/commands/ts.add.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Appends a sample to a time series. | +| [TS.ALTER](/content/commands/ts.alter.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Updates the retention, chunk size, duplicate policy, or labels for an existing time series. | +| [TS.CREATE](/content/commands/ts.create.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Creates a new time series. | +| [TS.CREATERULE](/content/commands/ts.createrule.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Creates a compaction rule for [downsampling](/content/develop/data-types/timeseries/_index.md#aggregation). | +| [TS.DECRBY](/content/commands/ts.decrby.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Decreases the value of the latest sample in a time series by the specified number. Either modifies the existing sample or adds the decreased value as a new sample, depending on the timestamp option. | +| [TS.DEL](/content/commands/ts.del.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Removes all samples between two timestamps for a given time series. | +| [TS.DELETERULE](/content/commands/ts.deleterule.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Removes a compaction rule. | +| [TS.GET](/content/commands/ts.get.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the last sample in a time series. | +| [TS.INCRBY](/content/commands/ts.incrby.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Increases the value of the latest sample in a time series by the specified number. Either modifies the existing sample or adds the increased value as a new sample, depending on the timestamp option. | +| [TS.INFO](/content/commands/ts.info.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns time series information and statistics. | +| [TS.MADD](/content/commands/ts.madd.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Appends multiple samples to one or more time series. | +| [TS.MGET](/content/commands/ts.mget.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns multiple samples with [labels](/content/develop/data-types/timeseries/_index.md#create-a-time-series) that match the filter. | +| [TS.MRANGE](/content/commands/ts.mrange.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | For multiple time series, runs a query against samples within a range of timestamps, from earliest to latest. Supports [filtering](/content/develop/data-types/timeseries/_index.md#query-data-points) and [aggregation](/content/develop/data-types/timeseries/_index.md#aggregation). | +| [TS.MREVRANGE](/content/commands/ts.mrevrange.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | For multiple time series, runs a query against samples within a range of timestamps in reverse order, from latest to earliest. Supports [filtering](/content/develop/data-types/timeseries/_index.md#query-data-points) and [aggregation](/content/develop/data-types/timeseries/_index.md#aggregation). | +| [TS.NRANGE](/content/commands/ts.nrange.md) | ❌ Not supported

 | ❌ Flexible & Annual
❌ Free & Fixed | Query a range across multiple time series in forward direction, returning the results grouped by timestamp. | +| [TS.NREVRANGE](/content/commands/ts.nrevrange.md) | ❌ Not supported

 | ❌ Flexible & Annual
❌ Free & Fixed | Query a range across multiple time series in reverse direction, returning the results grouped by timestamp. | +| [TS.QUERYINDEX](/content/commands/ts.queryindex.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | Returns the keys of all time series with [labels](/content/develop/data-types/timeseries/_index.md#create-a-time-series) that match the given filters. | +| [TS.QUERYLABELS](/content/commands/ts.querylabels.md) | ❌ Not supported

 | ❌ Flexible & Annual
❌ Free & Fixed | Returns all label names, or all values of a given label, for time series matching a filter list, or all series. | +| [TS.READ](/content/commands/ts.read.md) | ❌ Not supported

 | ❌ Flexible & Annual
❌ Free & Fixed | Read a batch of time series samples at or after a given timestamp, returning up to `max_count` of the oldest qualifying samples ordered by increasing timestamp. By default `TS.READ` returns immediately with whatever is available; add the optional `BLOCK` keyword to wait until at least `min_count` samples exist or `milliseconds` elapse, whichever occurs first. | +| [TS.RANGE](/content/commands/ts.range.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | From the start of a single time series, runs a query against samples within a range of timestamps. Supports [filtering](/content/develop/data-types/timeseries/_index.md#query-data-points) and [aggregation](/content/develop/data-types/timeseries/_index.md#aggregation). | +| [TS.REVRANGE](/content/commands/ts.revrange.md) | ✅ Supported

 | ✅ Flexible & Annual
✅ Free & Fixed | From the end of a single time series, runs a query against samples within a range of timestamps in reverse order. Supports [filtering](/content/develop/data-types/timeseries/_index.md#query-data-points) and [aggregation](/content/develop/data-types/timeseries/_index.md#aggregation). | diff --git a/content/operate/oss_and_stack/stack-with-enterprise/timeseries/config.md b/content/operate/oss_and_stack/stack-with-enterprise/timeseries/config.md index 83422b4602..32f306b02c 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/timeseries/config.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/timeseries/config.md @@ -13,7 +13,7 @@ weight: 30 ## Configure time series in Redis Software -[Redis Software]({{< relref "/operate/rs" >}}) lets you manually change any [RedisTimeSeries configuration setting]({{< relref "/develop/data-types/timeseries/" >}}configuration/#redistimeseries-configuration-parameters). +[Redis Software](/content/operate/rs/_index.md) lets you manually change any [RedisTimeSeries configuration setting](/content/develop/data-types/timeseries/configuration.md#redistimeseries-configuration-parameters). To change RedisTimeSeries configuration using the Redis Software Cluster Manager UI: @@ -29,8 +29,8 @@ To change RedisTimeSeries configuration using the Redis Software Cluster Manager ## Configure time series in Redis Cloud -[Redis Cloud]({{< relref "/operate/rc" >}}) does not let you configure RedisTimeSeries manually. However, if you have a Flexible or Annual [subscription]({{< relref "/operate/rc/subscriptions" >}}), you can contact [support](https://redis.com/company/support/) to request a configuration change. You cannot change RedisTimeSeries configuration for Free or Fixed subscriptions. +[Redis Cloud](/content/operate/rc/_index.md) does not let you configure RedisTimeSeries manually. However, if you have a Flexible or Annual [subscription](/content/operate/rc/subscriptions/_index.md), you can contact [support](https://redis.com/company/support/) to request a configuration change. You cannot change RedisTimeSeries configuration for Free or Fixed subscriptions. ## Configuration settings -See [configuration parameters]({{< relref "/develop/data-types/timeseries/configuration" >}}) in the Develop section for parameter details and compatibility with Redis Software and Redis Cloud. +See [configuration parameters](/content/develop/data-types/timeseries/configuration.md) in the Develop section for parameter details and compatibility with Redis Software and Redis Cloud.