Konwencje składni dla dokumentacji referencyjnej

  • Artykuł

W tym artykule opisano konwencje składni opisane w dokumentacji referencyjnej poleceń język zapytań Kusto (KQL) i zarządzania.

Konwencje składniowe

Konwencja Opis
Block Literały ciągu, które mają być wprowadzane dokładnie tak, jak pokazano.
Kursywa Parametry do podania wartości przy użyciu funkcji lub polecenia.
[ ] Oznacza, że element ujęty jest opcjonalny.
( ) Oznacza, że wymagany jest co najmniej jeden z ujętych elementów.
| (potok) Używane w nawiasach kwadratowych lub okrągłych, aby określić jeden z elementów oddzielonych znakiem potoku. W tym formularzu potok jest odpowiednikiem operatora logicznego OR. W bloku (|) potok jest częścią składni zapytania KQL.
[, ...] Wskazuje, że powyższy parametr może być powtarzany wiele razy, rozdzielony przecinkami.
; Terminator instrukcji query.

Przykłady

Funkcja skalarna

W tym przykładzie przedstawiono składnię i przykładowe użycie funkcji skrótu, a następnie wyjaśnienie sposobu tłumaczenia każdego składnika składni na przykładowe użycie.

Składnia

hash(źródło [,mod])

Przykład użycia

hash("World")
  • Nazwa funkcji , hashi nawias otwierający są wprowadzane dokładnie tak, jak pokazano.
  • Wyrażenie "World" jest przekazywane jako argument wymaganego parametru źródłowego .
  • Żaden argument nie jest przekazywany dla parametru mod , który jest opcjonalny, jak wskazuje nawiasy kwadratowe.
  • Nawias zamykający jest wprowadzany dokładnie tak, jak pokazano.

Operator tabelaryczny

W tym przykładzie przedstawiono składnię i przykładowe użycie operatora sortowania, a następnie wyjaśnienie sposobu tłumaczenia każdego składnika składni na przykładowe użycie.

Składnia

T| sort bykolumna [] [ascnulls firstdesc | | nulls last] [, ...]

Przykład użycia

StormEvents
| sort by State asc, StartTime desc
  • Tabela StormEvents jest przekazywana jako argument wymaganego parametru T .
  • | sort by jest wprowadzana dokładnie tak, jak pokazano. W tym przypadku znak potoku jest częścią składni instrukcji wyrażenia tabelarycznego , reprezentowanej przez tekst bloku. Aby dowiedzieć się więcej, zobacz Co to jest instrukcja zapytania.
  • Kolumna State jest przekazywana jako argument dla wymaganego parametru kolumny z flagą opcjonalną asc .
  • Po przecinku zostanie przekazany inny zestaw argumentów: kolumna StartTime z flagą opcjonalną desc . Składnia [, ...] wskazuje, że można przekazać więcej zestawów argumentów, ale nie są wymagane.

Praca z opcjonalnymi parametrami

Aby podać argument dla opcjonalnego parametru, który pochodzi po innym opcjonalnym parametrze, należy podać argument dla poprzedniego parametru. To wymaganie jest spowodowane tym, że argumenty muszą być zgodne z kolejnością określoną w składni. Jeśli nie masz określonej wartości do przekazania dla parametru, użyj pustej wartości tego samego typu.

Przykład sekwencyjnych parametrów opcjonalnych

Rozważ składnię wtyczki http_request:

evaluatehttp_request(Identyfikator URI [RequestHeaders [,,Opcje]])

RequestHeaders i Opcje są opcjonalnymi parametrami typu dynamic. Aby podać argument parametru Opcje , należy również podać argument parametru RequestHeaders . W poniższym przykładzie pokazano, jak podać pustą wartość pierwszego opcjonalnego parametru RequestHeaders, aby móc określić wartość drugiego opcjonalnego parametru Opcje.

evaluate http_request ( "https://contoso.com/", dynamic({}), dynamic({ EmployeeName: Nicole }) )

Zawartość pokrewna