Создание приложения для выполнения базовых запросов

  • Статья

Вы узнаете, как выполнять следующие задачи:

Предварительные требования

Настройте среду разработки для использования клиентской библиотеки Kusto.

Выполнение базового запроса и обработка результатов

В предпочитаемой интегрированной среде разработки или текстовом редакторе создайте проект или файл с именем "Базовый запрос ", используя соглашение, соответствующее предпочитаемой вами языку. Затем добавьте приведенный ниже код.

  1. Создайте клиентское приложение, которое подключается к кластеру справки.

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

namespace BasicQuery {
  class BasicQuery {
    static void Main(string[] args) {
      var clusterUri = "https://help.kusto.windows.net/";
      var kcsb = new KustoConnectionStringBuilder(clusterUri)
          .WithAadUserPromptAuthentication();

      using (var kustoClient = KustoClientFactory.CreateCslQueryProvider(kcsb)) {
      }
    }
  }
}

  2. Определите базу данных и запрос для выполнения. Запрос возвращает дату, состояние и общий ущерб, связанный с торнадо, где общий ущерб превысил 100 миллионов долларов.

    var database = "Samples";
var query = @"StormEvents
              | where EventType == 'Tornado'
              | extend TotalDamage = DamageProperty + DamageCrops
              | summarize DailyDamage=sum(TotalDamage) by State, bin(StartTime, 1d)
              | where DailyDamage > 100000000
              | order by DailyDamage desc";

  3. Выполните запрос и выведите результат.

    using (var response = kustoClient.ExecuteQuery(database, query, null)) {
  int columnNoStartTime = response.GetOrdinal("StartTime");
  int columnNoState = response.GetOrdinal("State");
  int columnNoDailyDamage = response.GetOrdinal("DailyDamage");
  Console.WriteLine("Daily tornado damages over 100,000,000$:");

  while (response.Read()) {
    Console.WriteLine("{0} - {1}, {2}",
      response.GetDateTime(columnNoStartTime),
      response.GetString(columnNoState),
      response.GetInt64(columnNoDailyDamage));
  }
}

Полный код должен выглядеть следующим образом:

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

namespace BasicQuery {
  class BasicQuery {
    static void Main(string[] args) {
      string clusterUri = "https://help.kusto.windows.net/";
      var kcsb = new KustoConnectionStringBuilder(clusterUri)
          .WithAadUserPromptAuthentication();

      using (var kustoClient = KustoClientFactory.CreateCslQueryProvider(kcsb)) {
        string database = "Samples";
        string query = @"StormEvents
                         | where EventType == 'Tornado'
                         | extend TotalDamage = DamageProperty + DamageCrops
                         | summarize DailyDamage=sum(TotalDamage) by State, bin(StartTime, 1d)
                         | where DailyDamage > 100000000
                         | order by DailyDamage desc";

        using (var response = kustoClient.ExecuteQuery(database, query, null)) {
          int columnNoStartTime = response.GetOrdinal("StartTime");
          int columnNoState = response.GetOrdinal("State");
          int columnNoDailyDamage = response.GetOrdinal("DailyDamage");

          Console.WriteLine("Daily tornado damages over 100,000,000$:");

          while (response.Read()) {
            Console.WriteLine("{0} - {1}, {2}",
              response.GetDateTime(columnNoStartTime),
              response.GetString(columnNoState),
              response.GetInt64(columnNoDailyDamage));
          }
        }
      }
    }
  }
}

Запустите приложение.

В командной оболочке выполните следующую команду, чтобы запустить приложение:

# Change directory to the folder that contains the basic queries project
dotnet run .

Результат должен выглядеть примерно так:

Daily damages tornado with damages over 100,000,000$:
2007-02-02 00:00:00+00:00 - FLORIDA , 270004000 $
2007-03-01 00:00:00+00:00 - ALABAMA , 266853000 $
2007-05-04 00:00:00+00:00 - KANSAS , 251625000 $
2007-03-01 00:00:00+00:00 - GEORGIA , 143688000 $

Использование порядковых позиций для доступа к значениям столбцов

Если порядок столбцов в результатах запроса известен, доступ к значениям столбцов эффективнее получить по порядковой позиции в результирующем наборе, чем по имени столбца. При необходимости во время выполнения можно использовать метод библиотеки для определения порядкового номера столбца по имени столбца.

Примечание

Вы можете управлять наличием и порядком столбцов в результатах запроса с помощью операторов project или project-away .

Например, можно изменить предыдущий код для доступа к значениям StartTimeстолбцов , Stateи DailyDamage по их порядковой позиции в результирующем наборе:

В C# доступ к значениям столбцов можно получить только по порядковой позиции в результирующем наборе. Вы не можете использовать имена столбцов; следовательно, код остается прежним.

int columnNoStartTime = response.GetOrdinal("StartTime");
int columnNoState = response.GetOrdinal("State");
int columnNoDailyDamage = response.GetOrdinal("DailyDamage");
Console.WriteLine("Daily tornado damages over 100,000,000$:");

while (response.Read()) {
  Console.WriteLine("{0} - {1}, {2}",
    response.GetDateTime(columnNoStartTime),
    response.GetString(columnNoState),
    response.GetInt64(columnNoDailyDamage));
}

Настройка поведения запроса с помощью свойств запроса клиента

Поведение запроса можно настроить, задав свойства запроса клиента. Дополнительные сведения о доступных параметрах см. в разделе Свойства запроса клиента.

Например, можно заменить kusto_client.execute_query вызов в предыдущем коде, чтобы передать пользовательский идентификатор запроса и задать время ожидания запроса равным 1 минуте. Чтобы использовать свойства запроса клиента, необходимо импортировать ClientRequestProperties класс .

using Kusto.Data.Common;

var crp = new ClientRequestProperties();
// Set a custom client request identifier
crp.ClientRequestId = "QueryDemo" + Guid.NewGuid().ToString();
// Set the query timeout to 1 minute
crp.SetOption(ClientRequestProperties.OptionServerTimeout, "1m");

using (var response = kustoClient.ExecuteQuery(database, query, crp)) {
}

Использование параметров запроса для защиты введенных пользователем данных

Параметры запроса важны для обеспечения безопасности и защиты данных. Он защищает его от потенциальных злоумышленников, которые могут попытаться получить несанкционированный доступ или повредить ваши данные. Дополнительные сведения о параметризованных запросах см. в разделе Оператор объявления параметров запроса.

Например, можно изменить предыдущий код, чтобы передать в запрос значение EventType и минимальное значение DailyDamage в качестве параметров. Чтобы использовать параметры, выполните следующие действия.

  1. Объявление параметров в тексте запроса
  2. Замените значения свойств в тексте запроса именами параметров.
  3. Установка значений параметров в свойствах запроса клиента, передаваемых методу execute.
string query = @"declare query_parameters(event_type:string, daily_damage:int);
                  StormEvents
                  | where EventType == event_type
                  | extend TotalDamage = DamageProperty + DamageCrops
                  | summarize DailyDamage=sum(TotalDamage) by State, bin(StartTime, 1d)
                  | where DailyDamage > daily_damage
                  | order by DailyDamage desc";

var crp = new ClientRequestProperties();
crp.SetParameter("event_type", "Flash Flood");
crp.SetParameter("daily_damage", 200000000.ToString());

using (var response = kustoClient.ExecuteQuery(database, query, crp)) {
  int columnNoStartTime = response.GetOrdinal("StartTime");
  int columnNoState = response.GetOrdinal("State");
  int columnNoDailyDamage = response.GetOrdinal("DailyDamage");
  Console.WriteLine("Daily flash flood damages over 200,000,000$:");

  while (response.Read()) {
    Console.WriteLine("{0} - {1}, {2}",
      response.GetDateTime(columnNoStartTime),
      response.GetString(columnNoState),
      response.GetInt64(columnNoDailyDamage));
  }
}

Полный код, использующий порядковые позиции для доступа к значениям столбцов и параметрам, должен выглядеть следующим образом:

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

namespace BasicQuery {
  class BasicQuery {
    static void Main(string[] args) {
      string clusterUri = "https://help.kusto.windows.net/";
      var kcsb = new KustoConnectionStringBuilder(clusterUri)
          .WithAadUserPromptAuthentication();

      using (var kustoClient = KustoClientFactory.CreateCslQueryProvider(kcsb)) {
        string database = "Samples";
        string query = @"declare query_parameters(event_type:string, daily_damage:int);
                         StormEvents
                         | where EventType == event_type
                         | extend TotalDamage = DamageProperty + DamageCrops
                         | summarize DailyDamage=sum(TotalDamage) by State, bin(StartTime, 1d)
                         | where DailyDamage > daily_damage
                         | order by DailyDamage desc";

        var crp = new ClientRequestProperties();
        crp.ClientRequestId = "QueryDemo" + Guid.NewGuid().ToString();
        crp.SetOption(ClientRequestProperties.OptionServerTimeout, "1m");
        crp.SetParameter("event_type", "Flash Flood");
        crp.SetParameter("daily_damage", 200000000.ToString());

        using (var response = kustoClient.ExecuteQuery(database, query, crp)) {
          int columnNoStartTime = response.GetOrdinal("StartTime");
          int columnNoState = response.GetOrdinal("State");
          int columnNoDailyDamage = response.GetOrdinal("DailyDamage");

          Console.WriteLine("Daily flash flood damages over 200,000,000$:");

          while (response.Read()) {
            Console.WriteLine("{0} - {1}, {2}",
              response.GetDateTime(columnNoStartTime),
              response.GetString(columnNoState),
              response.GetInt64(columnNoDailyDamage));
          }
        }
      }
    }
  }
}

Результат должен выглядеть примерно так:

Daily flash flood damages over 200,000,000$:
2007-08-21 00:00:00+00:00 - OHIO , 253320000 $

Следующий шаг

Создание приложения для выполнения команд управления