Polecenie .show database schema

Następujące polecenia pokazują schemat bazy danych jako tabelę, obiekt JSON lub skrypt CSL.

Uprawnienia

Aby uruchomić te polecenia, musisz mieć co najmniej uprawnienia użytkownika bazy danych, przeglądarki bazy danych lub monitora bazy danych. Aby uzyskać więcej informacji, zobacz Kontrola dostępu oparta na rolach.

.show database schema

Składnia

.showdatabase DatabaseName schema [details] [if_later_than "Wersja"]

.showdatabases (DatabaseName [, ...]) schema details

.showdatabases (DatabaseName if_later_than "Version" [, ...]) schema details

Dowiedz się więcej na temat konwencji składni.

Parametry

Nazwisko	Type	Wymagania	opis
Nazwa bazy danych	string	✔️	Nazwa bazy danych, dla której ma być wyświetlany schemat.
Wersja	string		Wersja w formacie "vMM.mm". Mm reprezentuje wersję główną, a mm reprezentuje wersję pomocniczą.

Zwraca

Zwraca płaską listę struktury wybranych baz danych ze wszystkimi tabelami i kolumnami w pojedynczej tabeli lub obiekcie JSON. W przypadku użycia z wersją baza danych jest zwracana tylko wtedy, gdy jest to nowsza wersja niż podana wersja.

Przykłady

Pokaż schemat bazy danych

Baza danych "TestDB" ma jedną tabelę o nazwie "Events".

.show database TestDB schema 

Wyjście

DatabaseName	TableName	ColumnName	Typ kolumny	IsDefaultTable	IsDefaultColumn	PrettyName	Wersja
TestDB				Fałsz	Fałsz		wersja 1.1
TestDB	Zdarzenia			Prawda	Fałsz
TestDB	Zdarzenia	Nazwisko	System.String	Prawda	Fałsz
TestDB	Zdarzenia	StartTime	System.DateTime	Prawda	Fałsz
TestDB	Zdarzenia	EndTime	System.DateTime	Prawda	Fałsz
TestDB	Zdarzenia	City	System.String	Prawda	Fałsz
TestDB	Zdarzenia	Identyfikator sesji	System.Int32	Prawda	Prawda

Pokaż schemat bazy danych na podstawie wersji

W poniższym przykładzie baza danych jest zwracana tylko wtedy, gdy jest to nowsza wersja niż podana wersja.

.show database TestDB schema if_later_than "v1.0" 

Wyjście

DatabaseName	TableName	ColumnName	Typ kolumny	IsDefaultTable	IsDefaultColumn	PrettyName	Wersja
TestDB				Fałsz	Fałsz		wersja 1.1
TestDB	Zdarzenia			Prawda	Fałsz
TestDB	Zdarzenia	Nazwisko	System.String	Prawda	Fałsz
TestDB	Zdarzenia	StartTime	System.DateTime	Prawda	Fałsz
TestDB	Zdarzenia	EndTime	System.DateTime	Prawda	Fałsz
TestDB	Zdarzenia	City	System.String	Prawda	Fałsz
TestDB	Zdarzenia	Identyfikator sesji	System.Int32	Prawda	Prawda

Ponieważ podano wersję niższą niż bieżąca wersja bazy danych, zwracany został schemat "TestDB". Podanie równej lub wyższej wersji spowodowałoby wygenerowanie pustego wyniku.

.show database schema as json

Składnia

.showdatabase DatabaseName schema [if_later_than "Version"] as json

.showdatabases (DatabaseName [, ...]) as schema json [with( Opcje])

.showdatabases (DatabaseName if_later_than "Version" [, ...]) as schema json [with( Opcje])

Dowiedz się więcej na temat konwencji składni.

Parametry

Nazwisko	Type	Wymagania	opis
Nazwa bazy danych	string	✔️	Nazwa bazy danych, dla której ma być wyświetlany schemat.
Wersja	string		Wersja w formacie "vMM.mm". Mm reprezentuje wersję główną, a mm reprezentuje wersję pomocniczą.
Opcje	string		Lista par klucz-wartość rozdzielona przecinkami używana do określania schematów jednostek bazy danych do zwrócenia. Jeśli żadna z nich nie zostanie określona, zostaną zwrócone wszystkie jednostki. Zobacz obsługiwane opcje jednostki.

Obsługiwane opcje jednostki

W poniższej tabeli opisano wartości, które należy podać dla parametru Opcje .

Key	Wartość	Opis
Tables	bool	Jeśli truezwracane są tabele .
ExternalTables	bool	Jeśli truezwracane są tabele zewnętrzne.
MaterializedViews	bool	Jeśli truezostaną zwrócone zmaterializowane widoki.
Functions	bool	Jeśli truefunkcja jest zwracana.

Zwraca

Zwraca płaską listę struktury wybranych baz danych ze wszystkimi tabelami i kolumnami jako obiekt JSON. W przypadku użycia z wersją baza danych jest zwracana tylko wtedy, gdy jest to nowsza wersja niż podana wersja.

Przykłady

.show database TestDB schema as json

.show databases (TestDB, TestDB2) schema as json with(Tables=True, Functions=True)

Wyjście

"{""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 (Pokaż schemat bazy danych jako skrypt csl)

Generuje skrypt CSL ze wszystkimi wymaganymi poleceniami, aby utworzyć kopię danego (lub bieżącego) schematu bazy danych.

Składnia

.showdatabase DatabaseName csl as schema script [with( Opcje])

Dowiedz się więcej na temat konwencji składni.

Parametry

Nazwisko	Type	Wymagania	opis
Nazwa bazy danych	string	✔️	Nazwa bazy danych, dla której ma być wyświetlany schemat.
Opcje	string		Lista par klucz-wartość rozdzielona przecinkami używana do określenia, co należy zwrócić. Zobacz obsługiwane opcje.

Obsługiwane opcje

Key	Wartość	Opis
IncludeEncodingPolicies	bool	Wartość domyślna to true. Jeśli truezostaną uwzględnione zasady kodowania na poziomie bazy danych/tabeli/kolumny.
IncludeSecuritySettings	bool	Wartość domyślna to true. Jeśli truesą dostępne następujące opcje: - Autoryzowane podmioty zabezpieczeń na poziomie bazy danych/tabeli. — Zasady zabezpieczeń na poziomie wiersza na poziomie tabeli. — Zasady dostępu do widoku z ograniczeniami na poziomie tabeli.
IncludeIngestionMappings	bool	Wartość domyślna to true. Jeśli truezostaną uwzględnione mapowania pozyskiwania na poziomie tabeli.
ShowObfuscatedStrings	bool	Wartość domyślna to false. Jeśli truezwracane są poświadczenia utrwalone w konfiguracjach usługi Kusto. Aby użyć tej opcji, musisz być administratorem bazy danych lub twórcą jednostki. Jeśli nie masz tych uprawnień, polecenie zakończy się niepowodzeniem.

Zwraca

Skrypt zwrócony jako ciąg będzie zawierać następujące elementy:

• Polecenia umożliwiające utworzenie wszystkich tabel w bazie danych.
• Polecenia ustawiania wszystkich zasad bazy danych/tabel/kolumn w celu dopasowania ich do oryginalnych zasad.
• Polecenia służące do tworzenia lub zmieniania wszystkich funkcji zdefiniowanych przez użytkownika w bazie danych.

Przykłady

.show database TestDB schema as csl script

.show database TestDB schema as csl script with (ShowObfuscatedStrings = true)