SHOW INDEX

Описание

Этот оператор выводит информацию об индексах таблицы. Для внутренних таблиц поддерживаются только инвертированные индексы и индексы ann.

Для таблицы в Lance Filesystem Catalog этот оператор выводит логические скалярные и векторные индексы, зарегистрированные в наборе данных Lance. Значения содержатся только в столбцах Table, Key_name, Seq_in_index, Column_name, Index_type и Properties. Lance REST Catalog не поддерживается. Подробнее см. в разделе Просмотр индексов Lance.

Для таблиц в других внешних Catalog, таких как Iceberg и Paimon, этот оператор возвращает пустой результат. Эти форматы предоставляют метаданные таблиц через системные таблицы; см. разделы Системные таблицы Iceberg и Системные таблицы Paimon. Файлы индексов Paimon можно просмотреть через системную таблицу table_indexes.

Синтаксис

SHOW INDEX [ ES ] FROM [ <db_name>. ] <table_name> [ FROM <db_name> ];

Альтернативный синтаксис

SHOW KEY[ S ] FROM [ <db_name>. ] <table_name> [ FROM <db_name> ];

Обязательные параметры

1. <table_name>: Имя таблицы, которой принадлежит индекс.

Необязательные параметры

1. <db_name>: Имя базы данных, необязательный параметр. Если не указано, по умолчанию используется текущая база данных.

Возвращаемое значение

Имя столбца	Тип	Описание
Table	string	Имя таблицы, в которой находится индекс.
Non_unique	int	Указывает, является ли индекс уникальным: - 0: Уникальный индекс - 1: Неуникальный индекс
Key_name	string	Имя индекса.
Seq_in_index	int	Позиция столбца в индексе. Этот столбец показывает порядковый номер столбца в индексе и используется, когда несколько столбцов образуют составной индекс.
Column_name	string	Имя индексируемого столбца.
Collation	string	Порядок сортировки столбца индекса: - A: По возрастанию - D: По убыванию.
Cardinality	int	Количество уникальных значений в индексе. Это значение используется для оценки эффективности запросов; чем оно выше, тем выше селективность индекса и эффективность запросов.
Sub_part	int	Длина префикса, используемого индексом. Если индексируемый столбец имеет строковый тип, Sub_part указывает длину начальной части индекса в символах.
Packed	string	Указывает, сжат ли индекс.
Null	string	Указывает, допускаются ли значения NULL: - YES: Значения NULL допускаются - NO: Значения NULL не допускаются
Index_type	string	Тип индекса: - BTREE: Индекс на основе B+-дерева (тип по умолчанию в MySQL) - HASH: Хеш-индекс - RTREE: Индекс на основе R-дерева - INVERTED: Инвертированный индекс (например, полнотекстовый индекс)
Comment	string	Комментарий или описание индекса, обычно пользовательские примечания.
Properties	string	Дополнительные свойства индекса.

Требования к правам доступа

Пользователь, выполняющий эту команду SQL, должен обладать как минимум следующими правами:

Право	Объект	Примечания
SHOW_PRIV	База данных

Примеры

• Вывести индексы для указанной таблицы table_name

   SHOW INDEX FROM example_db.table_name;

• Вывести логические индексы для таблицы Lance Catalog

   SHOW INDEX FROM lance_catalog.default.items;