ContextQMD
Back to Redis

FT.CONFIG SET

content/commands/ft.config-set.md

latest2.9 KB
Original Source

Set the value of a RediSearch configuration parameter.

Values set using FT.CONFIG SET are not persisted after server restart.

RediSearch configuration parameters are detailed in [Configuration parameters]({{< relref "/develop/ai/search-and-query/administration/configuration" >}}).

{{% alert title="Note" color="warning" %}} As detailed in the link above, not all RediSearch configuration parameters can be set at runtime. {{% /alert %}}

Examples

Required arguments

<details open> <summary><code>option</code></summary>

is name of the configuration option, or '*' for all.

</details> <details open> <summary><code>value</code></summary>

is value of the configuration option.

</details>

Examples

<details open> <summary><b>Set runtime configuration options</b></summary>

{{< highlight bash >}} 127.0.0.1:6379> FT.CONFIG SET TIMEOUT 42 OK {{< / highlight >}}

</details>

Redis Software and Redis Cloud compatibility

| Redis Software | Redis Cloud Flexible & Annual | Redis Cloud Free & Fixed | <span style="min-width: 9em; display: table-cell">Notes</span> | |:----------------------|:-----------------|:-----------------|:------| | <span title="Not supported"><nobr>⚠️ Not supported</span><sup>1</sup> | <span title="Not supported"><nobr>⚠️ Not supported</span><sup>2</sup> | <span title="Not supported"><nobr>❌ Not supported</nobr></span> | |

  1. Use [rladmin]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) or the [REST API]({{< relref "/operate/rs/references/rest-api" >}}) to change search and query configuration for Redis Software. See [search and query configuration compatibility with Redis Software]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search/config" >}}) for more information and examples.

  2. Contact support to view the current configuration values or request configuration changes for Flexible or Annual Redis Cloud subscriptions.

Return information

{{< multitabs id="ft-config-set-return-info" tab1="RESP2" tab2="RESP3" >}}

One of the following:

  • [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): OK if executed correctly.
  • [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid option, invalid value.

-tab-sep-

One of the following:

  • [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): OK if executed correctly.
  • [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid option, invalid value.

{{< /multitabs >}}

See also

[FT.CONFIG GET]({{< relref "commands/ft.config-get/" >}}) | [FT.CONFIG HELP]({{< relref "commands/ft.config-help/" >}})

[RediSearch]({{< relref "/develop/ai/search-and-query/" >}})