FT.CONFIG HELP

Syntax
FT.CONFIG HELP option
Available in:
Redis Stack / Search 1.0.0
Time complexity:
O(1)

Describe configuration options

Examples

Required arguments

option

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

Return

FT.CONFIG HELP returns an array reply of the configuration name and value.

Examples

Get configuration details
127.0.0.1:6379> FT.CONFIG HELP TIMEOUT
1) 1) TIMEOUT
   2) Description
   3) Query (search) timeout
   4) Value
   5) "42"

See also

FT.CONFIG SET | FT.CONFIG GET

RediSearch

Rate this page