{ "id": "ft.info", "title": "FT.INFO", "url": "https://redis.io/docs/latest/commands/ft.info/", "summary": "Returns information and statistics on the index", "tags": [ "docs", "develop", "stack", "oss", "rs", "rc", "oss", "kubernetes", "clients" ], "last_updated": "2026-04-09T10:29:34-04:00", "page_type": "content", "content_hash": "887f72d2efbf1c18188b284cd507e0432b674964b99b0c3bf710bbe5ef17c031", "sections": [ { "id": "overview", "title": "Overview", "role": "overview", "text": "Returns information and statistics about a given index." }, { "id": "required-arguments", "title": "Required arguments", "role": "content", "text": "`index`\n
\nis the name of the given index. You must first create the index using [`FT.CREATE`](). You can also use an alias of `index` created using [`FT.ALIASADD`]() or [`FT.ALIASUPDATE`]()." }, { "id": "returned-values", "title": "Returned values", "role": "returns", "text": "" }, { "id": "general", "title": "General", "role": "content", "text": "| Return field name | Definition |\n|:--- |:--- |\n| `index_name` | The index name that was defined when index was created. |\n| `index_options` | The index options selected during `FT.CREATE` such as `FILTER {filter}`, `LANGUAGE {default_lang}`, etc. |\n| `index_definition` | Includes `key_type`, hash or JSON; `prefixes`, if any; and `default_score`. |\n| `attributes` | The index schema field names, types, and attributes. |\n| `num_docs` | The number of documents. |\n| `max_doc_id` | The maximum document ID. |\n| `num_terms` | The number of distinct terms. |\n| `num_records` | The total number of records. |" }, { "id": "various-size-statistics", "title": "Various size statistics", "role": "content", "text": "| Statistic | Definition |\n|:--- |:--- |\n| `inverted_sz_mb` | The memory used by the inverted index, which is the core data structure used for searching in RediSearch. The size is given in megabytes. |\n| `vector_index_sz_mb` | The memory used by the vector index, which stores any vectors associated with each document. |\n| `total_inverted_index_blocks` | The total number of blocks in the inverted index. |\n| `offset_vectors_sz_mb` | The memory used by the offset vectors, which store positional information for terms in documents. |\n| `doc_table_size_mb` | The memory used by the document table, which contains metadata about each document in the index. |\n| `sortable_values_size_mb` | The memory used by sortable values, which are values associated with documents and used for sorting purposes. |\n| `key_table_size_mb` | The memory used by the key table, which stores the mapping between document IDs and Redis keys. |\n| `geoshapes_sz_mb` | The memory used by GEO-related fields. |\n| `records_per_doc_avg` | The average number of records (including deletions) per document. |\n| `bytes_per_record_avg` | The average size of each record in bytes. |\n| `offsets_per_term_avg` | The average number of offsets (position information) per term. |\n| `offset_bits_per_record_avg` | The average number of bits used for offsets per record. |\n| `tag_overhead_sz_mb` | The size of the TAG index structures used for optimising performance. |\n| `text_overhead_sz_mb` | The size of the TEXT index structures used for optimising performance. |\n| `total_index_memory_sz_mb` | The total memory consumed by all indexes in the DB. |" }, { "id": "indexing-related-statistics", "title": "Indexing-related statistics", "role": "content", "text": "| Statistic | Definition |\n|:--- |:--- |\n| `hash_indexing_failures` | The number of failures encountered during indexing. |\n| `total_indexing_time` | The cumulative wall-clock time spent indexing documents in ms. |\n| `indexing` | Indicates whether the index is currently being generated. |\n| `percent_indexed` | The percentage of the index that has been successfully generated (1 means 100%). |\n| `number_of_uses` | The number of times the index has been used. |\n| `cleaning` | The index deletion flag. A value of `1` indicates index deletion is in progress. |" }, { "id": "garbage-collection-statistics", "title": "Garbage collection statistics", "role": "content", "text": "| Statistic | Definition |\n|:--- |:--- |\n| `bytes_collected` | The number of bytes collected during garbage collection. |\n| `total_ms_run` | The total time in milliseconds spent on garbage collection. |\n| `total_cycles` | The total number of garbage collection cycles. |\n| `average_cycle_time_ms` | The average time in milliseconds for each garbage collection cycle. The value `nan` indicates that the average cycle time is not available. |\n| `last_run_time_ms` | The time in milliseconds taken by the last garbage collection run. |\n\nThe next two GC-related fields are relevant in scenarios where simultaneous changes occurred in the same memory area for both the parent process and the child process, resulting in the parent discarding these changes.\n\n| Statistic | Definition |\n|:--- |:--- |\n| `gc_numeric_trees_missed` | The number of numeric tree nodes whose changes were discarded due to splitting by the parent process during garbage collection. |\n| `gc_blocks_denied` | The number of blocks whose changes were discarded (skipped) because they were modified by the parent process during the garbage collection. Notably, as inverted index blocks are append-only, only the last block of an inverted index can be skipped. |" }, { "id": "cursor-statistics", "title": "Cursor statistics", "role": "content", "text": "| Statistic | Definition |\n|:--- |:--- |\n| `global_idle` | The number of idle cursors in the system. |\n| `global_total` | The total number of cursors in the system. |\n| `index_capacity` | The maximum number of cursors allowed per index. |\n| `index_total` | The total number of cursors open on the index. |" }, { "id": "other-statistics", "title": "Other statistics", "role": "content", "text": "- Dialect statistics: the number of times the index was searched using each DIALECT, 1 - 4.\n- Index error statistics, including `indexing failures`, `last indexing error`, and `last indexing error key`.\n- Field statistics, including `indexing failures`, `last indexing error`, and `last indexing error key` for each schema field." }, { "id": "example", "title": "Example", "role": "example", "text": "
\nReturn statistics about an index\n\n\n127.0.0.1:6379> ft.info idx:bicycle\n 1) index_name\n 2) idx:bicycle\n 3) index_options\n 4) (empty array)\n 5) index_definition\n 6) 1) key_type\n 2) JSON\n 3) prefixes\n 4) 1) bicycle:\n 5) default_score\n 6) \"1\"\n 7) attributes\n 8) 1) 1) identifier\n 2) $.pickup_zone\n 3) attribute\n 4) pickup_zone\n 5) type\n 6) GEOSHAPE\n 7) coord_system\n 8) SPHERICAL\n 2) 1) identifier\n 2) $.store_location\n 3) attribute\n 4) store_location\n 5) type\n 6) GEO\n 3) 1) identifier\n 2) $.brand\n 3) attribute\n 4) brand\n 5) type\n 6) TEXT\n 7) WEIGHT\n 8) \"1\"\n 4) 1) identifier\n 2) $.model\n 3) attribute\n 4) model\n 5) type\n 6) TEXT\n 7) WEIGHT\n 8) \"1\"\n 5) 1) identifier\n 2) $.description\n 3) attribute\n 4) description\n 5) type\n 6) TEXT\n 7) WEIGHT\n 8) \"1\"\n 6) 1) identifier\n 2) $.price\n 3) attribute\n 4) price\n 5) type\n 6) NUMERIC\n 7) 1) identifier\n 2) $.condition\n 3) attribute\n 4) condition\n 5) type\n 6) TAG\n 7) SEPARATOR\n 8) ,\n 9) num_docs\n10) \"10\"\n11) max_doc_id\n12) \"10\"\n13) num_terms\n14) \"546\"\n15) num_records\n16) \"692\"\n17) inverted_sz_mb\n18) \"0.003993034362792969\"\n19) vector_index_sz_mb\n20) \"0\"\n21) total_inverted_index_blocks\n22) \"551\"\n23) offset_vectors_sz_mb\n24) \"7.047653198242188e-4\"\n25) doc_table_size_mb\n26) \"7.152557373046875e-4\"\n27) sortable_values_size_mb\n28) \"0\"\n29) key_table_size_mb\n30) \"3.0422210693359375e-4\"\n31) geoshapes_sz_mb\n32) \"0.00426483154296875\"\n33) records_per_doc_avg\n34) \"69.19999694824219\"\n35) bytes_per_record_avg\n36) \"6.0505781173706055\"\n37) offsets_per_term_avg\n38) \"1.0679190158843994\"\n39) offset_bits_per_record_avg\n40) \"8\"\n41) hash_indexing_failures\n42) \"0\"\n43) total_indexing_time\n44) \"4.539999961853027\"\n45) indexing\n46) \"0\"\n47) percent_indexed\n48) \"1\"\n49) number_of_uses\n50) (integer) 1\n51) cleaning\n52) (integer) 0\n53) gc_stats\n54) 1) bytes_collected\n 2) \"0\"\n 3) total_ms_run\n 4) \"0\"\n 5) total_cycles\n 6) \"0\"\n 7) average_cycle_time_ms\n 8) \"nan\"\n 9) last_run_time_ms\n 10) \"0\"\n 11) gc_numeric_trees_missed\n 12) \"0\"\n 13) gc_blocks_denied\n 14) \"0\"\n55) cursor_stats\n56) 1) global_idle\n 2) (integer) 0\n 3) global_total\n 4) (integer) 0\n 5) index_capacity\n 6) (integer) 128\n 7) index_total\n 8) (integer) 0\n57) dialect_stats\n58) 1) dialect_1\n 2) (integer) 0\n 3) dialect_2\n 4) (integer) 0\n 5) dialect_3\n 6) (integer) 0\n 7) dialect_4\n 8) (integer) 0\n59) Index Errors\n60) 1) indexing failures\n 2) (integer) 0\n 3) last indexing error\n 4) N/A\n 5) last indexing error key\n 6) \"N/A\"\n61) field statistics\n62) 1) 1) identifier\n 2) $.pickup_zone\n 3) attribute\n 4) pickup_zone\n 5) Index Errors\n 6) 1) indexing failures\n 2) (integer) 0\n 3) last indexing error\n 4) N/A\n 5) last indexing error key\n 6) \"N/A\"\n 2) 1) identifier\n 2) $.store_location\n 3) attribute\n 4) store_location\n 5) Index Errors\n 6) 1) indexing failures\n 2) (integer) 0\n 3) last indexing error\n 4) N/A\n 5) last indexing error key\n 6) \"N/A\"\n 3) 1) identifier\n 2) $.brand\n 3) attribute\n 4) brand\n 5) Index Errors\n 6) 1) indexing failures\n 2) (integer) 0\n 3) last indexing error\n 4) N/A\n 5) last indexing error key\n 6) \"N/A\"\n 4) 1) identifier\n 2) $.model\n 3) attribute\n 4) model\n 5) Index Errors\n 6) 1) indexing failures\n 2) (integer) 0\n 3) last indexing error\n 4) N/A\n 5) last indexing error key\n 6) \"N/A\"\n 5) 1) identifier\n 2) $.description\n 3) attribute\n 4) description\n 5) Index Errors\n 6) 1) indexing failures\n 2) (integer) 0\n 3) last indexing error\n 4) N/A\n 5) last indexing error key\n 6) \"N/A\"\n 6) 1) identifier\n 2) $.price\n 3) attribute\n 4) price\n 5) Index Errors\n 6) 1) indexing failures\n 2) (integer) 0\n 3) last indexing error\n 4) N/A\n 5) last indexing error key\n 6) \"N/A\"\n 7) 1) identifier\n 2) $.condition\n 3) attribute\n 4) condition\n 5) Index Errors\n 6) 1) indexing failures\n 2) (integer) 0\n 3) last indexing error\n 4) N/A\n 5) last indexing error key\n 6) \"N/A\"\n\n
" }, { "id": "redis-software-and-redis-cloud-compatibility", "title": "Redis Software and Redis Cloud compatibility", "role": "content", "text": "| Redis
Software | Redis Cloud
Flexible & Annual | Redis Cloud
Free & Fixed | Notes |\n|:----------------------|:-----------------|:-----------------|:------|\n| ✅ Supported | ✅ Supported | ✅ Supported | |" }, { "id": "return-information", "title": "Return information", "role": "returns", "text": "**RESP2:**\n\nOne of the following:\n* [Array]() of key-value pairs containing index information and statistics.\n* [Simple error reply]() in these cases: no such index.\n\n**RESP3:**\n\nOne of the following:\n* [Map]() containing index information and statistics as key-value pairs.\n* [Simple error reply]() in these cases: no such index." }, { "id": "see-also", "title": "See also", "role": "related", "text": "[`FT.CREATE`]() | [`FT.SEARCH`]() | [`FT.ALIASADD`]() | [`FT.ALIASUPDATE`]()" }, { "id": "related-topics", "title": "Related topics", "role": "related", "text": "[RediSearch]()" } ], "examples": [] }