Syntaxkonventioner för referensdokumentation

  • Artikel

Den här artikeln beskriver syntaxkonventionerna som följs i referensdokumentationen för Kusto-frågespråk (KQL) och hanteringskommandon.

Syntaxkonventioner

Konvention Description
Block Strängliteraler som ska anges exakt som visas.
Kursiv stil Parametrar som ska anges som ett värde vid användning av funktionen eller kommandot.
[ ] Anger att det omslutna objektet är valfritt.
( ) Anger att minst ett av de omslutna objekten krävs.
| (rör) Används inom hakparenteser eller runda hakparenteser för att ange att du kan ange något av objekten avgränsat med pipe-tecknet. I det här formatet motsvarar röret den logiska OR-operatorn. När du är i ett block (|) är röret en del av KQL-frågesyntaxen.
[, ...] Anger att föregående parameter kan upprepas flera gånger, avgränsade med kommatecken.
; Frågeuttrycksavslutare.

Exempel

Scalar-funktion

Det här exemplet visar syntaxen och ett exempel på användning av hashfunktionen, följt av en förklaring av hur varje syntaxkomponent översätts till exempelanvändningen.

Syntax

hash(källa [,mod])

Exempel på användning

hash("World")
  • Namnet på funktionen , hashoch den inledande parentesen anges exakt som det visas.
  • "World" skickas som ett argument för den obligatoriska källparametern.
  • Inget argument skickas för mod-parametern , vilket är valfritt enligt hakparenteserna.
  • Den avslutande parentesen anges exakt som det visas.

Tabelloperator

Det här exemplet visar syntaxen och ett exempel på användning av sorteringsoperatorn, följt av en förklaring av hur varje syntaxkomponent översätts till exempelanvändningen.

Syntax

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

Exempel på användning

StormEvents
| sort by State asc, StartTime desc
  • Tabellen StormEvents skickas som ett argument för den obligatoriska T-parametern .
  • | sort by anges exakt som det visas. I det här fallet är pipe-tecknet en del av syntaxen för tabelluttrycksuttryck , som representeras av blocktexten. Mer information finns i Vad är en frågeuttryck.
  • Kolumnen State skickas som ett argument för den obligatoriska kolumnparametern med den valfria asc flaggan.
  • Efter ett kommatecken skickas en annan uppsättning argument: kolumnen StartTime med den valfria desc flaggan. Syntaxen [, ...] anger att fler argumentuppsättningar kan skickas men inte krävs.

Arbeta med valfria parametrar

Om du vill ange ett argument för en valfri parameter som kommer efter en annan valfri parameter måste du ange ett argument för föregående parameter. Det här kravet beror på att argumenten måste följa den ordning som anges i syntaxen. Om du inte har ett specifikt värde att skicka för parametern använder du ett tomt värde av samma typ.

Exempel på sekventiella valfria parametrar

Överväg syntaxen för plugin-programmet http_request:

evaluatehttp_request(Uri [,RequestHeaders [,alternativ]] )

RequestHeaders och Alternativ är valfria parametrar av typen dynamisk. Om du vill ange ett argument för parametern Alternativ måste du också ange ett argument för parametern RequestHeaders . I följande exempel visas hur du anger ett tomt värde för den första valfria parametern , RequestHeaders, för att kunna ange ett värde för den andra valfria parametern , Alternativ.

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

Relaterat innehåll