INFORMATION_SCHEMA (или information_schema) — это системная база данных, которая предоставляет почти стандартизированное не зависящее от СУБД представление метаданных объектов базы данных. Представления в INFORMATION_SCHEMA обычно уступают обычным системным таблицам, однако инструменты могут использовать их для получения базовой информации единообразным способом в разных СУБД. Предполагается, что структура и содержимое представлений в INFORMATION_SCHEMA будут развиваться с сохранением обратной совместимости, то есть будет добавляться только новая функциональность, а существующая не будет изменяться или удаляться. С точки зрения внутренней реализации представления в INFORMATION_SCHEMA обычно отображаются на обычные системные таблицы, такие как system.columns, system.databases и system.tables.
INFORMATION_SCHEMA содержит следующие представления:
- CHARACTER_SETS
- COLUMNS
- COLUMN_PRIVILEGES
- COLLATIONS
- ENGINES
- KEY_COLUMN_USAGE
- REFERENTIAL_CONSTRAINTS
- SCHEMATA
- SCHEMA_PRIVILEGES
- STATISTICS
- TABLES
- TABLE_PRIVILEGES
- USER_PRIVILEGES
- VIEWS
INFORMATION_SCHEMA.columns, предусмотрены для совместимости с другими базами данных. То же самое относится ко всем столбцам в этих представлениях: доступны варианты как в нижнем регистре (например, table_name), так и в верхнем (TABLE_NAME).
COLUMNS
Содержит столбцы из системной таблицы system.columns, а также столбцы, которые не поддерживаются в ClickHouse или не имеют смысла (всегдаNULL), но должны присутствовать по стандарту.
Столбцы:
table_catalog(String) — Сейчас не используется.table_schema(String) — Сейчас не используется.table_name(String) — Сейчас не используется.non_unique(Int32) — Сейчас не используется.index_schema(String) — Сейчас не используется.index_name(Nullable(String)) — Сейчас не используется.seq_in_index(UInt32) — Сейчас не используется.column_name(Nullable(String)) — Сейчас не используется.collation(Nullable(String)) — Сейчас не используется.cardinality(Nullable(Int64)) — Сейчас не используется.sub_part(Nullable(Int64)) — Сейчас не используется.packed(Nullable(String)) — Сейчас не используется.nullable(String) — Сейчас не используется.index_type(String) — Сейчас не используется.comment(String) — Сейчас не используется.index_comment(String) — Сейчас не используется.is_visible(String) — Сейчас не используется.expression(Nullable(String)) — Сейчас не используется.
Query
Response
SCHEMATA
Содержит столбцы из системной таблицы system.databases, а также столбцы, которые не поддерживаются в ClickHouse или не имеют смысла (всегдаNULL), но требуются стандартом.
Столбцы:
catalog_name(String) — Имя базы данных.schema_name(String) — Имя базы данных.schema_owner(String) — Имя владельца схемы, всегда'default'.default_character_set_catalog(Nullable(String)) —NULL, не поддерживается.default_character_set_schema(Nullable(String)) —NULL, не поддерживается.default_character_set_name(Nullable(String)) —NULL, не поддерживается.sql_path(Nullable(String)) —NULL, не поддерживается.
Query
Response
TABLES
Содержит столбцы из системной таблицы system.tables. Столбцы:table_catalog(String) — Имя базы данных, в которой находится таблица.table_schema(String) — Имя базы данных, в которой находится таблица.table_name(String) — Имя таблицы.table_type(String) — Тип таблицы. Возможные значения:BASE TABLEVIEWFOREIGN TABLELOCAL TEMPORARYSYSTEM VIEW
table_rows(Nullable(UInt64)) — Общее количество строк. NULL, если его не удалось определить.data_length(Nullable(UInt64)) — Размер данных на диске. NULL, если его не удалось определить.index_length(Nullable(UInt64)) — Общий размер первичного ключа, вторичных индексов и всех marks.table_collation(Nullable(String)) — collation таблицы по умолчанию. Всегдаutf8mb4_0900_ai_ci.table_comment(Nullable(String)) — Комментарий, используемый при создании таблицы.
Query
Response
VIEWS
Содержит столбцы из системной таблицы system.tables, считываемые при использовании движка таблицы View. Столбцы:table_catalog(String) — Имя базы данных, в которой находится таблица.table_schema(String) — Имя базы данных, в которой находится таблица.table_name(String) — Имя таблицы.view_definition(String) —SELECT-запрос для представления.check_option(String) —NONE, без проверки.is_updatable(Enum8) —NO, представление не обновляется.is_insertable_into(Enum8) — Показывает, является ли созданное представление материализованным. Возможные значения:NO— Созданное представление не является материализованным.YES— Созданное представление является материализованным.
is_trigger_updatable(Enum8) —NO, триггер не обновляется.is_trigger_deletable(Enum8) —NO, триггер не удаляется.is_trigger_insertable_into(Enum8) —NO, вставка данных в триггер не выполняется.
Query
Response
KEY_COLUMN_USAGE
Содержит столбцы из системной таблицы system.tables, для которых заданы ограничения. Столбцы:constraint_catalog(String) — В настоящее время не используется. Всегдаdef.constraint_schema(String) — Имя схемы (database), к которой относится ограничение.constraint_name(Nullable(String)) — Имя ограничения.table_catalog(String) — В настоящее время не используется. Всегдаdef.table_schema(String) — Имя схемы (database), к которой относится таблица.table_name(String) — Имя таблицы, для которой задано ограничение.column_name(Nullable(String)) — Имя столбца, для которого задано ограничение.ordinal_position(UInt32) — В настоящее время не используется. Всегда1.position_in_unique_constraint(Nullable(UInt32)) — В настоящее время не используется. ВсегдаNULL.referenced_table_schema(Nullable(String)) — В настоящее время не используется. ВсегдаNULL.referenced_table_name(Nullable(String)) — В настоящее время не используется. ВсегдаNULL.referenced_column_name(Nullable(String)) — В настоящее время не используется. ВсегдаNULL.
Query
Response
REFERENTIAL_CONSTRAINTS
Содержит информацию о внешних ключах. В настоящее время возвращает пустой результат (без строк), чего достаточно для совместимости со сторонними инструментами, такими как Tableau Online. Столбцы:constraint_catalog(String) — В настоящее время не используется.constraint_schema(String) — В настоящее время не используется.constraint_name(Nullable(String)) — В настоящее время не используется.unique_constraint_catalog(String) — В настоящее время не используется.unique_constraint_schema(String) — В настоящее время не используется.unique_constraint_name(Nullable(String)) — В настоящее время не используется.match_option(String) — В настоящее время не используется.update_rule(String) — В настоящее время не используется.delete_rule(String) — В настоящее время не используется.table_name(String) — В настоящее время не используется.referenced_table_name(String) — В настоящее время не используется.
STATISTICS
Предоставляет информацию об индексах таблицы. В настоящее время возвращает пустой результат (ни одной строки), чего достаточно для совместимости со сторонними инструментами, такими как Tableau Online.COLLATIONS
Содержит сведения о доступных collation. Включает collation из system.collations, а также две строки для совместимости с MySQL:utf8mb4_0900_ai_ci — collation, которую протокол MySQL объявляет при рукопожатии, в SCHEMATA.DEFAULT_COLLATION_NAME и TABLES.TABLE_COLLATION, — и binary — псевдо-collation, которую протокол MySQL указывает для числовых и других нестроковых столбцов в метаданных набора результатов. Это позволяет клиенту с поддержкой MySQL, который использует объявленные collation для поиска в этом представлении, находить их.
Столбцы:
collation_name(String) — Имя collation.character_set_name(Nullable(String)) — Связанная кодировка (utf8mb4дляutf8mb4_0900_ai_ci,binaryдляbinary, в остальных случаяхNULL). Предоставляется для совместимости с MySQL.id(Nullable(UInt64)) — Идентификатор collation MySQL (255дляutf8mb4_0900_ai_ci,63дляbinary, в остальных случаяхNULL). Предоставляется для совместимости с MySQL.is_default(Nullable(String)) — Является ли collation значением по умолчанию для своей кодировки (Yesдля обеих строк совместимости с MySQL, в остальных случаяхNULL). Предоставляется для совместимости с MySQL.is_compiled(Nullable(String)) — Встроена ли collation в сервер (Yesдля обеих строк совместимости с MySQL, в остальных случаяхNULL). Предоставляется для совместимости с MySQL.sortlen(Nullable(UInt64)) — Минимальная длина сортировки (0дляutf8mb4_0900_ai_ci,1дляbinary, в остальных случаяхNULL). Предоставляется для совместимости с MySQL.pad_attribute(Nullable(String)) — Атрибут заполнения:NO PADилиPAD SPACE(NO PADдля обеих строк совместимости с MySQL, в остальных случаяхNULL). Предоставляется для совместимости с MySQL.
CHARACTER_SETS
Содержит статический список кодировок (utf8, utf8mb4, ascii, binary) для совместимости с инструментами MySQL. Сам ClickHouse работает с UTF-8.
Столбцы:
character_set_name(String) — название кодировки.
ENGINES
Содержит информацию о доступных движках таблиц, полученную из системной таблицы system.table_engines. Предназначена для совместимости с MySQL. Столбцы:engine(String) — имя движка таблицы.support(String) —DEFAULTдля движка, заданного в настройке default_table_engine, в остальных случаях —YES.
USER_PRIVILEGES
Содержит информацию о глобальных привилегиях, считываемую из системной таблицы system.grants (строки, в которых не указана база данных). Представления*_PRIVILEGES показывают только положительные grant без подстановочных шаблонов: частичные отзывы привилегий, grant с подстановочными знаками (например, GRANT SELECT ON db_prefix*.*) и grant на конкретные именованные объекты для параметризованных типов привилегий (например, GRANT TABLE ENGINE ON TinyLog) невозможно представить в MySQL-совместимом формате, поэтому они не выводятся. Как следствие, получатель, ограниченный частичным отзывом, отображается с неограниченным grant. Grant ON * для параметризованных типов отображаются как обычные глобальные привилегии. Основным источником достоверных данных является system.grants. В отличие от MySQL, представления показывают grant всех пользователей и ролей, а для их чтения требуется доступ к system.grants; без него запрос завершается с исключением ACCESS_DENIED. Столбец GRANTOR отсутствует, поскольку ClickHouse не сохраняет сведения о том, кто выдал grant.
Столбцы:
grantee(String) — пользователь или роль, которым выдана привилегия, в формате MySQL:'name'@'%'. У ролей нет аналога в MySQL, поэтому они отображаются так же, как пользователи.table_catalog(String) — всегдаdef.privilege_type(String) — имя привилегии, напримерSELECTилиALTER UPDATE. Полный список см. в system.privileges.is_grantable(String) —YES, если привилегия выдана сWITH GRANT OPTION, иначеNO.grantee_type(String) —USERилиROLE. Нестандартный столбец: в ClickHouse пользователь и роль могут иметь одинаковое имя, и этот столбец позволяет их различать.
SCHEMA_PRIVILEGES
Содержит информацию о привилегиях уровня базы данных, получаемую из системной таблицы system.grants (строки, в которых указана база данных, но не указана таблица). Ограничения, общие для всех представлений*_PRIVILEGES, описаны в разделе USER_PRIVILEGES.
Столбцы:
grantee(String) — пользователь или роль, которым выдана привилегия, в формате MySQL:'name'@'%'.table_catalog(String) — всегдаdef.table_schema(String) — имя базы данных.privilege_type(String) — название привилегии.is_grantable(String) —YES, если привилегия выдана сWITH GRANT OPTION, иначеNO.grantee_type(String) —USERилиROLE. Нестандартный столбец: в ClickHouse пользователь и роль могут иметь одинаковое имя, и этот столбец позволяет различать таких получателей привилегий.
TABLE_PRIVILEGES
Содержит информацию о привилегиях на уровне таблиц, получаемую из системной таблицы system.grants (строки, в которых указана таблица, но не указан столбец). Ограничения, общие для всех представлений*_PRIVILEGES, описаны в разделе USER_PRIVILEGES.
Столбцы:
grantee(String) — пользователь или роль, которым выдана привилегия, в формате MySQL:'name'@'%'.table_catalog(String) — всегдаdef.table_schema(String) — имя базы данных.table_name(String) — имя таблицы.privilege_type(String) — название привилегии.is_grantable(String) —YES, если привилегия выдана сWITH GRANT OPTION, иначеNO.grantee_type(String) —USERилиROLE. Нестандартный столбец: в ClickHouse пользователь и роль могут иметь одинаковые имена, и этот столбец позволяет различить таких получателей привилегий.
COLUMN_PRIVILEGES
Содержит информацию о привилегиях на уровне столбца, получаемую из системной таблицы system.grants (строки, в которых указан столбец; по одной строке на каждый столбец). Ограничения, общие для всех представлений*_PRIVILEGES, описаны в разделе USER_PRIVILEGES.
Столбцы:
grantee(String) — пользователь или роль, которым выдана привилегия, в формате MySQL:'name'@'%'.table_catalog(String) — всегдаdef.table_schema(String) — имя базы данных.table_name(String) — имя таблицы.column_name(String) — имя столбца.privilege_type(String) — название привилегии.is_grantable(String) —YES, если привилегия выдана сWITH GRANT OPTION, иначеNO.grantee_type(String) —USERилиROLE. Нестандартный столбец: в ClickHouse пользователь и роль могут иметь одинаковое имя, и этот столбец позволяет отличить их друг от друга.