FT.INFO

Since 1.1.0Search

Syntax

FT.INFO index
  • ACL categories: @read, @search, @slow
  • Arity: -1

Returns an index's definition and state: its key type and prefixes, its fields with their options, how many documents and terms it holds, and whether it is still indexing. An index with HNSW vector fields also reports, for each, how many vectors it holds, how many are tombstones awaiting compaction, and whether a compaction is running.

What the index holds, in bytes:

Field
text_terms_bytesThe words and stems of the TEXT fields, each kept once.
text_postings_bytesFor each word, the documents that hold it.
text_docs_bytesFor each document, its words in order.
doc_ids, max_doc_idThe documents numbered, and the highest number given.
tag_valuesThe distinct values of the TAG fields.
postings_ids_bytes, postings_tag_bytes, postings_numeric_bytesThe documents' numbers and key order, the documents of each tag, and the NUMERIC values in order.

Before 1.2, these were not reported. An index that does not exist is SEARCH_INDEX_NOT_FOUND Index not found: <index>.

Examples

> FT.INFO products
 1) "index_name"
 2) "products"
 ...
 7) "attributes"
 8) 1) 1) "identifier"
       2) "name"
       ...
       5) "type"
       6) "TEXT"
 ...
13) "num_docs"
14) (integer) 4
 ...