Syntaxisconventies voor referentiedocumentatie

  • Artikel

In dit artikel worden de syntaxisconventies beschreven die worden gevolgd in de referentiedocumentatie Kusto-querytaal (KQL) en beheeropdrachten.

Syntaxisconventies

Conventie Description
Block Letterlijke tekenreeksen die exact moeten worden ingevoerd zoals weergegeven.
Cursief Parameters die een waarde moeten worden opgegeven bij gebruik van de functie of opdracht.
[ ] Geeft aan dat het ingesloten item optioneel is.
( ) Geeft aan dat ten minste één van de bijgesloten items is vereist.
| (pijp) Tussen vierkante of ronde haken om aan te geven dat u een van de items kunt opgeven, gescheiden door het sluisteken. In dit formulier is de pipe gelijk aan de logische OF-operator. In een blok (|) maakt de pipe deel uit van de KQL-querysyntaxis.
[, ...] Geeft aan dat de voorgaande parameter meerdere keren kan worden herhaald, gescheiden door komma's.
; Eindteken van query-instructie.

Voorbeelden

Scalaire functie

In dit voorbeeld ziet u de syntaxis en een voorbeeldgebruik van de hashfunctie, gevolgd door een uitleg van hoe elk syntaxisonderdeel wordt omgezet in het voorbeeldgebruik.

Syntax

hash(bron [,mod])

Gebruiksvoorbeelden

hash("World")
  • De naam van de functie, hash, en het haakje openen worden precies zo ingevoerd als weergegeven.
  • 'Wereld' wordt doorgegeven als argument voor de vereiste bronparameter .
  • Er wordt geen argument doorgegeven voor de parameter mod , die optioneel is zoals aangegeven door de vierkante haken.
  • Het haakje sluiten wordt precies zo ingevoerd als weergegeven.

Tabellaire operator

In dit voorbeeld ziet u de syntaxis en een voorbeeldgebruik van de sorteeroperator, gevolgd door een uitleg van hoe elk syntaxisonderdeel wordt omgezet in het voorbeeldgebruik.

Syntax

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

Gebruiksvoorbeelden

StormEvents
| sort by State asc, StartTime desc
  • De tabel StormEvents wordt doorgegeven als argument voor de vereiste T-parameter .
  • | sort by wordt precies ingevoerd zoals weergegeven. In dit geval maakt het sluisteken deel uit van de syntaxis van de tabellaire expressie , zoals vertegenwoordigd door de bloktekst. Zie Wat is een query-instructie? voor meer informatie.
  • De kolom Status wordt doorgegeven als een argument voor de vereiste kolomparameter met de optionele asc vlag.
  • Na een komma wordt een andere set argumenten doorgegeven: de kolom StartTime met de optionele desc vlag. De syntaxis [, ...] geeft aan dat er meer argumentensets kunnen worden doorgegeven, maar niet vereist zijn.

Werken met optionele parameters

Als u een argument wilt opgeven voor een optionele parameter die na een andere optionele parameter komt, moet u een argument opgeven voor de vorige parameter. Deze vereiste is omdat argumenten de volgorde moeten volgen die is opgegeven in de syntaxis. Als u geen specifieke waarde hebt om door te geven voor de parameter, gebruikt u een lege waarde van hetzelfde type.

Voorbeeld van sequentiële optionele parameters

Bekijk de syntaxis voor de http_request-invoegtoepassing:

evaluatehttp_request(URI [,RequestHeaders [,Opties]] )

RequestHeaders en Opties zijn optionele parameters van het type dynamisch. Als u een argument wilt opgeven voor de parameter Opties , moet u ook een argument opgeven voor de parameter RequestHeaders . In het volgende voorbeeld ziet u hoe u een lege waarde opgeeft voor de eerste optionele parameter , RequestHeaders, om een waarde op te kunnen geven voor de tweede optionele parameter, Opties.

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

Gerelateerde inhoud