FT.CONFIG HELP

Describe configuration options

Examples

Required arguments

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

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

</details>

Examples

<details open> <summary><b>Get configuration details</b></summary>

{{< highlight bash >}} 127.0.0.1:6379> FT.CONFIG HELP TIMEOUT

1. 1. TIMEOUT
   2. Description
   3. Query (search) timeout
   4. Value
   5. "42" {{< / 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> | <span title="Not supported"><nobr>❌ Not supported</span> | <span title="Not supported"><nobr>❌ Not supported</nobr></span> | |

Return information

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

[Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of help information.

-tab-sep-

[Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of help information.

{{< /multitabs >}}

See also

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

Related topics

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