Skip to main content

FT.INFO

Syntax​

FT.INFO index

Time complexity: Proportional to the number of shards and the amount of index metadata returned.

ACL categories: @ft_search

Description​

Return information and statistics on the index.

Required arguments​

index

is index name. You must first create the index using FT.CREATE.

Return​

FT.INFO returns a flat array reply with pairs of keys and values under both RESP2 and RESP3.

Returned values include:

  • index_name: name of the index upon creation by using FT.CREATE.
  • index_definition: contains information about the index configuration, including key_type, prefixes, default_language, optional language_field, and default_score.
  • index_options: index-level options, including NOOFFSETS when configured (may be empty).
  • attributes: index schema - for each field contains:
    • identifier: the original field name or JSONPath
    • attribute: the field alias (or same as identifier if no alias provided)
    • type: field type (TEXT, TAG, NUMERIC, VECTOR, GEO)
    • field-specific options such as SORTABLE, NOINDEX, WEIGHT (for TEXT fields), SEPARATOR (for TAG fields), algorithm, data_type, dim, distance_metric, and algorithm-specific parameters (for VECTOR fields), and blocksize (for NUMERIC fields)
  • num_docs: Number of documents in the index.
  • indexing: whether the index is currently being built (1) or not (0).
  • percent_indexed: fraction of the data that has been indexed so far.
  • stopwords_list: custom stopwords list (only present when custom stopwords are configured).

The order of entries within attributes is not guaranteed and may differ between calls.

Examples​

Return statistics about an index
dragonfly> HSET blog:post:1 title "blog post 1" published_at 1701210030 category "default" description "this is a blog"
(integer) 4
dragonfly> FT.CREATE idx ON HASH PREFIX 1 blog:post: SCHEMA title TEXT SORTABLE published_at NUMERIC SORTABLE category TAG SORTABLE description TEXT NOINDEX
OK
dragonfly> FT.INFO idx
 1) index_name
 2) idx
 3) index_definition
 4) 1) key_type
    2) HASH
    3) prefixes
    4) 1) "blog:post:"
    5) default_language
    6) english
    7) default_score
    8) (integer) 1
 5) index_options
 6) (empty array)
 7) attributes
 8) 1) 1) identifier
       2) title
       3) attribute
       4) title
       5) type
       6) TEXT
       7) SORTABLE
       8) WEIGHT
       9) 1.000000
    2) 1) identifier
       2) description
       3) attribute
       4) description
       5) type
       6) TEXT
       7) NOINDEX
       8) WEIGHT
       9) 1.000000
    3) 1) identifier
       2) published_at
       3) attribute
       4) published_at
       5) type
       6) NUMERIC
       7) SORTABLE
       8) blocksize
       9) 10000
    4) 1) identifier
       2) category
       3) attribute
       4) category
       5) type
       6) TAG
       7) SORTABLE
       8) SEPARATOR
       9) ,
 9) num_docs
10) (integer) 1
11) indexing
12) (integer) 0
13) percent_indexed
14) "1"

See also​

FT.CREATE | FT.SEARCH