Erstellen einer App zum Ausführen von Verwaltungsbefehlen

In diesem Artikel werden folgende Vorgehensweisen behandelt:

• Ausführen eines Verwaltungsbefehls und Verarbeiten der Ergebnisse
• Ändern der Batchverarbeitungsrichtlinie für die Erfassung auf Tabellenebene
• Anzeigen der Aufbewahrungsrichtlinie auf Datenbankebene

Voraussetzungen

Richten Sie Ihre Entwicklungsumgebung für die Verwendung der Kusto-Clientbibliothek ein.

Ausführen eines Verwaltungsbefehls und Verarbeiten der Ergebnisse

Erstellen Sie in Ihrer bevorzugten IDE oder im Text-Editor ein Projekt oder eine Datei namens Verwaltungsbefehle mit der für Ihre bevorzugte Sprache geeigneten Konvention. Fügen Sie dann den folgenden Code hinzu:

1. Erstellen Sie eine Client-App, die Ihren Cluster verbindet. Ersetzen Sie den <your_cluster_uri> Platzhalter durch Ihren Clusternamen.

   C#

   Hinweis

   Für Verwaltungsbefehle verwenden Sie die CreateCslAdminProvider Clientfactorymethode.

   using Kusto.Data;
   using Kusto.Data.Net.Client;
   
   namespace ManagementCommands {
     class ManagementCommands {
       static void Main(string[] args) {
         var clusterUri = "<your_cluster_uri>";
         var kcsb = new KustoConnectionStringBuilder(clusterUri)
             .WithAadUserPromptAuthentication();
   
         using (var kustoClient = KustoClientFactory.CreateCslAdminProvider(kcsb)) {
         }
       }
     }
   }
   

   Python

   from azure.kusto.data import KustoClient, KustoConnectionStringBuilder
   
   def main():
     cluster_uri = "<your_cluster_uri>"
     kcsb = KustoConnectionStringBuilder.with_interactive_login(cluster_uri)
   
     with KustoClient(kcsb) as kusto_client:
   
   if __name__ == "__main__":
     main()
   

   Typescript

   import { Client as KustoClient, KustoConnectionStringBuilder } from "azure-kusto-data/";
   import { InteractiveBrowserCredentialInBrowserOptions } from "@azure/identity";
   
   async function main() {
     const clusterUri = "<your_cluster_uri>";
     const authOptions = {
       clientId: "5e39af3b-ba50-4255-b547-81abfb507c58",
       redirectUri: "http://localhost:5173",
     } as InteractiveBrowserCredentialInBrowserOptions;
     const kcsb = KustoConnectionStringBuilder.withUserPrompt(clusterUri, authOptions);
     const kustoClient = new KustoClient(kcsb);
   }
   
   main();
   

   Hinweis

   Verwenden Sie InteractiveBrowserCredentialNodeOptions für Node.js-Apps anstelle von InteractiveBrowserCredentialInBrowserOptions.

   Java

   import com.microsoft.azure.kusto.data.Client;
   import com.microsoft.azure.kusto.data.ClientFactory;
   import com.microsoft.azure.kusto.data.KustoOperationResult;
   import com.microsoft.azure.kusto.data.KustoResultSetTable;
   import com.microsoft.azure.kusto.data.KustoResultColumn;
   import com.microsoft.azure.kusto.data.auth.ConnectionStringBuilder;
   
   public class ManagementCommands {
     public static void main(String[] args) throws Exception {
       try {
         String clusterUri = "<your_cluster_uri>";
         ConnectionStringBuilder kcsb = ConnectionStringBuilder.createWithUserPrompt(clusterUri);
   
         try (Client kustoClient = ClientFactory.createClient(kcsb)) {
         }
       }
     }
   }
   

2. Definieren Sie eine Funktion, die den auszuführenden Befehl und die zugehörigen Tabellen ausgibt. Diese Funktion entpackt die Spaltennamen in den Ergebnistabellen und gibt jedes Name-Wert-Paar in einer neuen Zeile aus.

   C#

   static void PrintResultsAsValueList(string command, IDataReader response) {
     while (response.Read()) {
       Console.WriteLine("\n{0}\n", new String('-', 20));
       Console.WriteLine("Command: {0}", command);
       Console.WriteLine("Result:");
       for (int i = 0; i < response.FieldCount; i++) {
         Console.WriteLine("\t{0} - {1}", response.GetName(i), response.IsDBNull(i) ? "None" : response.GetString(i));
       }
     }
   }
   

   Python

   def print_result_as_value_list(command, response):
     # create a list of columns
     cols = (col.column_name for col in response.primary_results[0].columns)
   
     print("\n" + "-" * 20 + "\n")
     print("Command: " + command)
     # print the values for each row
     for row in response.primary_results[0]:
       print("Result:")
       for col in cols:
         print("\t", col, "-", row[col])
   

   Typescript

   function printResultsAsValueList(command: string, response: KustoResponseDataSet) {
     // create a list of columns
     const cols = response.primaryResults[0].columns;
   
     console.log("\n" + "-".repeat(20) + "\n")
     console.log("Command: " + command)
     // print the values for each row
     for (const row of response.primaryResults[0].rows()) {
       console.log("Result:")
       for (col of cols)
       console.log("\t", col.name, "-", row.getValueAt(col.ordinal) ? row.getValueAt(col.ordinal).toString() : "None")
     }
   }
   

   Java

   public static void printResultsAsValueList(String command, KustoResultSetTable results) {
     while (results.next()) {
       System.out.println("\n" + "-".repeat(20) + "\n");
       System.out.println("Command: " + command);
       System.out.println("Result:");
       KustoResultColumn[] columns = results.getColumns();
       for (int i = 0; i < columns.length; i++) {
         System.out.println("\t" + columns[i].getColumnName() + " - " + (results.getObject(i) == null ? "None" : results.getString(i)));
       }
     }
   }
   

3. Definieren Sie den auszuführenden Befehl. Der Befehl erstellt eine Tabelle mit dem Namen MyStormEvents und definiert das Tabellenschema als Liste von Spaltennamen und -typen. Ersetzen Sie den <your_database> Platzhalter durch Ihren Datenbanknamen.

   C#

   string database = "<your_database>";
   string table = "MyStormEvents";
   
   // Create a table named MyStormEvents
   // The brackets contain a list of column Name:Type pairs that defines the table schema
   string command = @$".create table {table}
                     (StartTime:datetime,
                      EndTime:datetime,
                      State:string,
                      DamageProperty:int,
                      DamageCrops:int,
                      Source:string,
                      StormSummary:dynamic)";
   

   Python

   database = "<your_database>"
   table = "MyStormEvents"
   
   # Create a table named MyStormEvents
   # The brackets contain a list of column Name:Type pairs that defines the table schema
   command = ".create table " + table + " " \
             "(StartTime:datetime," \
             " EndTime:datetime," \
             " State:string," \
             " DamageProperty:int," \
             " DamageCrops:int," \
             " Source:string," \
             " StormSummary:dynamic)"
   

   Typescript

   const database = "<your_database>";
   const table = "MyStormEvents";
   
   // Create a table named MyStormEvents
   // The brackets contain a list of column Name:Type pairs that defines the table schema
   const command = `.create table ${table}
                 (StartTime:datetime,
                  EndTime:datetime,
                  State:string,
                  DamageProperty:int,
                  Source:string,
                  StormSummary:dynamic)`;
   

   Java

   String database = "<your_database>";
   String table = "MyStormEvents";
   
   // Create a table named MyStormEvents
   // The brackets contain a list of column Name:Type pairs that defines the table schema
   String command = ".create table " + table + " " +
                    "(StartTime:datetime," +
                    " EndTime:datetime," +
                    " State:string," +
                    " DamageProperty:int," +
                    " DamageCrops:int," +
                    " Source:string," +
                    " StormSummary:dynamic)";
   

4. Führen Sie den Befehl aus, und geben Sie das Ergebnis mit der zuvor definierten Funktion aus.

   C#

   Hinweis

   Sie verwenden die ExecuteControlCommand -Methode, um den Befehl auszuführen.

   using (var response = kustoClient.ExecuteControlCommand(database, command, null)) {
     PrintResultsAsValueList(command, response);
   }
   

   Python

   Hinweis

   Sie verwenden die execute_mgmt -Methode, um den Befehl auszuführen.

   response = kusto_client.execute_mgmt(database, command)
   print_result_as_value_list(command, response)
   

   Typescript

   Hinweis

   Sie verwenden die executeMgmt -Methode, um den Befehl auszuführen.

   const response = await kustoClient.executeMgmt(database, command);
   printResultsAsValueList(command, response)
   

   Java

   KustoOperationResult response = kusto_client.execute(database, command);
   printResultsAsValueList(command, response.getPrimaryResults());
   

Der vollständige Code sollte wie folgt aussehen:

C#

using Kusto.Data;
using Kusto.Data.Net.Client;

namespace ManagementCommands {
  class ManagementCommands {
    static void Main(string[] args) {
      string clusterUri = "https://<your_cluster_uri>";
      var kcsb = new KustoConnectionStringBuilder(clusterUri)
          .WithAadUserPromptAuthentication();

      using (var kustoClient = KustoClientFactory.CreateCslAdminProvider(kcsb)) {
        string database = "<your_database>";
        string table = "MyStormEvents";

        // Create a table named MyStormEvents
        // The brackets contain a list of column Name:Type pairs that defines the table schema
        string command = @$".create table {table} 
                          (StartTime:datetime,
                           EndTime:datetime,
                           State:string,
                           DamageProperty:int,
                           DamageCrops:int,
                           Source:string,
                           StormSummary:dynamic)";

        using (var response = kustoClient.ExecuteControlCommand(database, command, null)) {
          PrintResultsAsValueList(command, response);
        }
      }
    }

    static void PrintResultsAsValueList(string command, IDataReader response) {
      while (response.Read()) {
        Console.WriteLine("\n{0}\n", new String('-', 20));
        Console.WriteLine("Command: {0}", command);
        Console.WriteLine("Result:");
        for (int i = 0; i < response.FieldCount; i++) {
          Console.WriteLine("\t{0} - {1}", response.GetName(i), response.IsDBNull(i) ? "None" : response.GetString(i));
        }
      }
    }
  }
}

Python

from azure.kusto.data import KustoClient, KustoConnectionStringBuilder

def main():
  cluster_uri = "https://<your_cluster_uri>"
  kcsb = KustoConnectionStringBuilder.with_interactive_login(cluster_uri)

  with KustoClient(kcsb) as kusto_client:

    database = "<your_database>"
    table = "MyStormEvents"

    # Create a table named MyStormEvents
    # The brackets contain a list of column Name:Type pairs that defines the table schema
    command = ".create table " + table + " " \
              "(StartTime:datetime," \
              " EndTime:datetime," \
              " State:string," \
              " DamageProperty:int," \
              " DamageCrops:int," \
              " Source:string," \
              " StormSummary:dynamic)"

    response = kusto_client.execute_mgmt(database, command)
    print_result_as_value_list(command, response)

def print_result_as_value_list(command, response):
  # create a list of columns
  cols = (col.column_name for col in response.primary_results[0].columns)

  print("\n" + "-" * 20 + "\n")
  print("Command: " + command)
  # print the values for each row
  for row in response.primary_results[0]:
    print("Result:")
    for col in cols:
      print("\t", col, "-", row[col])

if __name__ == "__main__":
  main()

Typescript

import { Client as KustoClient, KustoConnectionStringBuilder, KustoResponseDataSet } from "azure-kusto-data/";
import { InteractiveBrowserCredentialInBrowserOptions } from "@azure/identity";

async function main() {
  const clusterUri = "<your_cluster_uri>";
  const authOptions = {
    clientId: "5e39af3b-ba50-4255-b547-81abfb507c58",
    redirectUri: "http://localhost:5173",
  } as InteractiveBrowserCredentialInBrowserOptions;
  const kcsb = KustoConnectionStringBuilder.withUserPrompt(clusterUri, authOptions);
  const kustoClient = new KustoClient(kcsb);

  const database = "<your_database>";
  const table = "MyStormEvents";

  // Create a table named MyStormEvents
  // The brackets contain a list of column Name:Type pairs that defines the table schema
  const command = `.create table ${table}
                 (StartTime:datetime,
                  EndTime:datetime,
                  State:string,
                  DamageProperty:int,
                  Source:string,
                  StormSummary:dynamic)`;

  const response = await kustoClient.executeMgmt(database, command);
  printResultsAsValueList(command, response)
}

function printResultsAsValueList(command: string, response: KustoResponseDataSet) {
  // create a list of columns
  const cols = response.primaryResults[0].columns;

  console.log("\n" + "-".repeat(20) + "\n")
  console.log("Command: " + command)
  // print the values for each row
  for (const row of response.primaryResults[0].rows()) {
    console.log("Result:")
    for (const col of cols) {
        console.log("\t", col.name, "-", row.getValueAt(col.ordinal) ? row.getValueAt(col.ordinal).toString() : "None")
    }
  }
}

main();

Hinweis

Verwenden Sie InteractiveBrowserCredentialNodeOptions für Node.js-Apps anstelle von InteractiveBrowserCredentialInBrowserOptions.

Java

import com.microsoft.azure.kusto.data.Client;
import com.microsoft.azure.kusto.data.ClientFactory;
import com.microsoft.azure.kusto.data.KustoOperationResult;
import com.microsoft.azure.kusto.data.KustoResultSetTable;
import com.microsoft.azure.kusto.data.KustoResultColumn;
import com.microsoft.azure.kusto.data.auth.ConnectionStringBuilder;

public class ManagementCommands {
  public static void main(String[] args) throws Exception {
    try {
      String clusterUri = "https://<your_cluster_uri>";
      ConnectionStringBuilder kcsb = ConnectionStringBuilder.createWithUserPrompt(clusterUri);
      try (Client kustoClient = ClientFactory.createClient(kcsb)) {
        String database = "<your_database>";
        String table = "MyStormEvents";

        // Create a table named MyStormEvents
        // The brackets contain a list of column Name:Type pairs that defines the table schema
        String command = ".create table " + table + " " +
                         "(StartTime:datetime," +
                         " EndTime:datetime," +
                         " State:string," +
                         " DamageProperty:int," +
                         " DamageCrops:int," +
                         " Source:string," +
                         " StormSummary:dynamic)";

        KustoOperationResult response = kustoClient.execute(database, command);
        printResultsAsValueList(command, response.getPrimaryResults());
      }
    }
  }
  public static void printResultsAsValueList(String command, KustoResultSetTable results) {
    while (results.next()) {
      System.out.println("\n" + "-".repeat(20) + "\n");
      System.out.println("Command: " + command);
      System.out.println("Result:");
      KustoResultColumn[] columns = results.getColumns();
      for (int i = 0; i < columns.length; i++) {
        System.out.println("\t" + columns[i].getColumnName() + " - " + (results.getObject(i) == null ? "None" : results.getString(i)));
      }
    }
  }
}

Ausführen der App

Verwenden Sie in einer Befehlsshell den folgenden Befehl, um Ihre App auszuführen:

C#

# Change directory to the folder that contains the management commands project
dotnet run .

Python

python management_commands.py

Typescript

In einer Node.js Umgebung:

node management-commands.js

Verwenden Sie in einer Browserumgebung den entsprechenden Befehl, um Ihre App auszuführen. Beispielsweise für Vite-React:

npm run dev

Hinweis

Öffnen Sie in einer Browserumgebung die Konsole der Entwicklertools , um die Ausgabe anzuzeigen.

Java

mvn install exec:java -Dexec.mainClass="<groupId>.ManagementCommands"

Es sollte ein Ergebnis ähnlich dem folgenden angezeigt werden:

--------------------

Command: .create table MyStormEvents 
                 (StartTime:datetime,
                  EndTime:datetime,
                  State:string,
                  DamageProperty:int,
                  Source:string,
                  StormSummary:dynamic)
Result:
   TableName - MyStormEvents
   Schema - {"Name":"MyStormEvents","OrderedColumns":[{"Name":"StartTime","Type":"System.DateTime","CslType":"datetime"},{"Name":"EndTime","Type":"System.DateTime","CslType":"datetime"},{"Name":"State","Type":"System.String","CslType":"string"},{"Name":"DamageProperty","Type":"System.Int32","CslType":"int"},{"Name":"Source","Type":"System.String","CslType":"string"},{"Name":"StormSummary","Type":"System.Object","CslType":"dynamic"}]}
   DatabaseName - MyDatabaseName
   Folder - None
   DocString - None

Ändern der Batchverarbeitungsrichtlinie für die Erfassung auf Tabellenebene

Sie können das Batchverarbeitungsverhalten der Erfassung für Tabellen anpassen, indem Sie die entsprechende Tabellenrichtlinie ändern. Weitere Informationen finden Sie unter IngestionBatching-Richtlinie.

Hinweis

Wenn Sie nicht alle Parameter eines PolicyObject angeben, werden die nicht angegebenen Parameter auf Standardwerte festgelegt. Wenn Sie beispielsweise nur "MaximumBatchingTimeSpan" angeben, werden "MaximumNumberOfItems" und "MaximumRawDataSizeMB" auf den Standardwert festgelegt.

Sie können z. B. die App ändern, um den Timeoutwert der Batchverarbeitungsrichtlinie für die Erfassung in 30 Sekunden zu ändern, indem Sie die ingestionBatching Richtlinie für die MyStormEvents Tabelle mit dem folgenden Befehl ändern:

C#

// Reduce the default batching timeout to 30 seconds
command = @$".alter-merge table {table} policy ingestionbatching '{{ ""MaximumBatchingTimeSpan"":""00:00:30"" }}'";

using (var response = kustoClient.ExecuteControlCommand(database, command, null))
{
  PrintResultsAsValueList(command, response);
}

Python

# Reduce the default batching timeout to 30 seconds
command = ".alter-merge table " + table + " policy ingestionbatching '{ \"MaximumBatchingTimeSpan\":\"00:00:30\" }'"

response = kusto_client.execute_mgmt(database, command)
print_result_as_value_list(command, response)

Typescript

// Reduce the default batching timeout to 30 seconds
command = ".alter-merge table " + table + " policy ingestionbatching '{ \"MaximumBatchingTimeSpan\":\"00:00:30\" }'"

response = await kustoClient.executeMgmt(database, command)
printResultsAsValueList(command, response)

Java

// Reduce the default batching timeout to 30 seconds
command = ".alter-merge table " + table + " policy ingestionbatching '{ \"MaximumBatchingTimeSpan\":\"00:00:30\" }'";

response = kusto_client.execute(database, command);
printResultsAsValueList(command, response.getPrimaryResults());

Wenn Sie der App den Code hinzufügen und ausführen, sollte ein Ergebnis ähnlich dem folgenden angezeigt werden:

--------------------

Command: .alter-merge table MyStormEvents policy ingestionbatching '{ "MaximumBatchingTimeSpan":"00:00:30" }'
Result:
   PolicyName - IngestionBatchingPolicy
   EntityName - [YourDatabase].[MyStormEvents]
   Policy - {
  "MaximumBatchingTimeSpan": "00:00:30",
  "MaximumNumberOfItems": 500,
  "MaximumRawDataSizeMB": 1024
}
   ChildEntities - None
   EntityType - Table

Anzeigen der Aufbewahrungsrichtlinie auf Datenbankebene

Sie können Verwaltungsbefehle verwenden, um die Aufbewahrungsrichtlinie einer Datenbank anzuzeigen.

Beispielsweise können Sie die App ändern, um die Aufbewahrungsrichtlinie Ihrer Datenbank anzuzeigen , indem Sie den folgenden Code verwenden. Das Ergebnis wird so zusammengestellt, dass zwei Spalten aus dem Ergebnis weg projiziert werden:

C#

// Show the database retention policy (drop some columns from the result)
command = @$".show database {database} policy retention | project-away ChildEntities, EntityType";

using (var response = kustoClient.ExecuteControlCommand(database, command, null)) {
  PrintResultsAsValueList(command, response);
}

Python

# Show the database retention policy (drop some columns from the result)
command = ".show database " + database + " policy retention | project-away ChildEntities, EntityType"

response = kusto_client.execute_mgmt(database, command)
print_result_as_value_list(command, response)

Typescript

// Show the database retention policy (drop some columns from the result)
command = ".show database " + database + " policy retention | project-away ChildEntities, EntityType"

response = await kustoClient.executeMgmt(database, command)
printResultsAsValueList(command, response)

Java

// Show the database retention policy (drop some columns from the result)
command = ".show database " + database + " policy retention | project-away ChildEntities, EntityType";

response = kusto_client.execute(database, command);
printResultsAsValueList(command, response.getPrimaryResults());

Wenn Sie der App den Code hinzufügen und ausführen, sollte ein Ergebnis ähnlich dem folgenden angezeigt werden:

--------------------

Command: .show database YourDatabase policy retention | project-away ChildEntities, EntityType
Result:
   PolicyName - RetentionPolicy
   EntityName - [YourDatabase]
   Policy - {
  "SoftDeletePeriod": "365.00:00:00",
  "Recoverability": "Enabled"
}

Nächster Schritt

Erstellen einer App zum Abrufen von Daten mithilfe der Erfassung in die Warteschlange