.create függvény parancs

Szolgáltatások váltása a Verzió legördülő listával. További információ a navigációról.
A következőre vonatkozik: ✅ Microsoft Fabric ✅ Azure Data Explorer

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 let utasítások is megengedettek a függvénytörzsrészeként. Lásd let utasítások.

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

Engedélyek

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

Szintaxis

.create function [ ifnotexists ] [ with(propertyName=propertyValue [, ...]) ] functionName(parameters){törzs}

További információ szintaxiskonvenciákról.

Paraméterek

Név Típus Szükséges 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étrehozni vagy módosítani kívánt függvény neve.
propertyName, propertyValue string Kulcs-érték tulajdonságpárok vesszővel tagolt listája. Lásd 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:ParameterDataTypekell lennie.
törzs string ✔️ Felhasználó által definiált függvénykifejezés.

Támogatott tulajdonságok

Név Típus Leírás
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 keresési és unió * forgatókönyvekben. További információ: Nézetek.
skipvalidation bool Meghatározza, hogy futtasson-e érvényesítési logikát a függvényen, és meghiúsul-e a folyamat, ha a függvény érvénytelen. Az alapértelmezett érték a false.

Borravaló

Ha egy függvény fürtközi lekérdezéseket, és Kusto lekérdezési nyelvi szkriptteltervezi újra létrehozni a függvényt, állítsa skipvalidationtrueértékre.

Visszatér

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.
Test string (Nulla vagy több) let utasítások, majd egy érvényes CSL-kifejezés, amelyet függvényhíváskor értékel ki a rendszer.
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.

Jegyzet

  • Ha a függvény már létezik:
    • Ha ifnotexists jelölő van megadva, a parancs figyelmen kívül lesz hagyva (nincs módosítás alkalmazva).
    • Ha ifnotexists jelölő NINCS megadva, a függvény hibát ad vissza.
    • Meglévő függvény módosításáról lásd: .alter function
  • Nem minden adattípus támogatott let utasításokban. A támogatott típusok a következők: logikai, sztring, hosszú, dátumidő, időbélyeg, dupla és dinamikus.
  • A skipvalidation használatával kihagyhatja a függvény szemantikai ellenőrzését. 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ű függvény

Az alábbi példa létrehozza a MyFunction1 függvényt egy leírással (docstring), egy Demonevű mappával, és meghatározza a függvényt.

.create function 
with (docstring = 'Simple demo function', folder='Demo')
MyFunction1()
{StormEvents | take 100}
Név Paraméterek Test Mappa DocString
MyFunction1 () {StormEvents | take 100} Tüntetés Egyszerű bemutató függvény

Függvény paraméterrel

Az alábbi példa létrehozza a MyFunction2 függvényt egy leírással (docstring), Demonevű mappával, és meghatározza a Mytimestamp paramétert.

.create function with (docstring = "Demo function with date parameter",folder = "Demo") 
 MyFunction2(Mytimestamp:datetime) {
    StormEvents
    | where EndTime <= Mytimestamp
 }
Név Paraméterek Test Mappa DocString
MyFunction2 (Mytimestamp:datetime) {StormEvents | where EndTime <= Mytimestamp} Tüntetés Demo függvény dátumparaméterrel