Back to Redis

FT.CONFIG GET

content/commands/ft.config-get.md

latest3.1 KB
Original Source

Retrieve 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>Retrieve configuration options</b></summary>

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

    1. TIMEOUT
    2. 42 {{< / highlight >}}

{{< highlight bash >}} 127.0.0.1:6379> FT.CONFIG GET *

    1. EXTLOAD
    2. (nil)
    1. SAFEMODE
    2. true
    1. CONCURRENT_WRITE_MODE
    2. false
    1. NOGC
    2. false
    1. MINPREFIX
    2. 2
    1. FORKGC_SLEEP_BEFORE_EXIT
    2. 0
    1. MAXDOCTABLESIZE
    2. 1000000
    1. MAXSEARCHRESULTS
    2. 1000000
    1. MAXAGGREGATERESULTS
    2. unlimited
    1. MAXEXPANSIONS
    2. 200
    1. MAXPREFIXEXPANSIONS
    2. 200
    1. TIMEOUT
    2. 42
    1. INDEX_THREADS
    2. 8
    1. SEARCH_THREADS
    2. 20
    1. FRISOINI
    2. (nil)
    1. ON_TIMEOUT
    2. return
    1. GCSCANSIZE
    2. 100
    1. MIN_PHONETIC_TERM_LEN
    2. 3
    1. GC_POLICY
    2. fork
    1. FORK_GC_RUN_INTERVAL
    2. 30
    1. FORK_GC_CLEAN_THRESHOLD
    2. 100
    1. FORK_GC_RETRY_INTERVAL
    2. 5
    1. FORK_GC_CLEAN_NUMERIC_EMPTY_NODES
    2. true
    1. _FORK_GC_CLEAN_NUMERIC_EMPTY_NODES
    2. true
    1. _MAX_RESULTS_TO_UNSORTED_MODE
    2. 1000
    1. UNION_ITERATOR_HEAP
    2. 20
    1. CURSOR_MAX_IDLE
    2. 300000
    1. NO_MEM_POOLS
    2. false
    1. PARTIAL_INDEXED_DOCS
    2. false
    1. UPGRADE_INDEX
    2. Upgrade config for upgrading
    1. _NUMERIC_COMPRESS
    2. false
    1. _FREE_RESOURCE_ON_THREAD
    2. true
    1. _PRINT_PROFILE_CLOCK
    2. true
    1. RAW_DOCID_ENCODING
    2. false
    1. _NUMERIC_RANGES_PARENTS
    2. 0
    1. MINSTEMLEN
    2. 4 {{< / 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><sup>1</sup> | <span title="Not supported"><nobr>❌ Not supported</nobr></span> | |

  1. </a>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-get-return-info" tab1="RESP2" tab2="RESP3" >}}

[Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [arrays]({{< relref "/develop/reference/protocol-spec#arrays" >}}), where each sub-array contains a configuration option name and its value.

-tab-sep-

[Map]({{< relref "/develop/reference/protocol-spec#maps" >}}) where keys are configuration option names and values are their corresponding values.

{{< /multitabs >}}

See also

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

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