diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/_index.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/_index.md index bec728de07..6a2a6b6632 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/_index.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/_index.md @@ -21,7 +21,7 @@ RedisGears is an engine for data processing in Redis. RedisGears supports batch ## Supported languages -As of RedisGears v1.2, you can enable a plugin to select which programming language to use. It currently supports code written in either [Python]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python" >}}) or [Java]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm" >}}). +As of RedisGears v1.2, you can enable a plugin to select which programming language to use. It currently supports code written in either [Python](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/_index.md) or [Java](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/_index.md). Prior to v1.2, RedisGears only supported Python. However, an internal C API exists and can be used by other Redis modules. Support for other languages is being planned. @@ -29,15 +29,15 @@ Prior to v1.2, RedisGears only supported Python. However, an internal C API exis RedisGears is implemented by a Redis module. To use RedisGears, you'll need to make sure that your Redis deployment has the module installed. [Redis Software](https://redis.io/docs/latest/operate/rs/) supports the module natively. -If you're running Redis Open Source, you'll also need to [install the RedisGears module]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears" >}}) before using it. +If you're running Redis Open Source, you'll also need to [install the RedisGears module](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears.md) before using it. -To get started with RedisGears, see the quick start tutorial for [Python]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/quickstart" >}}) or [Java]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/quickstart" >}}). +To get started with RedisGears, see the quick start tutorial for [Python](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/quickstart.md) or [Java](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/quickstart.md). ## Write-behind caching patterns Redis users typically implement caching by using the look-aside pattern. However, with RedisGears, you can implement write-behind caching strategies as well. -Redis publishes RedisGears recipes to support write-behind. You can learn how to use these recipes in our write-behind caching guides for [Python]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/recipes/write-behind" >}}) and [Java]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/recipes/write-behind" >}}). +Redis publishes RedisGears recipes to support write-behind. You can learn how to use these recipes in our write-behind caching guides for [Python](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/recipes/write-behind.md) and [Java](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/recipes/write-behind.md). ## More info diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears.md index 4be5d4348a..28332cd4a3 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears.md @@ -18,7 +18,7 @@ Before you can use RedisGears, you have to install the RedisGears module on your ## Minimum requirements - Redis Software 6.0.12 or later -- The [cluster is setup]({{< relref "/operate/rs/clusters/new-cluster-setup" >}}) and all of the nodes are joined to the cluster +- The [cluster is setup](/content/operate/rs/clusters/new-cluster-setup.md) and all of the nodes are joined to the cluster ## Install RedisGears @@ -30,19 +30,19 @@ Offline installation requires you to manually upload dependencies to the primary 1. Download the **RedisGears** package from the Redis Software [download center](https://cloud.redis.io/#/rlec-downloads). - {{}} -For offline installation of RedisGears v1.2 and later, you also need to download the **RedisGears Dependencies** packages for both Python and Java. -
-For RedisGears v1.0, you only need the Python dependency package. - {{}} + > [!NOTE] + > For offline installation of RedisGears v1.2 and later, you also need to download the **RedisGears Dependencies** packages for both Python and Java. + >
+ > For RedisGears v1.0, you only need the Python dependency package. + > 1. Upload the RedisGears package to a node in the cluster. 1. For offline installation only, copy the dependencies to the primary node. - {{}} -Skip this step unless your cluster does not have internet access. - {{}} + > [!NOTE] + > Skip this step unless your cluster does not have internet access. + > 1. For versions 7.2.4 and later, copy the dependencies to `$modulesdatadir/rg////deps/`: @@ -67,7 +67,7 @@ Skip this step unless your cluster does not have internet access. - ``: the operating system's name - ``: the node's architecture -1. Add RedisGears to the cluster with a `POST` request to the primary node's [`/v2/modules`]({{< relref "/operate/rs/references/rest-api/requests/modules#post-module-v2" >}}) REST API endpoint: +1. Add RedisGears to the cluster with a `POST` request to the primary node's [`/v2/modules`](/content/operate/rs/references/rest-api/requests/modules/_index.md#post-module-v2) REST API endpoint: ```sh POST https://[host][:port]/v2/modules @@ -82,13 +82,13 @@ After the install is complete, RedisGears will appear in the list of available m After installation, create a new database and enable RedisGears: -- [With Python]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/install" >}}) +- [With Python](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/install.md) -- [With the JVM]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/install" >}}) +- [With the JVM](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/install.md) ## Upgrade RedisGears for existing databases -To upgrade RedisGears for an existing database after installing a new version, use [`rladmin upgrade db`]({{}}): +To upgrade RedisGears for an existing database after installing a new version, use [`rladmin upgrade db`](/content/operate/rs/references/cli-utilities/rladmin/upgrade.md#upgrade-db): ```sh rladmin upgrade db and module module_name rg version module_args "" @@ -100,10 +100,9 @@ The following example shows how to upgrade a database named `shopping-cart` to R rladmin upgrade db shopping-cart and module module_name rg version 10209 module_args keep_args ``` -{{}} -These command examples also upgrade the database to the latest Redis version on the cluster. For more module upgrade information and examples, see [Upgrade modules]({{}}). -{{}} +> [!NOTE] +> These command examples also upgrade the database to the latest Redis version on the cluster. For more module upgrade information and examples, see [Upgrade modules](/content/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module.md). ## Uninstall RedisGears -To uninstall RedisGears, make a [`DELETE` request to the `/v2/modules` REST API endpoint]({{< relref "/operate/rs/references/rest-api/requests/modules#delete-module-v2" >}}). +To uninstall RedisGears, make a [`DELETE` request to the `/v2/modules` REST API endpoint](/content/operate/rs/references/rest-api/requests/modules/_index.md#delete-module-v2). diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/_index.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/_index.md index fa490314a4..9209889c47 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/_index.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/_index.md @@ -17,16 +17,16 @@ bannerText: Redis Gears is a deprecated feature that is not recommended or suppo bannerChildren: true --- -With the [RedisGears JVM plugin](https://github.com/RedisGears/JVMPlugin), you can write RedisGears functions in [Java](https://en.wikipedia.org/wiki/Java_(programming_language)) and run them on a [Redis Software]({{< relref "/operate/rs/" >}}) cluster. It currently supports [JVM](https://en.wikipedia.org/wiki/Java_virtual_machine) version 11. +With the [RedisGears JVM plugin](https://github.com/RedisGears/JVMPlugin), you can write RedisGears functions in [Java](https://en.wikipedia.org/wiki/Java_(programming_language)) and run them on a [Redis Software](/content/operate/rs/_index.md) cluster. It currently supports [JVM](https://en.wikipedia.org/wiki/Java_virtual_machine) version 11. Similar to the Python plugin, the JVM plugin allows both batch processing and event-driven processing. -Before you can run RedisGears with Java, you will need to [install the RedisGears module and the JVM plugin]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears#install-redisgears" >}}) on your Redis Software cluster and [enable them for your database]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/install" >}}). +Before you can run RedisGears with Java, you will need to [install the RedisGears module and the JVM plugin](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears.md#install-redisgears) on your Redis Software cluster and [enable them for your database](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/install.md). Once you have written your code, compile and package it into a [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) file and upload it to a node on your Redis Software cluster. Use the `RG.JEXECUTE` command with the `redis-cli` command-line tool to run your code. ## More info -- [RedisGears JVM quick start]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/quickstart" >}}) -- [RedisGears Java classes and functions]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes" >}}) -- [RedisGears recipes]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/recipes" >}}) \ No newline at end of file +- [RedisGears JVM quick start](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/quickstart.md) +- [RedisGears Java classes and functions](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/_index.md) +- [RedisGears recipes](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/recipes/_index.md) \ No newline at end of file diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncfilter.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncfilter.md index 0994ea73b9..00034215ed 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncfilter.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncfilter.md @@ -19,7 +19,7 @@ public GearsBuilder asyncFilter​( gears.operations.AsyncFilterOperation filter) ``` -The `asyncFilter` function allows you to use a [`GearsFuture`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsfuture" >}}) object to asynchronously filter out records in the pipe based on a given condition. +The `asyncFilter` function allows you to use a [`GearsFuture`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsfuture/_index.md) object to asynchronously filter out records in the pipe based on a given condition. The filter operation should contain a conditional statement and return a boolean for each record: - If `true`, the record will continue through the pipe. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncforeach.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncforeach.md index 5237f6d3a7..09853db558 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncforeach.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncforeach.md @@ -19,7 +19,7 @@ public GearsBuilder asyncForeach​( gears.operations.AsyncForeachOperation foreach) ``` -The `asyncForeach` function allows you to use a [`GearsFuture`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsfuture" >}}) object to define a set of operations and run them asynchronously for each record in the pipe. +The `asyncForeach` function allows you to use a [`GearsFuture`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsfuture/_index.md) object to define a set of operations and run them asynchronously for each record in the pipe. ## Parameters diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncmap.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncmap.md index 51b9c55c87..8ef85f6aa2 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncmap.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncmap.md @@ -19,7 +19,7 @@ public GearsBuilder asyncMap​( gears.operations.AsyncMapOperation mapper) ``` -The `asyncMap` function allows you to use a [`GearsFuture`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsfuture" >}}) object to asynchronously map each input record in the pipe to an output record, one-to-one. +The `asyncMap` function allows you to use a [`GearsFuture`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsfuture/_index.md) object to asynchronously map each input record in the pipe to an output record, one-to-one. ## Parameters diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/callnext.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/callnext.md index 0108982ef8..9510fe2c27 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/callnext.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/callnext.md @@ -19,9 +19,9 @@ bannerText: Redis Gears is a deprecated feature that is not recommended or suppo public static java.lang.Object callNext(java.lang.String... args) ``` -When you override a Redis command with the [`CommandOverrider`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandoverrider" >}}), use `callNext` to run the next execution that overrides the command or the original command itself. +When you override a Redis command with the [`CommandOverrider`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandoverrider.md), use `callNext` to run the next execution that overrides the command or the original command itself. -It is a more flexible version of [`callNextArray`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/callNextArray" >}}) since the list of string arguments does not have to be an explicit `String[]` object. This allows function calls like: `callNext("key", "value")`. +It is a more flexible version of [`callNextArray`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/callnextarray.md) since the list of string arguments does not have to be an explicit `String[]` object. This allows function calls like: `callNext("key", "value")`. ## Parameters diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/callnextarray.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/callnextarray.md index a46d1b40ff..12d88dd9eb 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/callnextarray.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/callnextarray.md @@ -20,7 +20,7 @@ public static native java.lang.Object callNextArray( java.lang.String[] command) ``` -When you override a Redis command with the [`CommandOverrider`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandoverrider" >}}), use `callNextArray` to run the next execution that overrides the command or the original command itself. +When you override a Redis command with the [`CommandOverrider`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandoverrider.md), use `callNextArray` to run the next execution that overrides the command or the original command itself. It accepts an array of strings, which represents the command arguments. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/config-get.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/config-get.md index 48b36efe38..666bfde99e 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/config-get.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/config-get.md @@ -18,11 +18,10 @@ bannerText: Redis Gears is a deprecated feature that is not recommended or suppo public static java.lang.String configGet​(java.lang.String key) ``` -Gets the value of a RedisGears [configuration setting]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Configuration" >}}). +Gets the value of a RedisGears [configuration setting](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Configuration.md). -{{}} -You can set configuration values when you load the module or use the `RG.CONFIGSET` command. -{{}} +> [!NOTE] +> You can set configuration values when you load the module or use the `RG.CONFIGSET` command. ## Parameters diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/execute.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/execute.md index ec3b15d23f..9278e2ee0d 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/execute.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/execute.md @@ -18,7 +18,7 @@ bannerText: Redis Gears is a deprecated feature that is not recommended or suppo public static java.lang.Object execute​(java.lang.String... command) ``` -Runs a Redis command, similar to [`executeArray`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/executeArray" >}}). However, the `execute` function is more flexible. Unlike `executeArray`, the list of string arguments does not have to be an explicit `String[]` object. It allows function calls like this: `execute("SET", "key", "value")`. +Runs a Redis command, similar to [`executeArray`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/executearray.md). However, the `execute` function is more flexible. Unlike `executeArray`, the list of string arguments does not have to be an explicit `String[]` object. It allows function calls like this: `execute("SET", "key", "value")`. ## Parameters diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/hashtag.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/hashtag.md index cace059c41..d48e2b7e35 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/hashtag.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/hashtag.md @@ -20,9 +20,8 @@ public static java.lang.String hashtag() Returns a string that maps to the current shard according to the cluster slot mapping. -{{}} -You can use the `hashtag` function when you need to create a key that resides on the current shard. -{{}} +> [!NOTE] +> You can use the `hashtag` function when you need to create a key that resides on the current shard. ## Parameters diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/localaccumulateby.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/localaccumulateby.md index f29639cced..f136dabfa2 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/localaccumulateby.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/localaccumulateby.md @@ -21,7 +21,7 @@ public GearsBuilder localAccumulateBy​( gears.operations.AccumulateByOperation accumulator) ``` -The `localAccumulateBy` function is similar to [`accumulateBy`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/accumulateby" >}}), except it performs the operation locally on each shard without moving data between shards. +The `localAccumulateBy` function is similar to [`accumulateBy`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/accumulateby.md), except it performs the operation locally on each shard without moving data between shards. On each shard, it iterates through the records in the pipe, groups them based on the provided extractor, and then reduces each group to a single record per group with the accumulator function. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register.md index 1e37f1960b..e794026fc3 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register.md @@ -25,7 +25,7 @@ public java.lang.String register​( gears.operations.OnUnregisteredOperation onUnregistered) ``` -Registers the pipeline of functions to run when certain [events]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/register-events" >}}) occur. The registered functions will run each time the event occurs. +Registers the pipeline of functions to run when certain [events](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/register-events.md) occur. The registered functions will run each time the event occurs. Execution modes: @@ -35,9 +35,8 @@ Execution modes: | ASYNC_LOCAL | Runs asynchronously but only on the current shard that generated the event. | | SYNC | Runs synchronously only on the same shard that generated the event. | -{{}} -If you call `register()` without specifying an execution mode, it will default to `ASYNC`. -{{}} +> [!NOTE] +> If you call `register()` without specifying an execution mode, it will default to `ASYNC`. ## Parameters diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsfuture/_index.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsfuture/_index.md index d245c4b75b..22af0ddada 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsfuture/_index.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsfuture/_index.md @@ -18,11 +18,11 @@ bannerChildren: true The `GearsFuture` class allows asynchronous processing of records in another thread. -You can use a `GearsFuture` object with the following [`GearsBuilder`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder" >}}) functions: +You can use a `GearsFuture` object with the following [`GearsBuilder`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/_index.md) functions: -- [`asyncFilter`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncfilter" >}}) -- [`asyncForeach`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncforeach" >}}) -- [`asyncMap`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncmap" >}}) +- [`asyncFilter`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncfilter.md) +- [`asyncForeach`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncforeach.md) +- [`asyncMap`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/asyncmap.md) ## Functions diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/_index.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/_index.md index 7fe617c401..e36c561473 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/_index.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/_index.md @@ -19,7 +19,7 @@ bannerChildren: true A reader extracts data from the database and creates records. -The [`GearsBuilder.CreateGearsBuilder(reader)`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/creategearsbuilder" >}}) function takes a reader as a parameter and passes the generated records through a pipeline of RedisGears functions. +The [`GearsBuilder.CreateGearsBuilder(reader)`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/creategearsbuilder.md) function takes a reader as a parameter and passes the generated records through a pipeline of RedisGears functions. ## Classes diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandoverrider.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandoverrider.md index 9445050f15..578d68cfe3 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandoverrider.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandoverrider.md @@ -16,13 +16,12 @@ bannerText: Redis Gears is a deprecated feature that is not recommended or suppo The `CommandOverrider` allows you to override and customize Redis commands. -1. Pass the `CommandOverrider` to the [`GearsBuilder.CreateGearsBuilder()`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/creategearsbuilder" >}}) function in your Java code. -1. Call the [`register()`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register" >}}) function. +1. Pass the `CommandOverrider` to the [`GearsBuilder.CreateGearsBuilder()`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/creategearsbuilder.md) function in your Java code. +1. Call the [`register()`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register.md) function. 1. Run `RG.JEXECUTE` to register your code. -{{}} -If you register code that uses `CommandOverrider`, its `reader` value is `"CommandReader"` when you run the `RG.DUMPREGISTRATIONS` command, not `"CommandOverrider"`. -{{}} +> [!NOTE] +> If you register code that uses `CommandOverrider`, its `reader` value is `"CommandReader"` when you run the `RG.DUMPREGISTRATIONS` command, not `"CommandOverrider"`. ## Parameters diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandreader.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandreader.md index ad49e03ba0..3450bfedaa 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandreader.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/commandreader.md @@ -16,8 +16,8 @@ bannerText: Redis Gears is a deprecated feature that is not recommended or suppo The `CommandReader` allows you to run RedisGears functions on command when you: -1. Pass the `CommandReader` to the [`GearsBuilder.CreateGearsBuilder()`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/creategearsbuilder" >}}) function in your Java code. -1. Call the [`register()`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register" >}}) function. +1. Pass the `CommandReader` to the [`GearsBuilder.CreateGearsBuilder()`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/creategearsbuilder.md) function in your Java code. +1. Call the [`register()`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register.md) function. 1. Run `RG.JEXECUTE` to register your code. 1. Use `RG.TRIGGER` to run your code on command: diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/javareader.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/javareader.md index d8c7c6ba7d..f0d15f26ec 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/javareader.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/javareader.md @@ -25,7 +25,7 @@ To create a custom reader: ## Custom reader example -The implementation of the [`KeysOnlyReader`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/keysonlyreader" >}}) class shows how to create a custom reader with `JavaReader`: +The implementation of the [`KeysOnlyReader`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/keysonlyreader.md) class shows how to create a custom reader with `JavaReader`: ```java import java.util.Iterator; diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/keysreader.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/keysreader.md index 3d180c6bae..557597bcd9 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/keysreader.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/keysreader.md @@ -16,9 +16,8 @@ bannerText: Redis Gears is a deprecated feature that is not recommended or suppo Creates records from the keys and values stored in a Redis database. -{{}} - Currently only supports string and hash data types. For other data types, it will only extract the key name. -{{}} +> [!NOTE] +> Currently only supports string and hash data types. For other data types, it will only extract the key name. ## Constructors @@ -50,7 +49,7 @@ public KeysReader(String pattern, | Name | Type | Default value | Description | |------|------|---------------|-------------| | commands | array of strings | null | The commands that this reader is registered on | -| eventTypes | array of strings | null | The [event types]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/register-events#event-types" >}}) to register on (usually the command name) | +| eventTypes | array of strings | null | The [event types](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/register-events.md#event-types) to register on (usually the command name) | | keyTypes | array of strings | null | The key types to register on | | noScan | boolean | false | Whether or not to scan the key space or just read the pattern as is | | pattern/prefix | string | "\*" (match all keys) | The reader will get all keys that match this pattern | diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/commands/_index.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/commands/_index.md index b5b187b567..52d76f925a 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/commands/_index.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/commands/_index.md @@ -23,6 +23,5 @@ Use a Redis client like `redis-cli` to send commands to the RedisGears JVM plugi {{}} -{{}} -Ignore any commands that start with `RG.PY` while using the JVM plugin. The `RG.PY` commands are for the Python plugin. -{{}} \ No newline at end of file +> [!NOTE] +> Ignore any commands that start with `RG.PY` while using the JVM plugin. The `RG.PY` commands are for the Python plugin. \ No newline at end of file diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/commands/rg-jdumpsessions.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/commands/rg-jdumpsessions.md index aa44e1e04b..4f4b1efb16 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/commands/rg-jdumpsessions.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/commands/rg-jdumpsessions.md @@ -20,9 +20,8 @@ RG.JDUMPSESSIONS [VERBOSE] [SESSIONS s1 s2 ...] Outputs information about existing Java sessions. -{{}} -When you run the `RG.JEXECUTE` command, it creates a Java session. -{{}} +> [!NOTE] +> When you run the `RG.JEXECUTE` command, it creates a Java session. ## Arguments diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/commands/rg-jexecute.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/commands/rg-jexecute.md index 23267902c2..19c8a88914 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/commands/rg-jexecute.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/commands/rg-jexecute.md @@ -20,7 +20,7 @@ RG.JEXECUTE [UPGRADE] Executes a Java function. -The code runs immediately if it uses [`GearsBuilder.run()`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/run" >}}). Code that uses [`GearsBuilder.register()`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register" >}}) will run later, every time certain events occur in the database. +The code runs immediately if it uses [`GearsBuilder.run()`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/run.md). Code that uses [`GearsBuilder.register()`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register.md) will run later, every time certain events occur in the database. ## Arguments @@ -33,13 +33,13 @@ The code runs immediately if it uses [`GearsBuilder.run()`]({{< relref "/operate ## Returns -If the executed code calls [`GearsBuilder.run()`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/run" >}}), it returns the output of the executed code. +If the executed code calls [`GearsBuilder.run()`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/run.md), it returns the output of the executed code. For registered code, it returns the string "`OK`" instead. ## Examples -The executed code in this example [runs]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/run" >}}) immediately: +The executed code in this example [runs](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/run.md) immediately: ```sh $ redis-cli -x RG.JEXECUTE com.domain.packagename.Reviews < /tmp/rgjvmtest-0.0.1-SNAPSHOT.jar @@ -47,7 +47,7 @@ $ redis-cli -x RG.JEXECUTE com.domain.packagename.Reviews < /tmp/rgjvmtest-0.0.1 2) (empty array) ``` -This example [registers]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register" >}}) the RedisGears code to run every time certain database events occur: +This example [registers](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register.md) the RedisGears code to run every time certain database events occur: ```sh $ redis-cli -x RG.JEXECUTE com.domain.packagename.App < /tmp/rgjvmtest-0.0.1-SNAPSHOT.jar diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/install.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/install.md index 55ca80e9ba..8974904cfb 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/install.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/install.md @@ -21,11 +21,11 @@ Before you can use RedisGears with the JVM, you need to install the RedisGears m 1. Redis Software v6.0.12 or later -1. [Created a Redis Software cluster]({{< relref "/operate/rs/clusters/new-cluster-setup" >}}) +1. [Created a Redis Software cluster](/content/operate/rs/clusters/new-cluster-setup.md) -1. [Added nodes to the cluster]({{< relref "/operate/rs/clusters/add-node" >}}) +1. [Added nodes to the cluster](/content/operate/rs/clusters/add-node.md) -1. [Installed RedisGears and the JVM plugin]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears#install-redisgears" >}}) +1. [Installed RedisGears and the JVM plugin](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears.md#install-redisgears) ## Enable RedisGears for a database @@ -43,10 +43,10 @@ Before you can use RedisGears with the JVM, you need to install the RedisGears m {{The Save icon}} - {{}} -You can configure additional JVM options in this box. For example:

-`Plugin gears_jvm JvmOptions ``'-Dproperty1=value1` `-Dproperty2=value2'` - {{}} + > [!NOTE] + > You can configure additional JVM options in this box. For example:

+ > `Plugin gears_jvm JvmOptions ``'-Dproperty1=value1` `-Dproperty2=value2'` + > 1. Select the **Activate** button. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/quickstart.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/quickstart.md index 76c21d5e62..9d43f78b67 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/quickstart.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/quickstart.md @@ -18,7 +18,7 @@ bannerText: Redis Gears is a deprecated feature that is not recommended or suppo For this quick start, you need: -- A Redis Software cluster with the [RedisGears module and JVM plugin installed]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears#install-redisgears" >}}) and [enabled on a database]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/install" >}}) +- A Redis Software cluster with the [RedisGears module and JVM plugin installed](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears.md#install-redisgears) and [enabled on a database](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/install.md) - `redis-cli` with connectivity to a Redis database ## Tutorial @@ -70,11 +70,10 @@ Use the `RG.JEXECUTE` command to run your code: $ redis-cli -x -h {host} -p {port} RG.JEXECUTE {package.MainClass} < {filepath}/{JAR name}.jar ``` -{{}} -When you use [`GearsBuilder.run()`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/run" >}}), `RG.JEXECUTE` runs your code immediately. -

-However, if you use [`GearsBuilder.register()`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register" >}}), `RG.JEXECUTE` only outputs an `OK` message if it registers successfully. Your registered code will run whenever certain database events occur. -{{}} +> [!NOTE] +> When you use [`GearsBuilder.run()`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/run.md), `RG.JEXECUTE` runs your code immediately. +>

+> However, if you use [`GearsBuilder.register()`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register.md), `RG.JEXECUTE` only outputs an `OK` message if it registers successfully. Your registered code will run whenever certain database events occur. ## Example code @@ -82,7 +81,7 @@ You can use these code examples with your own Maven project to try out batch pro ### Batch processing -If you use the [`GearsBuilder.run()`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/run" >}}) function within your code, then the functions you add to the pipeline will run exactly once when you use `RG.JEXECUTE` with your JAR file. +If you use the [`GearsBuilder.run()`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/run.md) function within your code, then the functions you add to the pipeline will run exactly once when you use `RG.JEXECUTE` with your JAR file. The following example calculates the average rating of all restaurant reviews stored in your database. @@ -169,7 +168,7 @@ $ redis-cli -x -h {host} -p {port} \ ### Event processing -If you use the [`GearsBuilder.register()`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register" >}}) function in your code, then the functions you add to the pipeline will run every time a certain database event occurs. +If you use the [`GearsBuilder.register()`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register.md) function in your code, then the functions you add to the pipeline will run every time a certain database event occurs. The following example registers a pipeline of functions to automatically update the maximum age every time you add a new person hash to your database. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/_index.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/_index.md index 0c212f4c61..c7b7e2bf42 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/_index.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/_index.md @@ -17,15 +17,15 @@ bannerText: Redis Gears is a deprecated feature that is not recommended or suppo bannerChildren: true --- -With the RedisGears Python plugin, you can write RedisGears functions in [Python](https://www.python.org/) and run them on a [Redis Software]({{< relref "/operate/rs/" >}}) cluster. +With the RedisGears Python plugin, you can write RedisGears functions in [Python](https://www.python.org/) and run them on a [Redis Software](/content/operate/rs/_index.md) cluster. The Python plugin allows both batch processing and event-driven processing. -Before you can run RedisGears with Python, you will need to [install the RedisGears module and the Python plugin]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears#install-redisgears" >}}) on your Redis Software cluster and [enable them for your database]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/install" >}}). +Before you can run RedisGears with Python, you will need to [install the RedisGears module and the Python plugin](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears.md#install-redisgears) on your Redis Software cluster and [enable them for your database](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/install.md). Once you have written your code, upload it to a node on your Redis Software cluster. Use the `RG.PYEXECUTE` command with the `redis-cli` command-line tool to run your code. ## More info -- [RedisGears Python quick start]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/quickstart" >}}) -- [RedisGears recipes]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/recipes" >}}) \ No newline at end of file +- [RedisGears Python quick start](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/quickstart.md) +- [RedisGears recipes](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/recipes/_index.md) \ No newline at end of file diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/install.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/install.md index 0cb4eaa79f..f30b40f366 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/install.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/install.md @@ -21,11 +21,11 @@ Before you can use RedisGears with Python, you need to install the RedisGears mo 1. Redis Software v6.0.12 or later -1. [Created a Redis Software cluster]({{< relref "/operate/rs/clusters/new-cluster-setup" >}}) +1. [Created a Redis Software cluster](/content/operate/rs/clusters/new-cluster-setup.md) -1. [Added nodes to the cluster]({{< relref "/operate/rs/clusters/add-node" >}}) +1. [Added nodes to the cluster](/content/operate/rs/clusters/add-node.md) -1. [Installed RedisGears and the Python plugin]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears#install-redisgears" >}}) +1. [Installed RedisGears and the Python plugin](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears.md#install-redisgears) ## Enable RedisGears for a database @@ -43,9 +43,9 @@ Before you can use RedisGears with Python, you need to install the RedisGears mo {{The Save icon}} - {{}} -Only RedisGears v1.2 and later require this configuration. - {{}} + > [!NOTE] + > Only RedisGears v1.2 and later require this configuration. + > 1. Select the **Activate** button. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/quickstart.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/quickstart.md index 079225970f..42b9ee5940 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/quickstart.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/quickstart.md @@ -16,7 +16,7 @@ bannerText: Redis Gears is a deprecated feature that is not recommended or suppo For this tutorial, you need: - Either: - - A Redis Software cluster with the [RedisGears module and Python plugin installed]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears#install-redisgears" >}}) and [enabled on a database]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/install" >}}) + - A Redis Software cluster with the [RedisGears module and Python plugin installed](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears.md#install-redisgears) and [enabled on a database](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/install.md) - A Redis Open Source database with the RedisGears module - `redis-cli` with connectivity to a Redis database @@ -143,4 +143,4 @@ redis.cloud:6379> GET age:maximum ## Next steps -You should now have a basic idea of how to run RedisGears functions for batch and event processing. If you're interested in write-behind caching, see our [write-behind caching]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/recipes/write-behind" >}}) overview. +You should now have a basic idea of how to run RedisGears functions for batch and event processing. If you're interested in write-behind caching, see our [write-behind caching](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/recipes/write-behind.md) overview. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/recipes/write-behind.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/recipes/write-behind.md index 2a23914759..da491f2ab2 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/recipes/write-behind.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/recipes/write-behind.md @@ -15,7 +15,7 @@ bannerText: Redis Gears is a deprecated feature that is not recommended or suppo for new users. --- -Write-behind is a caching strategy in which the cache layer itself connects to the backing database. This means that your applications need only ever connect to your cache layer, and the cache then reads from or updates the backing database as needed. Redis currently supports write-behind caching in [Redis Software]({{< relref "/operate/rs" >}}). +Write-behind is a caching strategy in which the cache layer itself connects to the backing database. This means that your applications need only ever connect to your cache layer, and the cache then reads from or updates the backing database as needed. Redis currently supports write-behind caching in [Redis Software](/content/operate/rs/_index.md). Here's how these caching patterns work: @@ -61,18 +61,18 @@ If you want to do write-behind with an Oracle database: --requirements-path rgsync-99.99.99.linux-bionic-x64.zip ``` - {{< note >}} -You can be more efficient and import only the requirements you need, but rgsync is always required and can be combined with one or more of these packages according to your backend database: - -- redisgears-requirement-v1-snowflake-sqlalchemy-linux-\-x64.zip -- redisgears-requirement-v1-PyMySQL-linux-\-x64.zip -- redisgears-requirement-v1-cx-Oracle-linux-\-x64.zip -- redisgears-requirement-v1-cassandra-driver-linux-\-x64.zip - -This list can be different or more extensive in newer versions. -The `module.json` file in the module package lists the dependencies for the module. - - {{< /note >}} + > [!NOTE] + > You can be more efficient and import only the requirements you need, but rgsync is always required and can be combined with one or more of these packages according to your backend database: + > + > - redisgears-requirement-v1-snowflake-sqlalchemy-linux-\-x64.zip + > - redisgears-requirement-v1-PyMySQL-linux-\-x64.zip + > - redisgears-requirement-v1-cx-Oracle-linux-\-x64.zip + > - redisgears-requirement-v1-cassandra-driver-linux-\-x64.zip + > + > This list can be different or more extensive in newer versions. + > The `module.json` file in the module package lists the dependencies for the module. + > + > 1. From the CLI of a node or of a client that is connected to the database, check that the requirements were imported successfully with: diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/register-events.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/register-events.md index 9715d270e7..5ea82f631d 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/register-events.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/register-events.md @@ -36,16 +36,16 @@ For more information and examples of event registration, see: - Java references: - - [`KeysReader`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/keysreader" >}}) + - [`KeysReader`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/readers/keysreader.md) - - [`GearsBuilder.register()`]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register" >}}) + - [`GearsBuilder.register()`](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/classes/gearsbuilder/register.md) ## Event types -For the list of event types you can register on, see the [Redis keyspace notification documentation]({{< relref "/develop/pubsub/keyspace-notifications" >}}#events-generated-by-different-commands). +For the list of event types you can register on, see the [Redis keyspace notification documentation](/content/develop/pubsub/keyspace-notifications.md#events-generated-by-different-commands). ## Active-Active event types -In addition to standard Redis [events]({{< relref "/develop/pubsub/keyspace-notifications" >}}#events-generated-by-different-commands), [Redis Software Active-Active databases]({{< relref "/operate/rs/databases/active-active" >}}) also support the registration of RedisGears functions for the following event types: +In addition to standard Redis [events](/content/develop/pubsub/keyspace-notifications.md#events-generated-by-different-commands), [Redis Software Active-Active databases](/content/operate/rs/databases/active-active/_index.md) also support the registration of RedisGears functions for the following event types: - `change`: This event occurs when a key changes on another replica of the Active-Active database. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/_index.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/_index.md index e0f7d8c100..9c616724d6 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/_index.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/_index.md @@ -29,7 +29,7 @@ RedisGraph is the first queryable [Property Graph](https://github.com/opencypher ## Commands -See [Graph commands]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/commands" >}}) for a list of graph commands that are supported in Redis Software. +See [Graph commands](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/commands.md) for a list of graph commands that are supported in Redis Software. ## Clients @@ -39,7 +39,7 @@ For a list of available RedisGraph clients, see [RedisGraph client libraries](ht See [Configuration parameters](https://github.com/RedisGraph/RedisGraph/blob/master/docs/docs/configuration.md) for the complete list of RedisGraph configuration parameters. -To learn which configuration parameters are supported in Redis Software, see [Graph configuration compatibility with Redis Software]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/config" >}}). +To learn which configuration parameters are supported in Redis Software, see [Graph configuration compatibility with Redis Software](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/config.md). ## Design @@ -96,7 +96,7 @@ RedisGraph has several [known limitations](https://github.com/RedisGraph/RedisGr ## More info -- [Graph quick start]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/graph-quickstart" >}}) +- [Graph quick start](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/graph-quickstart.md) - [RedisGraph documentation on GitHub](https://github.com/RedisGraph/RedisGraph/tree/master/docs/docs) diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/commands.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/commands.md index c7c7423bf0..f9f12b4d79 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/commands.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/commands.md @@ -25,6 +25,6 @@ The following table lists graph commands. See the command links for more informa | [GRAPH.RO_QUERY](https://github.com/RedisGraph/RedisGraph/blob/master/docs/commands/graph.ro_query.md) | ✅ Supported | ✅ Supported | ✅ Supported | Runs a read-only query against a graph. | | [GRAPH.SLOWLOG](https://github.com/RedisGraph/RedisGraph/blob/master/docs/commands/graph.slowlog.md) | ✅ Supported | ✅ Supported | ✅ Supported | Returns the slowest 10 queries run against a specific graph. | -1. Use [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) or the [REST API]({{< relref "/operate/rs/references/rest-api" >}}) to change RedisGraph configuration for Redis Software. See [RedisGraph configuration compatibility with Redis Software]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/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 RedisGraph configuration for Redis Software. See [RedisGraph configuration compatibility with Redis Software](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/config.md) for more information and examples. 2. [Contact support](https://redis.com/company/support/) to view the current RedisGraph configuration values or request configuration changes for Flexible or Annual Redis Cloud subscriptions. \ No newline at end of file diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/config.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/config.md index ed2c60a983..ff0f63b2a3 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/config.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/config.md @@ -11,24 +11,24 @@ toc: 'false' weight: 30 --- -You cannot use `GRAPH.CONFIG SET` to configure RedisGraph in [Redis Software]({{< relref "/operate/rs" >}}) or [Redis Cloud]({{< relref "/operate/rc" >}}). Instead, use one of the following methods. +You cannot use `GRAPH.CONFIG SET` to configure RedisGraph in [Redis Software](/content/operate/rs/_index.md) or [Redis Cloud](/content/operate/rc/_index.md). Instead, use one of the following methods. 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 RedisGraph configuration. For Redis Software, use either: -- [`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 graph \ 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/ diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/graph-quickstart.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/graph-quickstart.md index 994c4558d8..ba0b7e352e 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/graph-quickstart.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/graph-quickstart.md @@ -16,17 +16,17 @@ For this quick start tutorial, you need: - A Redis database with the RedisGraph module enabled. You can use either: - - A [Redis Cloud]({{< relref "/operate/oss_and_stack/stack-with-enterprise/stack-quickstart" >}}) database + - A [Redis Cloud](/content/operate/oss_and_stack/stack-with-enterprise/stack-quickstart.md) database - - A [Redis Software]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database" >}}) database + - A [Redis Software](/content/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database.md) database -- [`redis-cli`]({{< relref "/operate/rs/references/cli-utilities/redis-cli" >}}) command-line tool +- [`redis-cli`](/content/operate/rs/references/cli-utilities/redis-cli/_index.md) command-line tool - [`redis-py`](https://github.com/redis/redis-py) client library v4.1.0 or later ## Graph with `redis-cli` -To begin, [connect to your database]({{< relref "/operate/rs/references/cli-utilities/redis-cli#connect-to-a-database" >}}) with `redis-cli`. +To begin, [connect to your database](/content/operate/rs/references/cli-utilities/redis-cli/_index.md#connect-to-a-database) with `redis-cli`. ### Create a graph @@ -215,9 +215,9 @@ Alex's updated friend count: [[1]] ## Visualize graphs with Redis Insight -You can use the [Redis Insight]({{< relref "/develop/tools/insight" >}}) workbench to visualize the relationships between the nodes of your graph. +You can use the [Redis Insight](/content/develop/tools/insight/_index.md) workbench to visualize the relationships between the nodes of your graph. -1. Connect to your database with Redis Insight. You can [connect manually]({{< relref "develop/tools/insight#add-a-standalone-redis-database" >}}) or use the [auto-discovery]({{< relref "develop/tools/insight#auto-discovery-for-redis-cloud-databases" >}}) feature. +1. Connect to your database with Redis Insight. You can [connect manually](/content/develop/tools/insight/_index.md#add-a-standalone-redis-database) or use the [auto-discovery](/content/develop/tools/insight/_index.md#auto-discovery-for-redis-cloud-databases) feature. 1. Select the **Workbench** button. @@ -237,6 +237,6 @@ After you run a query, the output log displays a visual representation of your g ## More info -- [Graph commands]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/commands" >}}) +- [Graph commands](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph/commands.md) - [RedisGraph client libraries](https://github.com/RedisGraph/RedisGraph/blob/master/docs/docs/clients.md) - [RedisGraph documentation on GitHub](https://github.com/RedisGraph/RedisGraph/tree/master/docs/docs) diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Configuration.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Configuration.md index 8031199f5a..6fe7055f53 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Configuration.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Configuration.md @@ -24,11 +24,11 @@ The following sections describe the configuration options and how to set them. ## Bootstrap configuration You can set your configuration options when the module is loaded. -When the module is loaded at start time, the module configuration can be defined in the Redis configuration file. When loading the module at runtime the configuration can be given to the [`MODULE LOADEX`]({{< relref "/commands/module-loadex" >}}) command. Each configuration must be prefixed with the module name, `redisgears_2.`. +When the module is loaded at start time, the module configuration can be defined in the Redis configuration file. When loading the module at runtime the configuration can be given to the [`MODULE LOADEX`](/content/commands/module-loadex.md) command. Each configuration must be prefixed with the module name, `redisgears_2.`. ## Runtime configuration -You may set certain configuration options at runtime. Setting a configuration at runtime is done using [`CONFIG SET`]({{< relref "/commands/config-set" >}}) command. Here each configuration must be prefixed with the module name, `redisgears_2.`. +You may set certain configuration options at runtime. Setting a configuration at runtime is done using [`CONFIG SET`](/content/commands/config-set.md) command. Here each configuration must be prefixed with the module name, `redisgears_2.`. Example: diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Debugging.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Debugging.md index 3a2cc5dca1..b547663c98 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Debugging.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Debugging.md @@ -21,7 +21,7 @@ aliases: There are two methods you can use to debug your Redis Stack functions: 1. Make judicious use of the `redis.log` function, which writes to the Redis log file. -1. Use Redis [pub/sub]({{< relref "/develop/pubsub" >}}). +1. Use Redis [pub/sub](/content/develop/pubsub/_index.md). ### Use `redis.log` @@ -46,7 +46,7 @@ After loading the library and executing the function with `TFCALL`, you'll see s ### Use Redis pub/sub -If you don't have access to your Redis database log files, you can use pub/sub. The following example demonstrates how to use the [client.call]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/JavaScript_API#clientcall" >}}) API to publish to a pub/sub channel. +If you don't have access to your Redis database log files, you can use pub/sub. The following example demonstrates how to use the [client.call](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/JavaScript_API.md#clientcall) API to publish to a pub/sub channel. ```javascript #!js api_version=1.0 name=lib diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Development.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Development.md index b2d339b758..26fc2badff 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Development.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Development.md @@ -16,7 +16,7 @@ aliases: - /develop/interact/programmability/triggers-and-functions/development/ --- -To aid in the development of new libraries of triggers and functions, you can use the type declaration files for the [triggers and functions API]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/JavaScript_API" >}}), which allows your preferred development environment to provide autocompletion and type checking. You can install this information using the following command: +To aid in the development of new libraries of triggers and functions, you can use the type declaration files for the [triggers and functions API](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/JavaScript_API.md), which allows your preferred development environment to provide autocompletion and type checking. You can install this information using the following command: ```bash npm install https://gitpkg.now.sh/RedisGears/RedisGears/js_api --save-dev diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Quick_Start_CLI.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Quick_Start_CLI.md index e8a44968e1..511f1ce65b 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Quick_Start_CLI.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Quick_Start_CLI.md @@ -17,7 +17,7 @@ aliases: - /develop/interact/programmability/triggers-and-functions/quick_start_ri/ --- -Make sure that you have [Redis Stack installed]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) and running. Alternatively, you can create a [free Redis Cloud account](https://redis.com/try-free/?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users). The triggers and functions preview is available in the fixed subscription plan for the Google Cloud Asia Pacific (Tokyo) and AWS Asia Pacific (Singapore) regions. +Make sure that you have [Redis Stack installed](/content/operate/oss_and_stack/install/install-stack/_index.md) and running. Alternatively, you can create a [free Redis Cloud account](https://redis.com/try-free/?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users). The triggers and functions preview is available in the fixed subscription plan for the Google Cloud Asia Pacific (Tokyo) and AWS Asia Pacific (Singapore) regions. ## Connect to Redis Stack @@ -98,7 +98,7 @@ redis-cli -x TFUNCTION LOAD REPLACE < ./main.js Functions within Redis can respond to events using keyspace triggers. While the majority of these events are initiated by command invocations, they also include events that occur when a key expires or is removed from the database. -For the full list of supported events, please refer to the [Redis keyspace notifications page]({{< relref "develop/pubsub/keyspace-notifications#events-generated-by-different-commands/?utm_source=redis\&utm_medium=app\&utm_campaign=redisinsight_triggers_and_functions_guide" >}}). +For the full list of supported events, please refer to the [Redis keyspace notifications page](/content/develop/pubsub/keyspace-notifications.md#events-generated-by-different-commands/?utm_source=redis\&utm_medium=app\&utm_campaign=redisinsight_triggers_and_functions_guide). The following code creates a new keyspace trigger that adds a new field to a new or updated hash with the latest update time. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Quick_Start_RI.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Quick_Start_RI.md index c352222033..65d5135cd8 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Quick_Start_RI.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Quick_Start_RI.md @@ -17,9 +17,9 @@ aliases: - /develop/interact/programmability/triggers-and-functions/quick_start_cli/ --- -Make sure that you have [Redis Stack installed]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) and running. Alternatively, you can create a [free Redis Cloud account](https://redis.com/try-free/?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users). +Make sure that you have [Redis Stack installed](/content/operate/oss_and_stack/install/install-stack/_index.md) and running. Alternatively, you can create a [free Redis Cloud account](https://redis.com/try-free/?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users). -If you haven't already installed Redis Insight, you can download the latest version [here](https://redis.com/redis-enterprise/redis-insight/?_ga=2.232184223.127667221.1704724457-86137583.1685485233&_gl=1*1gygred*_ga*ODYxMzc1ODMuMTY4NTQ4NTIzMw..*_ga_8BKGRQKRPV*MTcwNDkyMzExMC40MDEuMS4xNzA0OTI3MjQ2LjUyLjAuMA..*_gcl_au*MTQzODY1OTU4OS4xNzAxMTg0MzY0). If this is your first time using Redis Insight, you may wish to read through the [Redis Insight guide]({{< relref "/develop/tools/insight" >}}) before continuing with this guide. +If you haven't already installed Redis Insight, you can download the latest version [here](https://redis.com/redis-enterprise/redis-insight/?_ga=2.232184223.127667221.1704724457-86137583.1685485233&_gl=1*1gygred*_ga*ODYxMzc1ODMuMTY4NTQ4NTIzMw..*_ga_8BKGRQKRPV*MTcwNDkyMzExMC40MDEuMS4xNzA0OTI3MjQ2LjUyLjAuMA..*_gcl_au*MTQzODY1OTU4OS4xNzAxMTg0MzY0). If this is your first time using Redis Insight, you may wish to read through the [Redis Insight guide](/content/develop/tools/insight/_index.md) before continuing with this guide. ## Connect to Redis Stack @@ -59,7 +59,7 @@ Click on the **+ Add Library** button as before and, instead of adding the code Functions within Redis can respond to events using keyspace triggers. While the majority of these events are initiated by command invocations, they also include events that occur when a key expires or is removed from the database. -For the full list of supported events, please refer to the [Redis keyspace notifications page]({{< relref "develop/pubsub/keyspace-notifications#events-generated-by-different-commands/?utm_source=redis\&utm_medium=app\&utm_campaign=redisinsight_triggers_and_functions_guide" >}}). +For the full list of supported events, please refer to the [Redis keyspace notifications page](/content/develop/pubsub/keyspace-notifications.md#events-generated-by-different-commands/?utm_source=redis\&utm_medium=app\&utm_campaign=redisinsight_triggers_and_functions_guide). The following code creates a new keyspace trigger that adds a new field to a new or updated hash with the latest update time. @@ -84,7 +84,7 @@ Update the existing library as before and then, using the Redis Insight console, > HSET fellowship:1 name "Frodo Baggins" title "The One Ring Bearer" ``` -Run the [`HGETALL`]({{< relref "/commands/hgetall" >}}) command to check if the last updated time is added to the example. +Run the [`HGETALL`](/content/commands/hgetall.md) command to check if the last updated time is added to the example. ```Shell > HGETALL fellowship:1 diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Binary_Data.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Binary_Data.md index 32af2eee25..bc32e0f31c 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Binary_Data.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Binary_Data.md @@ -21,12 +21,12 @@ By default, triggers and functions will decode all data as a string and will rai 1. Binary function arguments 2. Binary command results -3. Binary key names on [keyspace triggers]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/Keyspace_Triggers" >}}) -4. Binary data on [stream triggers]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/Stream_Triggers" >}}) +3. Binary key names on [keyspace triggers](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/KeySpace_Triggers.md) +4. Binary data on [stream triggers](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/Stream_Triggers.md) ### Binary function arguments -It is possible to instruct triggers and functions not to decode function arguments as `JS` `Strings` using the [redis.functionFlags.RAW_ARGUMENTS]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Function_Flags" >}}) function flag. In this case, the function arguments will be given as `JS` `ArrayBuffer`. Example: +It is possible to instruct triggers and functions not to decode function arguments as `JS` `Strings` using the [redis.functionFlags.RAW_ARGUMENTS](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Function_Flags.md) function flag. In this case, the function arguments will be given as `JS` `ArrayBuffer`. Example: ```js #!js api_version=1.0 name=lib @@ -80,7 +80,7 @@ Notice that a `JS` `ArrayBuffer` can be returned by a function, it will be retur ### Binary keys names on database triggers -On [keyspace triggers]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/Keyspace_Triggers" >}}), if the key name that triggered the event is binary, the `data.key` field will be NULL. The `data.key_raw` field is always provided as a `JS` `ArrayBuffer` and can be used as in the following example: +On [keyspace triggers](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/KeySpace_Triggers.md), if the key name that triggered the event is binary, the `data.key` field will be NULL. The `data.key_raw` field is always provided as a `JS` `ArrayBuffer` and can be used as in the following example: ```js #!js api_version=1.0 name=lib @@ -116,11 +116,11 @@ OK 3) "\xaa" ``` -For more information see [keyspace triggers]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/Keyspace_Triggers" >}}). +For more information see [keyspace triggers](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/KeySpace_Triggers.md). ### Binary data on stream consumers -On [stream triggers]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/Stream_Triggers" >}}), if the key name is binary. The `data.stream_name` field will be NULL. The `data.stream_name_raw` field is always provided as a `JS` `ArrayBuffer` and can be used in this case. In addition, if the content of the steam is binary, it will also appear as `null` under `data.record`. In this case, it is possible to use `data.record` (which always exists) and contains the data as a `JS` `ArrayBuffer`. Example: +On [stream triggers](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/Stream_Triggers.md), if the key name is binary. The `data.stream_name` field will be NULL. The `data.stream_name_raw` field is always provided as a `JS` `ArrayBuffer` and can be used in this case. In addition, if the content of the steam is binary, it will also appear as `null` under `data.record`. In this case, it is possible to use `data.record` (which always exists) and contains the data as a `JS` `ArrayBuffer`. Example: ```js #!js api_version=1.0 name=lib diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Cluster_Support.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Cluster_Support.md index 890dcbe290..220d36cb90 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Cluster_Support.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Cluster_Support.md @@ -31,7 +31,7 @@ redis.registerClusterFunction("dbsize", async(async_client) => { }); ``` -`redis.registerClusterFunction` is passed the remote function name, which will be used later to call the remote function, and the remote function code. The remote function must be a Coroutine (async function) and it is executed in the background on the remote shard. For more information about async function, please refer to [sync and async]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Sync_Async" >}}) page. +`redis.registerClusterFunction` is passed the remote function name, which will be used later to call the remote function, and the remote function code. The remote function must be a Coroutine (async function) and it is executed in the background on the remote shard. For more information about async function, please refer to [sync and async](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Sync_Async.md) page. We have couple of options for calling a remote function. These options are exposed through the async client that is given to a Coroutine: @@ -109,12 +109,12 @@ The remote function arguments and results are serialized in the following way: ## Execution timeout -Remote functions will not be permitted to run forever and will timeout. The timeout period can be configured using [remote-task-default-timeout]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Configuration#remote-task-default-timeout" >}}). +Remote functions will not be permitted to run forever and will timeout. The timeout period can be configured using [remote-task-default-timeout](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Configuration.md#remote-task-default-timeout). When using `async_client.runOnShards` API, the timeout will be added as error to the error array. When using `async_client.runOnKey`, a timeout will cause an exception to be raised. ## Remote function limitations -All the limitations listed on [coroutines]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Sync_Async" >}}) also apply to remote functions. Remote function also come with some extra limitations: +All the limitations listed on [coroutines](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Sync_Async.md) also apply to remote functions. Remote function also come with some extra limitations: * Remote functions can only perform read operations. An attempt to perform a write operation will result in an error. * Remote function are not guaranteed to succeed (if the shard crashed for example). In such cases a timeout error will be given. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Library_Configuration.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Library_Configuration.md index 2c9286e87a..a1f9d0e3c2 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Library_Configuration.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Library_Configuration.md @@ -17,7 +17,7 @@ aliases: - /develop/interact/programmability/triggers-and-functions/concepts/library_configuration/ --- -When writing a library, you may want to provide a loading configuration so that different users can use the same library with slightly different behaviour, without changing the base code. For example, assume you write a library that adds a `__last_updated__` field to a hash (you can see how it can also be done with [keyspace triggers]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/Keyspace_Triggers" >}})), the code will look like this: +When writing a library, you may want to provide a loading configuration so that different users can use the same library with slightly different behaviour, without changing the base code. For example, assume you write a library that adds a `__last_updated__` field to a hash (you can see how it can also be done with [keyspace triggers](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/KeySpace_Triggers.md)), the code will look like this: ```js #!js api_version=1.0 name=lib @@ -41,7 +41,7 @@ Run example: 4) "1658653125" ``` -The problem with the above code is that the `__last_update__` field is hard coded. What if we want to allow the user to configure it at runtime? Triggers and functions provide for specifying a library configuration at load time using a [`CONFIG`]({{< relref "/commands/config" >}}) argument that is passed to the `TFUNCTION LOAD` command. The configuration argument accepts a string representation of a JSON object. The JSON will be provided to the library as a JS object under the `redis.config` variable. We can change the above example to accept the `__last_update__` field name as a library configuration. The code will look like this: +The problem with the above code is that the `__last_update__` field is hard coded. What if we want to allow the user to configure it at runtime? Triggers and functions provide for specifying a library configuration at load time using a [`CONFIG`](/content/commands/config.md) argument that is passed to the `TFUNCTION LOAD` command. The configuration argument accepts a string representation of a JSON object. The JSON will be provided to the library as a JS object under the `redis.config` variable. We can change the above example to accept the `__last_update__` field name as a library configuration. The code will look like this: ```js #!js api_version=1.0 name=lib @@ -62,7 +62,7 @@ redis.registerFunction("hset", function(client, key, field, val){ }); ``` -Notice that in the above example we first set `last_update_field_name` to `__last_update__`, the default value in cases where a value is not provided by the configuration. Then we check if we have `last_update_field_name` in our configuration and if we do we use it. We can now load our function with a [`CONFIG`]({{< relref "/commands/config" >}}) argument: +Notice that in the above example we first set `last_update_field_name` to `__last_update__`, the default value in cases where a value is not provided by the configuration. Then we check if we have `last_update_field_name` in our configuration and if we do we use it. We can now load our function with a [`CONFIG`](/content/commands/config.md) argument: ```bash > redis-cli -x TFUNCTION LOAD REPLACE CONFIG '{"last_update_field_name":"last_update"}' < diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Sync_Async.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Sync_Async.md index 3190bc80af..553e16c6c1 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Sync_Async.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Sync_Async.md @@ -59,7 +59,7 @@ Running this function will return a `pong` reply: Notice that this time, in order to invoke the function, we used `TFCALLASYNC`. **We can only invoke async functions using `TFCALLASYNC`**. -Now let's look at a more complex example. Assume we want to write a function that counts the number of hashes in Redis that have a `name` property with some value. As a first attempt, we'll write a synchronous function that uses the [`SCAN`]({{< relref "/commands/scan" >}}) command to scan the key space: +Now let's look at a more complex example. Assume we want to write a function that counts the number of hashes in Redis that have a `name` property with some value. As a first attempt, we'll write a synchronous function that uses the [`SCAN`](/content/commands/scan.md) command to scan the key space: ```js #!js api_version=1.0 name=lib @@ -105,7 +105,7 @@ redis.registerAsyncFunction('test', async function(async_client, expected_name){ }); ``` -Both implementations return the same result, but the second function runs in the background and blocks Redis just to analyze the next batch of keys that are returned from the [`SCAN`]({{< relref "/commands/scan" >}}) command. Other commands will be processed in between [`SCAN`]({{< relref "/commands/scan" >}}) batches. Notice that the coroutine approach allows the key space to be changed while the scanning it. The function writer will need to decide if this is acceptable. +Both implementations return the same result, but the second function runs in the background and blocks Redis just to analyze the next batch of keys that are returned from the [`SCAN`](/content/commands/scan.md) command. Other commands will be processed in between [`SCAN`](/content/commands/scan.md) batches. Notice that the coroutine approach allows the key space to be changed while the scanning it. The function writer will need to decide if this is acceptable. # Start sync and move to async @@ -198,7 +198,7 @@ redis.registerAsyncFunction('test', function(client, expected_name){ # Call blocking commands -Redis has a few commands that blocks the client and executed asynchronously when some condition holds (commands like [blpop]({{< relref "/commands/blpop" >}})). In general, such commands are not suppose to be called inside a script and calling them will result in running their none blocking logic. For example, [blpop]({{< relref "/commands/blpop" >}}) will basically runs lpop and return empty result if the list it empty. +Redis has a few commands that blocks the client and executed asynchronously when some condition holds (commands like [blpop](/content/commands/blpop.md)). In general, such commands are not suppose to be called inside a script and calling them will result in running their none blocking logic. For example, [blpop](/content/commands/blpop.md) will basically runs lpop and return empty result if the list it empty. RedisGears allows running blocking commands using `client.callAsync` API. `client.callAsync` will execute the blocking command and return a promise object which will be resolved when the command invocation finished (notice that `client.callAsync` allow calling any command and not just blocking but it will always return a promise object that will be resolve later, so **using it for regular commands is less efficient**). @@ -228,7 +228,7 @@ RedisGears also provided `client.callAsyncRaw` API, which is the same as `client Blocking Redis might fail for a few reasons: -* Redis reached OOM state and the `redis.functionFlags.NO_WRITES` or `redis.functionFlags.ALLOW_OOM` flags are not set (see [functions flags]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Function_Flags" >}}) for more information) +* Redis reached OOM state and the `redis.functionFlags.NO_WRITES` or `redis.functionFlags.ALLOW_OOM` flags are not set (see [functions flags](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Function_Flags.md) for more information) * `redis.functionFlags.NO_WRITES` flag is not set and the Redis instance changed roles and is now a replica. * The ACL user that invoked the function was deleted. @@ -236,7 +236,7 @@ The failure will result in an exception that the function writer can choose to h # Block Redis timeout -Blocking Redis for a long time is discouraged and is considered an unsafe operation. The triggers and functions feature attempts to protect the function writer and will time out the blocking function if it continues for too long. The timeout can be set as a [module configuration]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Configuration" >}}) along side the fatal failure policy that indicates how to handle the timeout. Policies can be one of the following: +Blocking Redis for a long time is discouraged and is considered an unsafe operation. The triggers and functions feature attempts to protect the function writer and will time out the blocking function if it continues for too long. The timeout can be set as a [module configuration](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Configuration.md) along side the fatal failure policy that indicates how to handle the timeout. Policies can be one of the following: * Abort - Stop the function invocation even at the cost of losing the atomicity property. * Kill - Keep the atomicity property and do not stop the function invocation. In this case there is a risk of an external process killing the Redis server, thinking that the shard is not responding. diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/KeySpace_Triggers.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/KeySpace_Triggers.md index ac570f137f..33c65c3b58 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/KeySpace_Triggers.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/KeySpace_Triggers.md @@ -22,7 +22,7 @@ Keyspace triggers allow you to register a function that will be executed wheneve 1. Expired: This event is fired when a key expires from the database. 2. Evicted: This event is fired when a key is evicted from the database. -For a complete list of supported events, please refer to the [Redis keyspace notifications page]({{< relref "develop/pubsub/keyspace-notifications#events-generated-by-different-commands" >}}). +For a complete list of supported events, please refer to the [Redis keyspace notifications page](/content/develop/pubsub/keyspace-notifications.md#events-generated-by-different-commands). To register a keyspace trigger, you need to use the `redis.registerKeySpaceTrigger` API when loading your library. The following example demonstrates how to register a database trigger that adds a "last updated" field whenever a hash key is modified: @@ -45,7 +45,7 @@ Argument Description: * `consumer`: The consumer name. * `prefix `: The key prefix on which the trigger should be fired. -* `callback`: The callback function to invoke, following the same rules of [Sync and Async invocation]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Sync_Async" >}}). The callback will only be invoked on the primary shard. +* `callback`: The callback function to invoke, following the same rules of [Sync and Async invocation](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Sync_Async.md). The callback will only be invoked on the primary shard. Run the example: @@ -121,7 +121,7 @@ We can display trigger information using `TFUNCTION LIST` command: If the callback function passed to the trigger is a `JS` function (not a Coroutine), it is guaranteed that the callback will be invoked atomically along side the operation that caused the trigger; meaning all clients will see the data only after the callback has completed. In addition, it is guaranteed that the effect of the callback will be replicated to the replica and the AOF in a `multi/exec` block together with the command that fired the trigger. -If the callback is a Coroutine, it will be executed in the background and there is no guarantee on where or if it will be executed. The guarantees are the same as described on [sync and async invocation]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Sync_Async" >}}). +If the callback is a Coroutine, it will be executed in the background and there is no guarantee on where or if it will be executed. The guarantees are the same as described on [sync and async invocation](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Sync_Async.md). ## Upgrades diff --git a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/Stream_Triggers.md b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/Stream_Triggers.md index 2f0aee1f05..7f94c3a985 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/Stream_Triggers.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/triggers/Stream_Triggers.md @@ -17,11 +17,11 @@ aliases: - /develop/interact/programmability/triggers-and-functions/concepts/triggers/stream_triggers/ --- -Redis Stack's triggers and functions feature comes with a full stream API to process data from [Redis streams]({{< relref "/develop/data-types/streams" >}}). Unlike RedisGears v1 that provided a micro batching API, the new triggers and functions feature provides a **real streaming** API, which means that the data will be processed as soon as it enters the stream. +Redis Stack's triggers and functions feature comes with a full stream API to process data from [Redis streams](/content/develop/data-types/streams/_index.md). Unlike RedisGears v1 that provided a micro batching API, the new triggers and functions feature provides a **real streaming** API, which means that the data will be processed as soon as it enters the stream. ## Register a stream consumer -Triggers and functions provide an API that allows to register a stream trigger. Do not get confused with [Redis streams consumer groups]({{< relref "develop/data-types/streams#consumer-groups" >}}), triggers and functions uses the Redis Module API to efficiently read the stream and manage its consumers. This approach gives a much better performance as there is no need to invoke any Redis commands in order to read from the stream. Lets see a simple example: +Triggers and functions provide an API that allows to register a stream trigger. Do not get confused with [Redis streams consumer groups](/content/develop/data-types/streams/_index.md#consumer-groups), triggers and functions uses the Redis Module API to efficiently read the stream and manage its consumers. This approach gives a much better performance as there is no need to invoke any Redis commands in order to read from the stream. Lets see a simple example: ```js #!js api_version=1.0 name=myFirstLibrary @@ -44,9 +44,9 @@ Argument Description: * consumer - the consumer name. * stream - streams name prefix on which to trigger the callback. -* callback - the callback to invoke on each element in the stream. Following the same rules of [sync and async invocation]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Sync_Async" >}}). The callback will be invoke only on primary shard. +* callback - the callback to invoke on each element in the stream. Following the same rules of [sync and async invocation](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/Sync_Async.md). The callback will be invoke only on primary shard. -If we register this library (see the [quick start]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Quick_Start_CLI" >}}) section to learn how to Register a RedisGears function) and run the following command on our Redis: +If we register this library (see the [quick start](/content/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/Quick_Start_CLI.md) section to learn how to Register a RedisGears function) and run the following command on our Redis: ``` XADD stream:1 * foo1 bar1