commande .show database schema
S’applique à : ✅Microsoft Fabric✅Azure Data Explorer
Les commandes suivantes affichent le schéma de base de données sous la forme d’une table, d’un objet JSON ou d’un script CSL.
autorisations
Vous devez disposer au moins des autorisations Utilisateur de base de données, Visionneuse de base de données ou Moniteur de base de données pour exécuter ces commandes. Pour plus d’informations, consultez Contrôle d’accès en fonction du rôle.
.show database schema
Syntaxe
.showdatabase DatabaseName schema [details] [if_later_than « Version"]
.showdatabases (DatabaseName [, ...]) schema details
.showdatabases (DatabaseName if_later_than « Version » [, ...]) schema details
En savoir plus sur les conventions de syntaxe.
Paramètres
| Nom | Type | Requise | Description |
|---|---|---|---|
| DatabaseName | string |
✔️ | Nom de la base de données pour laquelle afficher le schéma. |
| Version | string |
Version au format « vMM.mm ». MM représente la version principale et mm représente la version mineure. |
Retours
Retourne une liste plate de la structure des bases de données sélectionnées avec toutes leurs tables et colonnes dans une seule table ou objet JSON. Lorsqu’elle est utilisée avec une version, la base de données est retournée uniquement s’il s’agit d’une version ultérieure à celle fournie.
Exemples
Afficher le schéma de base de données
L’exemple suivant affiche le TestDB schéma de base de données. La base de données TestDB a une table appelée Events.
.show database TestDB schema
Sortie
| nom_base_de_données | TableName | ColumnName | ColumnType | IsDefaultTable | IsDefaultColumn | PrettyName | Version |
|---|---|---|---|---|---|---|---|
| TestDB | False | False | v.1.1 | ||||
| TestDB | Événements | True | False | ||||
| TestDB | Événements | Nom | System.String | True | False | ||
| TestDB | Événements | StartTime | System.DateTime | True | False | ||
| TestDB | Événements | EndTime | System.DateTime | True | False | ||
| TestDB | Événements | City | System.String | True | False | ||
| TestDB | Événements | SessionId | System.Int32 | True | True |
Afficher le schéma de base de données en fonction de la version
Dans l’exemple suivant, la base de données est retournée uniquement s’il s’agit d’une version ultérieure à celle fournie.
.show database TestDB schema if_later_than "v1.0"
Sortie
| nom_base_de_données | TableName | ColumnName | ColumnType | IsDefaultTable | IsDefaultColumn | PrettyName | Version |
|---|---|---|---|---|---|---|---|
| TestDB | False | False | v.1.1 | ||||
| TestDB | Événements | True | False | ||||
| TestDB | Événements | Nom | System.String | True | False | ||
| TestDB | Événements | StartTime | System.DateTime | True | False | ||
| TestDB | Événements | EndTime | System.DateTime | True | False | ||
| TestDB | Événements | City | System.String | True | False | ||
| TestDB | Événements | SessionId | System.Int32 | True | True |
Étant donné qu’une version inférieure à la version actuelle de la base de données a été fournie, le schéma « TestDB » a été retourné. La fourniture d’une version égale ou ultérieure génère un résultat vide.
.show database schema as json
Syntaxe
.showdatabase DatabaseName schema [if_later_than « Version"] as json
.showdatabases (DatabaseName [, ...]) as schema json [with( Options])
.showdatabases (DatabaseName if_later_than « Version » [, ...]) as schema json [with( Options])
En savoir plus sur les conventions de syntaxe.
Paramètres
| Nom | Type | Requise | Description |
|---|---|---|---|
| DatabaseName | string |
✔️ | Nom de la base de données pour laquelle afficher le schéma. |
| Version | string |
Version au format « vMM.mm ». MM représente la version principale et mm représente la version mineure. | |
| Options | string |
Liste des paires clé-valeur séparées par des virgules utilisées pour déterminer les schémas d’entité de base de données à retourner. Si aucune n’est spécifiée, toutes les entités sont retournées. Consultez les options d’entité prises en charge. |
Options d’entité prises en charge
Le tableau suivant décrit les valeurs à fournir pour le paramètre Options .
| Clé | Valeur | Description |
|---|---|---|
Tables |
bool |
Si true, les tables sont retournées. |
ExternalTables |
bool |
Si true, les tables externes sont retournées. |
MaterializedViews |
bool |
Si true, les vues matérialisées sont retournées. |
Functions |
bool |
Si true, les fonctions sont retournées. |
Retours
Retourne une liste plate de la structure des bases de données sélectionnées avec toutes leurs tables et colonnes sous la forme d’un objet JSON. Lorsqu’elle est utilisée avec une version, la base de données est retournée uniquement s’il s’agit d’une version ultérieure à celle fournie.
Exemples
L’exemple suivant retourne le TestDB schéma de base de données au format JSON.
.show database TestDB schema as json
.show databases (TestDB, TestDB2) schema as json with(Tables=True, Functions=True)
Sortie
"{""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
Génère un script CSL avec toutes les commandes requises pour créer une copie du schéma de base de données donné (ou actuel).
Syntaxe
.showdatabase DatabaseName csl as schema script [with( Options])
En savoir plus sur les conventions de syntaxe.
Paramètres
| Nom | Type | Requise | Description |
|---|---|---|---|
| DatabaseName | string |
✔️ | Nom de la base de données pour laquelle afficher le schéma. |
| Options | string |
Liste des paires clé-valeur séparées par des virgules utilisées pour déterminer ce qu’il faut retourner. Consultez les options prises en charge. |
Options prises en charge
| Clé | Valeur | Description |
|---|---|---|
IncludeEncodingPolicies |
bool |
La valeur par défaut est true. Si true, les stratégies d’encodage au niveau de la base de données/table/colonne sont incluses. |
IncludeSecuritySettings |
bool |
La valeur par défaut est true. Si trueles options suivantes sont incluses :- Principaux autorisés au niveau de la base de données/de la table. - Stratégies de sécurité au niveau des lignes au niveau de la table. - Stratégies d’accès en mode restreint au niveau de la table. |
IncludeIngestionMappings |
bool |
La valeur par défaut est true. Si true, les mappages d’ingestion au niveau de la table sont inclus. |
ShowObfuscatedStrings |
bool |
La valeur par défaut est false. Si trueles informations d’identification persistantes dans les configurations Kusto sont retournées. Pour utiliser cette option, vous devez être un administrateur de base de données ou un créateur d’entité. Si vous n’avez pas ces autorisations, la commande échoue. |
Retours
Le script, retourné sous forme de chaîne, contient :
- Commandes permettant de créer toutes les tables de la base de données.
- Commandes pour définir toutes les stratégies de base de données/tables/colonnes pour qu’elles correspondent aux stratégies d’origine.
- Commandes permettant de créer ou de modifier toutes les fonctions définies par l’utilisateur dans la base de données.
Exemples
Script CSL
L’exemple suivant génère un script CSL avec les commandes nécessaires pour recréer le TestDB schéma de base de données.
.show database TestDB schema as csl script
Script CSL avec des valeurs obfuscatées
L’exemple suivant génère un script CSL avec les commandes nécessaires pour recréer le TestDB schéma de base de données. Il inclut des valeurs qui ont été masquées dans les résultats de l’exemple précédent.
.show database TestDB schema as csl script with (ShowObfuscatedStrings = true)