Kusto CLI

A Kusto.Cli egy parancssori segédprogram, amely lekérdezéseket és vezérlőparancsokat küld egy Kusto-fürtön. Többféle módban is futtatható:

• REPL mód: A felhasználó lekérdezéseket és parancsokat ad meg, és az eszköz megjeleníti az eredményeket, majd várja a következő felhasználói lekérdezést/parancsot. ("A REPL a "read/eval/print/loop" rövidítése.)

• Végrehajtási mód: A felhasználó egy vagy több lekérdezést és parancsot ad meg parancssori argumentumként való futtatáshoz. Az argumentumok automatikusan egymás után futnak, és az eredmények a konzolon jelennek meg. Ha az összes bemeneti lekérdezés és parancs lefutott, az eszköz REPL módba kerül.

• Szkript mód: Hasonló a végrehajtási módhoz, de a parancssori argumentumok helyett egy fájlban (a "szkriptben") megadott lekérdezésekkel és parancsokkal.

A Kusto.Cli elsősorban olyan Kusto-szolgáltatásokkal végzett feladatok automatizálására szolgál, amelyekhez általában kódot kell írni. Például egy C#-program vagy egy PowerShell-szkript.

Az eszköz lekérése

A Kusto.Cli a .NET-hez letölthető NuGet-csomag Microsoft.Azure.Kusto.Tools része. A csomag letöltése után bontsa ki a csomag mappáját tools a célmappába. Nincs szükség további telepítésre, mert xcopy-installable.

Az eszköz futtatása

A Kusto.Cli futtatásához legalább egy parancssori argumentum szükséges. Ez az argumentum általában a Kusto szolgáltatás kapcsolati karakterlánc, amelyhez az eszköznek csatlakoznia kell. További információ: Kusto kapcsolati sztringek. Ha parancssori argumentumok nélkül, ismeretlen argumentumkészlettel vagy kapcsolóval futtatja az /help eszközt, megjelenik egy súgóüzenet a konzolon.

Az alábbi paranccsal futtathatja például a Kusto.Cli parancsot. A parancs csatlakozik a help Kusto szolgáltatáshoz, és az adatbázis-környezetet az Samples adatbázisra állítja:

Kusto.Cli.exe "https://help.kusto.windows.net/Samples;Fed=true"

Megjegyzés

A kapcsolati karakterlánc körül idézőjelek használatával megakadályozhatja, hogy a rendszerhéj-alkalmazások, például a PowerShell tévesen értelmezzék a pontosvesszőt (;) és a hasonló karaktereket.

Parancssori argumentumok

(A parancssori argumentumok teljes listájának lekéréséhez futtassa a következőt: Kusto.Cli.exe -help.)

Kusto.Cli.exeConnectionString [Kapcsolók]

ConnectionString

• A Kusto kapcsolati karakterlánc, amely az összes Kusto-kapcsolati információt tartalmazza. Alapértelmezés szerint a értékre van kapcsolva net.tcp://localhost/NetDefaultDB.

-execute:QueryOrCommand

• Ha meg van adva, futtassa a Kusto.Cli parancsot végrehajtási módban, és a megadott lekérdezés vagy parancs fut. Ez a kapcsoló megismételhető, és a lekérdezések/parancsok egymás után, megjelenési sorrendben futnak. Ez a kapcsoló nem használható együtt a vagy -scriptmla kapcsolóval-script.

-keepRunning:EnableKeepRunning

• Ha a vagy a vagy értékként truefalsevan megadva, akkor engedélyezi vagy letiltja a REPL módot az összes -script vagy -execute érték feldolgozása után.

-script:ScriptFile

• Ha meg van adva, szkript módban futtatja a Kusto.Cli-t. A megadott szkriptfájl betöltődik, és a benne lévő lekérdezések vagy parancsok egymás után futnak. Az új vonalak a lekérdezések/parancsok elválasztására szolgálnak, kivéve, ha a sorok egy & vagy && többel végződnek, az alábbiakban leírtak szerint. Ez a kapcsoló nem használható együtt a kapcsolóval -execute.

-scriptml:ScriptFile

• Ha meg van adva, szkript módban futtatja a Kusto.Cli-t. A megadott szkriptfájl betöltődik, és a benne lévő lekérdezések vagy parancsok egymás után futnak. A teljes szkriptfájl egyetlen lekérdezésnek vagy parancsnak minősül (figyelmen kívül hagyva a sorbeviteli módot vagy a bemeneti mód letiltásával kapcsolatos szempontokat).) Ez a kapcsoló nem használható együtt a kapcsolóval -execute.

-scriptQuitOnError:QuitOnFirstScriptError

• Ha engedélyezve van, a Kusto.Cli kilép, ha egy parancs vagy lekérdezés egy szkriptben hibát eredményez. Ha le van tiltva, a szkript végrehajtása a hibák ellenére is folytatódik. Alapértelmezés szerint ez a kapcsoló engedélyezve van.

-echo:EnableEchoMode

• Ha meg van adva, vagy truefalse, engedélyezi vagy letiltja az echo módot. Ha az echo mód engedélyezve van, a kimenetben minden lekérdezés vagy parancs ismétlődik.

-transcript:Átiratfájl

• Ha meg van adva, a program kimenetét a TranscriptFile fájlba írja.

-logToConsole:EnableLogToConsole

• Ha meg van adva, vagy truefalse, akkor engedélyezi vagy letiltja a program kimenetének megjelenítését a konzolon.

-lineMode:EnableLineMode

• Meghatározza, hogyan kezeli a rendszer az új vonalakat, amikor lekérdezéseket vagy parancsokat ad meg a konzolról vagy szkriptekből. Alapértelmezés szerint (vagy ha kifejezetten a értékre truevan állítva), az eszköz a "sorbeviteli módot" használja. Ha a értékre van állítva, falsea szkriptek "blokkbemeneti módban" lesznek beolvasva. A két mód magyarázatát alább találja.

Példa

Kusto.Cli.exe "https://help.kusto.windows.net/Samples;Fed=true" -script:"c:\mycommands.txt"

Megjegyzés

A kettőspont és az argumentum értéke között nem lehet szóköz

Irányelvek

A Kusto.Cli számos irányelvet futtat az eszközben ahelyett, hogy elküldené őket a szolgáltatásnak feldolgozásra.

Irányelv	Description
? #h #help	Rövid súgóüzenet
q #quit #exit	Kilépés az eszközből
#a #abort	Kilépés az eszközből abortív módon
#clip	A következő lekérdezés vagy parancs eredményei a vágólapra lesznek másolva
#cls	A konzol képernyőjének törlése
#connect[ConnectionString]	Másik Kusto-szolgáltatáshoz csatlakozik (ha a ConnectionString nincs megadva, az aktuális jelenik meg)
#crp [Név [=Érték]]	Beállítja egy ügyfélkérési tulajdonság értékét, vagy csak megjeleníti azt, vagy megjeleníti az összes értéket
#crp (-list | -doc) [Előtag]	Az ügyfélkérés tulajdonságainak felsorolása előtag vagy az összes szerint
#dbcontext [DatabaseName]	A lekérdezések és parancsok által használt "környezet" adatbázist a DatabaseName értékre módosítja. Ha nincs megadva, az aktuális környezet jelenik meg
keSzöveg	A megadott szöveg elküldése egy futó Kusto.Explorer-folyamatnak
#loopSzöveg megszámláltatása	Többször futtatja a szöveget
#qp [Név [=Érték]]	Beállítja egy lekérdezési paraméter értékét, vagy csak megjeleníti azt, vagy megjeleníti az összes értéket. Az egy-/dupla idézőjelek az elején/végén lesznek levágva
#saveFájlnév	A következő lekérdezés vagy parancs eredményei a megadott CSV-fájlba lesznek mentve
#scriptFájlnév	Végrehajtja a megadott szkriptet
#scriptmlFájlnév	A megadott többsoros szkript végrehajtása

Vonalbemeneti mód és blokkbemeneti mód

Alapértelmezés szerint a Kusto.Cli sorbeviteli módban fut. A rendszer minden újvonalas karaktert elválasztóként értelmez a lekérdezések/parancsok között, és a sor azonnal végrehajtásra kerül.

Ebben a módban egy hosszú lekérdezést vagy parancsot több sorra bonthat. A & vonal utolsó karaktereként szereplő karakter az új sor előtt a Kusto.Cli-vel folytatja a következő sor olvasását. A && vonal utolsó karaktereként szereplő karakter az új sor előtt a Kusto.Cli figyelmen kívül hagyja az új sort, és folytatja a következő sor olvasását.

A Kusto.Cli a blokkbemeneti módban való futtatást is támogatja a parancssorban való megadásával -lineMode:false vagy az irányelv #blockmodevégrehajtásával. Ebben a módban a Kusto.Cli a Kusto.Explorerhez és a Kusto.WebExplorerhez hasonlóan viselkedik, így a sorok "blokkokként" vannak felolvasva, és minden blokk egyetlen lekérdezésből vagy parancsból áll, a blokkokat pedig egy vagy több üres sor tagolja egymástól.

Megjegyzés

A blokkbemeneti mód használata erősen ajánlott, ha a lekérdezések/parancsok szkriptfájlból (-script) vannak beolvasva.

Megjegyzések

A Kusto.Cli egy olyan sztringet // értelmez, amely az új sort megjegyzéssorként kezdi. Figyelmen kívül hagyja a sor többi részét, és folytatja a következő sor olvasását.

Csak eszközbeállítások

Parancsok	Hatás	Jelenleg
#timeon|#timeoff	engedélyezés/letiltás beállítás timing: A kérések időtartamának megjelenítése	IGAZ
#tableon|#tableoff	engedélyezés/letiltás beállítás tableView: Eredményhalmazok formázása táblázatként	IGAZ
#marson|#marsoff	enable/disable option marsView: Az utolsó előtti eredményhalmazok megjelenítése	HAMIS
#resultson|#resultsoff	enable/disable option outputResultsSet: Az eredményhalmazok megjelenítése	IGAZ
#prettyon|#prettyoff	enable/disable option prettyErrors: Clean up errors	IGAZ
#markdownon|#markdownoff	enable/disable option markdownView: Táblázatok formázása MarkDown-ként	HAMIS
#progressiveon|#progressiveoff	engedélyezés/letiltás lehetőség progressiveView: Progresszív eredmények kérése és megjelenítése	HAMIS
#linemode|#blockmode	engedélyezés/letiltás lehetőség lineMode: Egysoros beviteli mód	IGAZ

Parancsok	Hatás	Alapértelmezett
#cridon|#cridoff	(enable|disable option crid: A ClientRequestId megjelenítése a kérelem elküldése előtt)	HAMIS
#csvheaderson|#csvheadersoff	(enable|disable option csvHeaders: Fejlécek belefoglalása a CSV-kimenetbe)	IGAZ
#focuson|#focusoff	(engedélyezés|letiltás lehetőség focus: Távolítsa el az összes felesleges bolyhost, és összpontosítson a megfelelő dolgokra)	HAMIS
#linemode|#blockmode	(enable|disable option lineMode: Egysoros beviteli mód)	IGAZ
#markdownon|#markdownoff	(enable|disable option markdownView: Format tables as MarkDown)	HAMIS
#marson|#marsoff	(enable|disable option marsView: Az utolsó előtti eredményhalmazok megjelenítése)	HAMIS
#prettyon|#prettyoff	(enable|disable option prettyErrors: Clean up errors)	IGAZ
#querystreamingon|#querystreamingoff	(enable|disable option queryStreaming: A queryStreaming végpont használata (csak a Kusto csapata))	HAMIS
#resultson|#resultsoff	(enable|disable option outputResultsSet: Az eredményhalmazok megjelenítése)	IGAZ
#tableon|#tableoff	(engedélyezés|letiltás lehetőség tableView: Eredményhalmazok formázása táblázatként)	IGAZ
#timeon|#timeoff	(enable|disable option timing: A kérések időtartamának megjelenítése)	IGAZ
#typeon|#typeoff	(enable|disable option typeView: Az egyes oszlopok típusának megjelenítése táblázatnézetben. Kényszeríti a streamelést=igaz)	IGAZ
#v2protocolon|#v2protocoloff	(enable|disable option v2protocol: A v2 lekérdezési protokoll használata, nem v1)	IGAZ

Eredmények exportálása CSV-ként a Kusto.Cli használatával

A Kusto.Cli rendelkezik egy speciális ügyféloldali paranccsal, #save amely a következő lekérdezési eredményeket csv formátumban exportálja egy helyi fájlba. A következő sor például 10 rekordot exportál a táblából a StormEvents fürtbe, Samples az help.kusto.windows.net adatbázisba:

Kusto.Cli.exe @help/Samples -execute:"#save c:\temp\test.log" -execute:"StormEvents | take 10"

A Kusto.Cli használata a Kusto.Explorer futó példányának vezérléséhez

Utasíthatja a Kusto.Cli-t, hogy kommunikáljon a gépen futó Kusto.Explorer "elsődleges" példányával, és küldje el a lekérdezéseket. Ez a mechanizmus olyan programok esetében lehet hasznos, amelyek több lekérdezést szeretnének futtatni, de nem szeretnék többször elindítani a Kusto.Explorer-folyamatot. A következő példában a Kusto.Cli használatával futtathat lekérdezést a súgófürtön:

#connect cluster('help').database('Samples')

#ke StormEvents | count

A szintaxis egyszerű: #ke, majd térköz és a futtatni kívánt lekérdezés. A rendszer ezután elküldi a lekérdezést a Kusto.Explorer elsődleges példányának, ha van ilyen, és az aktuális fürt/adatbázis be van állítva a Kusto.Cli-ben.