Documentation: Valkey Search - Configuration

Configurables

The search module uses the Valkey configuration mechanism. Thus each of the named configuration below can be set on the module load command OR via the CONFIG SET command.

NameTypeDefault ValueDescription
search.query-string-bytesNumberControls the length of the query string for FT.SEARCH command
search.hnsw-block-sizeNumberHNSW resize configuration parameter for vector index block allocation
search.reader-threadsNumberControls the reader thread pool size; dynamically resizes pool on modification
search.writer-threadsNumberControls the writer thread pool size; dynamically resizes pool on modification
search.utility-threadsNumberControls the utility thread pool size; dynamically resizes pool on modification
search.max-worker-suspension-secsNumberMax time in seconds that worker thread pool is suspended after fork started
search.use-coordinatorBooleanControls whether this instance uses coordinator; can only be set at startup
search.skip-rdb-loadBooleanSkip loading vector index data from RDB file
search.skip-corrupted-internal-update-entriesBooleanSkip corrupted AOF entries during internal updates
search.log-levelEnumControls module log level verbosity
search.enable-partial-resultsBooleanyesDefault option for delivering partial results when timeout occurs (uses SOMESHARDS if not explicitly provided)
search.enable-consistent-resultsBooleannoDefault option for delivering consistent results when timeout occurs (uses CONSISTENT if not explicitly provided)
search.search-result-background-cleanupBooleanEnable search result cleanup on background thread
search.high-priority-weightNumberWeight for high priority tasks in thread pools; low priority = 100 - this value
search.ft-info-timeout-msNumberTimeout in milliseconds for FT.INFO fanout command
search.ft-info-rpc-timeout-msNumberRPC timeout in milliseconds for FT.INFO fanout command
search.local-fanout-queue-wait-thresholdNumberQueue wait threshold in milliseconds for preferring local node in fanout operations
search.thread-pool-wait-time-samplesNumberSample queue size for thread pool wait time tracking
search.max-term-expansionsNumberMaximum number of words to search in text operations (prefix, suffix, fuzzy) to limit memory usage
search.tag-min-prefix-lengthNumberMinimum number of characters required before trailing * in TAG wildcard queries (length excludes *)
search.search-result-buffer-multiplierStringMultiplier for search result buffer size allocation
search.drain-mutation-queue-on-saveBooleanDrain the mutation queue before RDB save
search.query-string-depthNumberControls the depth of the query string parsing from the FT.SEARCH cmd
search.query-string-terms-countNumberControls the size of the query string parsing from the FT.SEARCH cmd (number of nodes in predicate tree)
search.fuzzy-max-distanceNumberControls the maximum allowed edit distance for fuzzy search queries
search.max-vector-knnNumberControls the max KNN parameter for vector search
search.max-nonvector-search-results-fetchedNumber100000Maximum number of keys a non-vector query collects before fetching their contents; a query that matches more keys returns only this many. For queries with a VECTOR_RANGE matcher, see Vector Range Match
search.proximity-inorder-compat-modeBooleanControls proximity iterator's inorder/overlap violation check logic (compatibility mode)
search.max-prefixesNumberControls the max number of prefixes per index
search.max-tag-field-lengthNumberControls the max length of a tag field
search.max-numeric-field-lengthNumberControls the max length of a numeric field
search.max-vector-attributesNumberControls the max number of attributes per index
search.max-vector-dimensionsNumberControls the max dimensions for vector indices
search.max-vector-mNumberControls the max M parameter for HNSW algorithm
search.max-vector-ef-constructionNumberControls the max EF construction parameter for HNSW algorithm
search.max-vector-ef-runtimeNumberControls the max EF runtime parameter for HNSW algorithm
search.default-timeout-msNumberControls the default timeout in milliseconds for FT.SEARCH
search.max-timeout-msNumberControls the maximum allowed TIMEOUT value, in milliseconds, for FT.SEARCH and FT.AGGREGATE
search.max-search-result-record-sizeNumberControls the max content size for a record in the search response
search.max-search-result-fields-countNumberControls the max number of fields in the content of the search response
search.backfill-batch-sizeNumberControls the batch size for backfilling indexes
search.cursor-max-countNumber100000Maximum COUNT accepted by WITHCURSOR and FT.CURSOR READ
search.cursor-max-idle-msNumberINT64_MAXMaximum MAXIDLE (milliseconds) accepted by WITHCURSOR
search.coordinator-query-timeout-secsNumberControls the gRPC deadline timeout (in seconds) for distributed coordinator query operations.
search.max-indexesNumberControls the maximum number of search indexes that can be created in the system
search.cluster-map-expiration-msNumberControls how long (in milliseconds) the coordinator caches the cluster topology map before refreshing it from the Valkey cluster.