Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Переключайте службы с помощью раскрывающегося списка Версия. Дополнительные сведения о навигации.
Область применения: ✅ Microsoft Fabric ✅ Azure Data Explorer
Следующие команды показывают схему базы данных как таблицу, объект JSON или скрипт CSL.
Разрешения
Для выполнения этих команд необходимо иметь по крайней мере разрешения пользователя базы данных, средства просмотра баз данных или монитора баз данных. Дополнительные сведения см. в разделе "Управление доступом на основе ролей".
Схема базы данных .show
Синтаксис
.show
database
schema Имя_базы данных [details] [ if_later_than "Версия"]
.show
databases
(
DatabaseName [, ...])schemadetails
.show
databases
(
if_later_than
Имя базы данных "Версия" [, ...])schemadetails
Дополнительные сведения о соглашениях синтаксиса.
Параметры
| Имя (название) | Type | Обязательно | Описание |
|---|---|---|---|
| DatabaseName | string |
✔️ | Имя базы данных, для которой будет отображаться схема. |
| Версия | string |
Версия в формате "vMM.mm". MM представляет основную версию и мм представляет дополнительную версию. |
Возвраты
Возвращает плоский список структуры выбранных баз данных со всеми таблицами и столбцами в одной таблице или объекте JSON. При использовании с версией база данных возвращается только в том случае, если она является более поздней, чем указанная версия.
Примеры
Показать схему базы данных
В следующем примере показана TestDB схема базы данных. База данных TestDB имеет одну таблицу Events.
.show database TestDB schema
Выходные данные
| имя_базы_данных | TableName | ColumnName | ColumnType | IsDefaultTable | IsDefaultColumn | PrettyName | Версия |
|---|---|---|---|---|---|---|---|
| TestDB | False | False | v.1.1 | ||||
| TestDB | События | Истина | False | ||||
| TestDB | События | Имя (название) | System.String | Истина | False | ||
| TestDB | События | Время начала | System.DateTime | Истина | False | ||
| TestDB | События | EndTime | System.DateTime | Истина | False | ||
| TestDB | События | Город | System.String | Истина | False | ||
| TestDB | События | ИД сеанса | System.Int32 | Истина | Истина |
Отображение схемы базы данных на основе версии
В следующем примере база данных возвращается только в том случае, если она является более поздней версией, чем указана версия.
.show database TestDB schema if_later_than "v1.0"
Выходные данные
| имя_базы_данных | TableName | ColumnName | ColumnType | IsDefaultTable | IsDefaultColumn | PrettyName | Версия |
|---|---|---|---|---|---|---|---|
| TestDB | False | False | v.1.1 | ||||
| TestDB | События | Истина | False | ||||
| TestDB | События | Имя (название) | System.String | Истина | False | ||
| TestDB | События | Время начала | System.DateTime | Истина | False | ||
| TestDB | События | EndTime | System.DateTime | Истина | False | ||
| TestDB | События | Город | System.String | Истина | False | ||
| TestDB | События | ИД сеанса | System.Int32 | Истина | Истина |
Так как была указана версия ниже текущей версии базы данных, была возвращена схема TestDB. Предоставление равной или более поздней версии приведет к возникновению пустого результата.
.show database schema as json
Синтаксис
.show
database
DatabaseNameschema [if_later_than"Версия"] asjson
.show
databases
(
DatabaseName [, ...])schemaasjson [with( Параметры])
.show
databases
(
DatabaseNameif_later_than"Version" [, ...])schemaasjson [with( Параметры])
Дополнительные сведения о соглашениях синтаксиса.
Параметры
| Имя (название) | Type | Обязательно | Описание |
|---|---|---|---|
| DatabaseName | string |
✔️ | Имя базы данных, для которой будет отображаться схема. |
| Версия | string |
Версия в формате "vMM.mm". MM представляет основную версию и мм представляет дополнительную версию. | |
| Параметры | string |
Список пар "ключ-значение", разделенных запятыми, используемых для определения возвращаемых схем сущностей базы данных. Если ни один из них не указан, возвращаются все сущности. См . поддерживаемые параметры сущности. |
Поддерживаемые параметры сущности
В следующей таблице описываются значения для параметра Options .
| Ключ | значение | Описание |
|---|---|---|
Tables |
bool |
Если trueвозвращается таблица. |
ExternalTables |
bool |
Если trueвозвращаются внешние таблицы. |
MaterializedViews |
bool |
Если trueвозвращаются материализованные представления. |
Functions |
bool |
Если trueвозвращаются функции. |
Возвраты
Возвращает плоский список структуры выбранных баз данных со всеми таблицами и столбцами в виде объекта JSON. При использовании с версией база данных возвращается только в том случае, если она является более поздней, чем указанная версия.
Примеры
В следующем примере возвращается TestDB схема базы данных в формате JSON.
.show database TestDB schema as json
.show databases (TestDB, TestDB2) schema as json with(Tables=True, Functions=True)
Выходные данные
"{""Databases"":{""TestDB"":{""Name"":""TestDB"",""Tables"":{""Events"":{""Name"":""Events"",""DefaultColumn"":null,""OrderedColumns"":[{""Name"":""Name"",""Type"":""System.String""},{""Name"":""StartTime"",""Type"":""System.DateTime""},{""Name"":""EndTime"",""Type"":""System.DateTime""},{""Name"":""City"",""Type"":""System.String""},{""Name"":""SessionId"",""Type"":""System.Int32""}]}},""PrettyName"":null,""MajorVersion"":1,""MinorVersion"":1,""Functions"":{}}}}"
.show database schema as csl script
Создает скрипт CSL со всеми необходимыми командами для создания копии указанной (или текущей) схемы базы данных.
Синтаксис
.show
database
DatabaseNameschemaascslscript [with( Параметры])
Дополнительные сведения о соглашениях синтаксиса.
Параметры
| Имя (название) | Type | Обязательно | Описание |
|---|---|---|---|
| DatabaseName | string |
✔️ | Имя базы данных, для которой будет отображаться схема. |
| Параметры | string |
Список пар "ключ-значение", разделенных запятыми, используемых для определения возвращаемого значения. См . поддерживаемые параметры. |
Поддерживаемые параметры
| Ключ | значение | Описание |
|---|---|---|
IncludeEncodingPolicies |
bool |
По умолчанию — true. Если trueполитики кодирования на уровне базы данных или таблицы или столбца включены. |
IncludeSecuritySettings |
bool |
По умолчанию — true. Если trueвключены следующие параметры:— Авторизованные субъекты на уровне базы данных или таблицы. — Политики безопасности на уровне строк на уровне таблицы. — Политики доступа к ограниченному представлению на уровне таблицы. |
IncludeIngestionMappings |
bool |
По умолчанию — true. Если trueсопоставления приема на уровне таблицы включены. |
ShowObfuscatedStrings |
bool |
По умолчанию — false. Если trueвозвращаются учетные данные, сохраненные в конфигурациях Kusto. Чтобы использовать этот параметр, необходимо быть администратором базы данных или создателем сущностей. Если у вас нет этих разрешений, команда завершается ошибкой. |
Возвраты
Скрипт, возвращаемый в виде строки, содержит следующее:
- Команды для создания всех таблиц в базе данных.
- Команды, чтобы задать все политики базы данных, таблицы и столбцы, соответствующие исходным политикам.
- Команды для создания или изменения всех пользовательских функций в базе данных.
Примеры
Скрипт CSL
В следующем примере создается скрипт CSL с необходимыми командами для повторного TestDB создания схемы базы данных.
.show database TestDB schema as csl script
Скрипт CSL со скрытыми значениями
В следующем примере создается скрипт CSL с необходимыми командами для повторного TestDB создания схемы базы данных. Он содержит значения, которые были замаскированы в результатах предыдущего примера.
.show database TestDB schema as csl script with (ShowObfuscatedStrings = true)