Cabazure.Kusto 1.1.7

Cabazure.Kusto

Cabazure.Kusto is a library for handling and executing Kusto scripts against an Azure Data Explorer cluster.

The library extents the official .NET SDK, and adds functionality for:

• Handling embedded .kusto scripts in your .NET projects
• Passing parameters to your .kusto scripts
• Deserialization of query results
• Pagination using stored query results

Getting started

1. Configuring the Cabazure.Kusto library

The Cabazure.Kusto is initialized by calling the AddCabazureKusto() on the IServiceCollection during startup of your application, like this:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddCabazureKusto(o =>
{
    o.HostAddress = "https://help.kusto.windows.net/";
    o.DatabaseName = "ContosoSales";
    o.Credential = new DefaultAzureCredential();
});

Note: The CabazureKustoOptions can also be configured using the Microsoft.Extensions.Options framework, by registering an implementation of IConfigureOptions<CabazureKustoOptions>. In this case, it can be omitted on the AddCabazureKusto() call.

2. Adding a Kusto query

A Kusto query is added by creating two files to your project:

• A .kusto script file containing the Kusto query itself, added with "Build Action" set to "Embedded resource"
• A .NET record with the same name (and namespace) as the embedded .kusto script.

The .NET record should to derive from one of the following base types:

Note: The base types handles the loading of the embedded .kusto script file, passing of parameters and deserialization of the output.

Parameters are specified by adding them to record, and declare them at the top of the .kusto script, like this:

// file: CustomerQuery.cs
public record CustomerQuery(
  string CustomerType)
  : KustoQuery<Customer>;

// file: CustomerQuery.kusto
declare query_parameters (
    customerType:string)
;
Customers
| where type == customerType
| project
    customerId,
    name,
    type,
    lastUpdated = timestamp,

The query result is mapped to the specified output contract, my matching parameter names like this:

// file: Customer.cs
public record Customer(
  string CustomerId,
  string Name,
  CustomerType Type,
  DateTimeOffset LastUpdated);

3. Execute a Kusto query

Kusto scripts can be executed using the IKustoProcessor registered in the Dependency Injection container, like this:

app.MapGet(
  "/customers",
  (IKustoProcessor processor, CancellationToken cancellationToken)
    => processor
      .ExecuteAsync(
        new CustomerQuery("type"),
        cancellationToken));

The processor can also perform pagination by using the ExecuteAsync overload, taking in a session id, a continuation token and a max item count, like this:

app.MapGet(
  "/customers",
  ([FromHeader(Name = "x-max-item-count")] int? maxItemCount,
  [FromHeader(Name = "x-continuation")] string? continuation,
  [FromHeader(Name = "x-session-id")] string? sessionId,
  IKustoProcessor processor,
  CancellationToken cancellationToken)
    => processor
      .ExecuteAsync(
        new CustomerQuery("type"),
        sessionId,
        maxItemCount,
        continuationToken,
        cancellationToken));

The maxItemCount specifies how many items to return for each page. Each page is returned with a continuationToken that can be specified to fetch the next page.

The optional sessionId can be provided to optimize the use of storage on the ADX. If the same sessionId is specified for two calls they will share the underlying storage for pagination results.

Sample

Please see the SampleApi project, for an example of how Cabazure.Kusto can be setup to query the "ContosoSales" database of the ADX sample cluster.