Konvence syntaxe pro referenční dokumentaci

  • Článek

Tento článek popisuje konvence syntaxe v referenční dokumentaci k dotazovací jazyk Kusto (KQL) a příkazy pro správu.

Konvence syntaxe

Konvence Description
Block Řetězcové literály, které mají být zadány přesně podle obrázku.
Kurzíva Parametry, které se mají zadat jako hodnota při použití funkce nebo příkazu.
[ ] Označuje, že uzavřená položka je nepovinná.
( ) Označuje, že je vyžadována alespoň jedna z uzavřených položek.
| (potrubí) Používá se v hranatých nebo kulatých závorkách k označení, že můžete zadat jednu z položek oddělených znakem svislé čáry. V tomto formuláři je kanál ekvivalentní logickému operátoru OR. V bloku (|) je kanál součástí syntaxe dotazu KQL.
[, ...] Označuje, že předchozí parametr lze opakovat vícekrát a oddělit ho čárkami.
; Ukončovač příkazů dotazu.

Příklady

Skalární funkce

Tento příklad ukazuje syntaxi a ukázkové použití hashovací funkce a vysvětlení, jak se jednotlivé komponenty syntaxe překládají do ukázkového použití.

Syntax

hash(source [,mod])

Příklad použití

hash("World")
  • Název funkce a levá závorka jsou zadány přesně tak, hashjak je znázorněno na obrázku.
  • "World" se předá jako argument požadovaného parametru zdroje .
  • Pro parametr mod se nepředá žádný argument, který je volitelný, jak je uvedeno v hranatých závorkách.
  • Pravá závorka je zadána přesně tak, jak je znázorněno na obrázku.

Tabulkový operátor

Tento příklad ukazuje syntaxi a ukázkové použití operátoru řazení a vysvětlení, jak se jednotlivé komponenty syntaxe překládají do ukázkového použití.

Syntax

T| sort bycolumn [asc | desc] [nulls first | nulls last] [, ...]

Příklad použití

StormEvents
| sort by State asc, StartTime desc
  • Tabulka StormEvents se předává jako argument pro požadovaný parametr T .
  • | sort by se zadává přesně tak, jak je znázorněno. V tomto případě je znak roury součástí syntaxe tabulkového výrazu , který je reprezentován textem bloku. Další informace najdete v tématu Co je příkaz dotazu.
  • Sloupec State se předá jako argument požadovaného parametru sloupce s volitelným asc příznakem.
  • Za čárkou se předá další sada argumentů: sloupec StartTime s volitelným desc příznakem. Syntaxe [, ...] označuje, že může být předáno více sad argumentů, ale nejsou povinné.

Práce s volitelnými parametry

Chcete-li zadat argument pro volitelný parametr, který následuje po jiném volitelném parametru, musíte zadat argument pro předchozí parametr. Tento požadavek je ten, že argumenty musí odpovídat pořadí zadanému v syntaxi. Pokud pro parametr nemáte konkrétní hodnotu, použijte prázdnou hodnotu stejného typu.

Příklad sekvenčních volitelných parametrů

Zvažte syntaxi modulu plug-in http_request:

evaluatehttp_request(Uri [,RequestHeaders [,Možnosti]] )

RequestHeaders a Options jsou volitelné parametry typu dynamic. Chcete-li zadat argument pro parametr Options , musíte také zadat argument pro parametr RequestHeaders . Následující příklad ukazuje, jak zadat prázdnou hodnotu prvního volitelného parametru RequestHeaders, aby bylo možné zadat hodnotu pro druhý volitelný parametr Options.

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

Související obsah