.create függvényparancs

  • Cikk

Létrehoz egy tárolt függvényt, amely egy újrafelhasználható KQL-lekérdezés, a megadott névvel. A függvénydefiníció megmarad az adatbázis metaadataival.

A függvények más függvényeket is meghívhatnak (a rekurzívság nem támogatott). Emellett a letfüggvény törzsének részeként is megengedettek az utasítások. Lásd:let utasítások.

A paramétertípusokra és a CSL-utasításokra vonatkozó szabályok megegyeznek az utasításokra vonatkozólet szabályokkal.

Engedélyek

A parancs futtatásához legalább adatbázis-felhasználó engedéllyel kell rendelkeznie.

Syntax

.createfunction [ ifnotexists ] [ with(propertyName=propertyValue [, ...]) ] functionName(Paraméterek){Szervezet}

További információ a szintaxis konvenciókról.

Paraméterek

Név Típus Kötelező Leírás
ifnotexists string Ha meg van adva, a függvény csak akkor jön létre, ha a függvény még nem létezik.
functionName string ✔️ A létrehozandó vagy módosítandó függvény neve.
propertyName, propertyValue string Kulcs-érték tulajdonságpárok vesszővel tagolt listája. Tekintse meg a támogatott tulajdonságokat.
paraméterek string A függvény által igényelt paraméterek vesszővel tagolt listája. Az egyes paraméterek formátumának ParameterName:ParameterDataType értéknek kell lennie.
Szervezet string ✔️ Felhasználó által definiált függvénykifejezés.

Támogatott tulajdonságok

Név Típus Description
docstring string A függvény leírása felhasználói felületi célokra.
folder string A felhasználói felületi függvények kategorizálásához használt mappa neve.
view bool Ezt a függvényt tárolt nézetként jelöli meg. A tárolt nézetek részt vehetnek a keresési és egyesítő * forgatókönyvekben. További információ: Nézetek.
skipvalidation bool Meghatározza, hogy futtassa-e az érvényesítési logikát a függvényen, és meghiúsul-e a folyamat, ha a függvény érvénytelen. A mező alapértelmezett értéke: false.

Tipp

Ha egy függvény fürtök közötti lekérdezéseket tartalmaz, és egy Kusto lekérdezésnyelv szkripttel tervezi újra létrehozni a függvényt, állítsa a következőreskipvalidation: true.

Válaszok

Kimeneti paraméter Típus Leírás
Név string A függvény neve.
Paraméterek string A függvény által igényelt paraméterek.
Törzs string (Nulla vagy több) let függvényhíváskor kiértékelt érvényes CSL-kifejezés.
Mappa string A felhasználói felületi függvények kategorizálásához használt mappa. Ez a paraméter nem módosítja a függvény meghívásának módját.
DocString string A függvény leírása felhasználói felületi célokra.

Megjegyzés

  • Ha a függvény már létezik:
    • Ha ifnotexists a jelölő meg van adva, a rendszer figyelmen kívül hagyja a parancsot (nincs módosítás alkalmazva).
    • Ha ifnotexists a jelölő NINCS megadva, a rendszer hibát ad vissza.
    • Meglévő függvény módosításáról lásd: .alter function
  • Az utasítások nem minden adattípust let támogatnak. Támogatott típusok: logikai, sztring, hosszú, datetime, időtartomány, dupla és dinamikus.
  • A függvénnyel skipvalidation kihagyhatja a szemantikai ellenőrzést. Ez akkor hasznos, ha a függvények helytelen sorrendben jönnek létre, és az F2-t használó F1 korábban jön létre.

Példák

Egyszerű demo függvény

.create function 
with (docstring = 'Simple demo function', folder='Demo')
MyFunction1()  {StormEvents | take 100}
Name Paraméterek Törzs Mappa DocString
MyFunction1 () {StormEvents | take 100} Bemutató Egyszerű demo függvény

Demo függvény paraméterrel

.create function
with (docstring = 'Demo function with parameter', folder='Demo')
 MyFunction2(myLimit: long)  {StormEvents | take myLimit}
Name Paraméterek Törzs Mappa DocString
MyFunction2 (myLimit:long) {StormEvents | take myLimit} Bemutató Demo függvény paraméterrel