Skip to main content

FT.CONFIG

Syntax​

FT.CONFIG GET pattern
FT.CONFIG SET option value
FT.CONFIG HELP [option]

Time complexity: O(1)

Description​

Configure search engine at runtime.

Required arguments​

GET pattern

returns the current values of configuration parameters matching the given pattern.

pattern is a glob-style pattern for the configuration parameter names.

SET option value

sets a configuration parameter to the given value.

option is the configuration parameter name. value is the new value for the configuration parameter.

HELP [option]

returns help information about configuration parameters.

If option is specified, returns help for that specific parameter. If no option is given, returns help for all available parameters.

Return​

  • FT.CONFIG GET returns an array with parameter names and their values.
  • FT.CONFIG SET returns a simple string reply OK if executed correctly, or an error reply otherwise.
  • FT.CONFIG HELP returns an array with parameter information including descriptions and current values.

Examples​

Get all search configuration parameters
dragonfly> FT.CONFIG GET *
1) "MAXSEARCHRESULTS"
2) "1000000"
Set maximum search results
dragonfly> FT.CONFIG SET MAXSEARCHRESULTS 500000
OK
Get help for a specific parameter
dragonfly> FT.CONFIG HELP MAXSEARCHRESULTS
1) "MAXSEARCHRESULTS"
2) "Description"
3) "Maximum number of results from ft.search command"
4) "Value"
5) "500000"

See also​

FT.CREATE | FT.SEARCH