Condividi tramite

Creare un'app per eseguire i comandi di gestione

  • Articolo

In questo articolo vengono illustrate le operazioni seguenti:

Prerequisiti

Configurare l'ambiente di sviluppo per usare la libreria client Kusto.

Eseguire un comando di gestione ed elaborare i risultati

Nell'IDE o nell'editor di testo preferito creare un progetto o un file denominato comandi di gestione usando la convenzione appropriata per la lingua preferita. Aggiungere quindi il codice seguente:

  1. Creare un'app client che connette il cluster. Sostituire il segnaposto con il <your_cluster_uri> nome del cluster.

    Nota

    Per i comandi di gestione, si userà il CreateCslAdminProvider metodo client factory.

    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)) {
      }
    }
  }
}

  2. Definire una funzione che stampa il comando in esecuzione e le relative tabelle risultanti. Questa funzione decomprime i nomi di colonna nelle tabelle dei risultati e stampa ogni coppia nome-valore in una nuova riga.

    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));
    }
  }
}

  3. Definire il comando da eseguire. Il comando crea una tabelladenominata MyStormEvents e definisce lo schema della tabella come elenco di nomi e tipi di colonna. Sostituire il segnaposto con il nome del <your_database> database.

    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. Eseguire il comando e stampare il risultato usando la funzione definita in precedenza.

    Nota

    Si userà il ExecuteControlCommand metodo per eseguire il comando.

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

Il codice completo dovrebbe essere simile al seguente:

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));
        }
      }
    }
  }
}

Eseguire l'app

In una shell dei comandi usare il comando seguente per eseguire l'app:

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

Verrà visualizzato un risultato simile al seguente:

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

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

Modificare i criteri di inserimento in batch a livello di tabella

È possibile personalizzare il comportamento di batch di inserimento per le tabelle modificando i criteri di tabella corrispondenti. Per altre informazioni, vedere Criteri Di inserimentoBatching.

Nota

Se non si specificano tutti i parametri di un PolicyObject, i parametri non specificati verranno impostati sui valori predefiniti. Ad esempio, specificando solo "MaximumBatchingTimeSpan" verrà generato "MaximumNumberOfItems" e "MaximumRawDataSizeMB" impostato su impostazione predefinita.

Ad esempio, è possibile modificare l'app per modificare il valore di timeout dei criteri in batch di inserimento su 30 secondi modificando i criteri per la MyStormEvents tabella usando il ingestionBatching comando seguente:

// 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);
}

Quando si aggiunge il codice all'app ed eseguirlo, verrà visualizzato un risultato simile al seguente:

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

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

Mostra i criteri di conservazione a livello di database

È possibile usare i comandi di gestione per visualizzare i criteri di conservazione di un database.

Ad esempio, è possibile modificare l'app per visualizzare i criteri di conservazione del database usando il codice seguente. Il risultato è curato per proiettare due colonne dal risultato:

// 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);
}

Quando si aggiunge il codice all'app ed eseguirlo, verrà visualizzato un risultato simile al seguente:

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

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

Passaggio successivo

Creare un'app per ottenere dati usando l'inserimento in coda