Bar Nuri

C# LINQ to KQL with ORMGEN OpenSource

Thu, 05 Dec 2024 10:44:23 +0000

CSharp.OpenSource.LinqToKql: LINQ to KQL with ORMGEN

CSharp.OpenSource.LinqToKql is a powerful library that bridges the gap between LINQ (Language Integrated Query) and KQL (Kusto Query Language), commonly used for querying Azure Data Explorer (ADX) and other Kusto-based data sources. This library simplifies querying Kusto data sources using LINQ’s familiar syntax, making it easier for developers to work with Kusto data in their .NET applications.

ORMGEN: Auto-Generation of KQL Queries

One of the standout features within this library is ORMGEN, an ORM (Object-Relational Mapping) generator that automates the generation of KQL queries. ORMGEN enables developers to create and execute complex KQL queries directly from their C# code using LINQ, without manually writing the raw KQL. This tool automatically handles the conversion of LINQ queries into the appropriate KQL syntax, saving time and reducing the chances of errors in query construction.

How ORMGEN Works

ORMGEN utilizes LINQ to KQL query translation behind the scenes. Developers can define their data models in C# and use standard LINQ syntax to query Kusto databases. ORMGEN then takes these LINQ queries and translates them into optimized KQL queries, which are executed on the Kusto cluster. This abstraction allows developers to stay focused on their application logic rather than worry about the underlying query language.

Example of using ORMGenerator

Live Example - https://github.com/csharp-opensource/CSharp.OpenSource.LinqToKql/blob/master//Samples/ORMGeneratorTest/

Generate

        var providerExecutor = _mockExecutor.Object;
        var ormGenerator = new ORMGenerator(new()
        {
            ProviderExecutor = providerExecutor,
            ModelsFolderPath = "../../../../ORMGeneratorTests/Models",
            DbContextFolderPath = "../../../../ORMGeneratorTests",
            DbContextName = "AutoGenORMKustoDbContext",
            Namespace = "AutoGen",
            ModelsNamespace = "AutoGen",
            DbContextNamespace = "AutoGen",
            CreateDbContext = true,
            CleanFolderBeforeCreate = true,
            EnableNullable = true,
            FileScopedNamespaces = true,
            DatabaseConfigs = new List<ORMGeneratorDatabaseConfig>
            {
                new ORMGeneratorDatabaseConfig
                {
                    DatabaseName = DbName1,
                    Filters = new ORMGeneratorFilterConfig()
                },
                new ORMGeneratorDatabaseConfig
                {
                    DatabaseName = DbName2,
                    DatabaseDisplayName = "db2",
                    Filters = new ORMGeneratorFilterConfig()
                }
            }
        });
        await _ormGenerator.GenerateAsync();
        // output example https://github.com/csharp-opensource/CSharp.OpenSource.LinqToKql/tree/master/Samples/ORMGeneratorTest

Usage

using AutoGen;
using CSharp.OpenSource.LinqToKql.Extensions;
using CSharp.OpenSource.LinqToKql.Http;
using Microsoft.Extensions.DependencyInjection;

var services = new ServiceCollection();
services.AddKustoDbContext<AutoGenORMKustoDbContext, KustoHttpClient>(sp => new KustoHttpClient("mycluster", "auth", "dbName"));
var provider = services.BuildServiceProvider();
var dbContext = provider.GetRequiredService<AutoGenORMKustoDbContext>();

dbContext.TestTable1.Where(x => x.TestColumn == "test").ToList();
dbContext.db2<object>("customQuery").ToList();
dbContext.func1().ToList();
dbContext.func2("name", "lastName").ToList();

Manual DbContext Example

For example, a simple LINQ query like Full Example:

var result = context.SampleObjects.Where(o => o.Year > 2000);

using CSharp.OpenSource.LinqToKql.Provider;
using CSharp.OpenSource.LinqToKql.Test.Model;
using CSharp.OpenSource.LinqToKql.Translator;

namespace CSharp.OpenSource.LinqToKql.Test.Provider;

public class MyMultiDbContext : KustoDbContext
{
    public MyMultiDbContext(IKustoDbContextExecutor<MyMultiDbContext> executor) : base(executor)
    {
    }

    // from default db
    public IQueryable<SampleObject> SampleObjects
        => CreateQuery<SampleObject>("sampleObjects");

    // from different db
    public IQueryable<SampleObject2> SampleObjects2
        => CreateQuery<SampleObject2>("sampleObjects2", database: "diffDb");

    public IQueryable<SampleObject> Func(int minYear)
        => CreateQuery<SampleObject>($"sampleObjects | where year > {minYear}");

    public IQueryable<SampleObject> Func2(int minYear)
        => CreateQuery<SampleObject>($"sampleObjectsByMinYear({minYear})");

    public IQueryable<SampleObject> Func3(int minYear)
        => SampleObjects.Where(x => x.Year > minYear);

    protected override LinqToKQLQueryTranslatorConfig GetConfig() => new() { DisableNestedProjection = true };
}

public class MyMultiDbContext2 : MyMultiDbContext
{
    public MyMultiDbContext2(IKustoDbContextExecutor<MyMultiDbContext> executor) : base(executor)
    {
    }
}

Will be translated by ORMGEN into a corresponding KQL query that fetches the relevant data from the Kusto database. This ensures developers can work with a high-level API without sacrificing performance or flexibility.

Benefits of Using CSharp.OpenSource.LinqToKql with ORMGEN

Efficiency: Save time by using LINQ, which is widely known in the .NET ecosystem, instead of learning KQL.
Error Reduction: Let ORMGEN handle query generation automatically, reducing the risk of errors in manual query writing.
Seamless Integration: Leverage the power of LINQ while interacting with Kusto databases.
Open Source: As an open-source project, CSharp.OpenSource.LinqToKql is free to use and open for contributions. If you’re passionate about improving this tool, you can contribute to the project on GitHub. Whether it’s fixing bugs, adding features, or improving documentation, your contributions are welcome.

Getting Involved

CSharp.OpenSource.LinqToKql is actively looking for contributors to help improve and expand its functionality. Whether you’re an expert in Kusto or just passionate about making open-source tools better, your help would be greatly appreciated.

Check out the GitHub repository to get started with contributing. You can submit bug reports, create feature requests, or even open pull requests with your own improvements to the project.

Conclusion

CSharp.OpenSource.LinqToKql is a great tool for .NET developers working with Azure Data Explorer and Kusto queries. Its integration with LINQ and the automatic query generation via ORMGEN makes working with Kusto databases easier and more efficient.

If you’re interested in making the project even better, don’t forget that it’s open-source and the team is actively seeking contributors. Start contributing today and help make this tool even more powerful for the .NET community!

For more details, visit the GitHub repository.

Supercharge Your API Development with OpenAPI Toolkit 🚀

Wed, 04 Dec 2024 12:05:23 +0000

The world of APIs is vast, but developing and integrating them doesn’t have to be complicated. Introducing OpenAPI Toolkit—an open-source solution designed to streamline the way you work with OpenAPI (formerly Swagger) specifications.

What is OpenAPI Toolkit?

OpenAPI Toolkit is a developer’s dream come true. By taking an OpenAPI/Swagger file as input, the toolkit automatically generates both server and client code. This simplifies API integration and development by reducing manual errors, ensuring consistency, and speeding up workflows.

Whether you’re building a new service or integrating with existing APIs, OpenAPI Toolkit provides ready-to-use, tailored code that adheres to your specifications.

Key Features

Automatic Code Generation:
Generate server and client code instantly from your OpenAPI/Swagger specifications.
Versatile Integration:
Supports multiple languages and frameworks, including TypeScript, Python, Go, and C#.
Error Reduction:
Eliminates manual coding errors and ensures accuracy across implementations.
Consistency Across Platforms:
Guarantees uniformity, making APIs easier to manage and scale.

Installation

You can install OpenAPI Toolkit using npm:

npm i openapi-toolkit

For global CLI usage:

npm i -g openapi-toolkit

Getting Started

Auto-Generate Client/Server Code

With CLI:

openapi-toolkit -i https://petstore3.swagger.io/api/v3/openapi.json -g typescript-axios -o ./src/services/petStore --modelNamePrefix My --modelNameSuffix .dto

With Docker:

docker run --rm --name openapi-toolkit -v "$(pwd)/output:/output" -e CLI_PARAMS="-i https://petstore3.swagger.io/api/v3/openapi.json -g typescript-axios --modelNamePrefix My --modelNameSuffix .dto" barnuri/openapi-toolkit

Auto-Generate Programmatically

Here’s an example of how to use the toolkit in Node.js:

const { multipleGenerate, generate } = require('openapi-toolkit');

// Generate multiple outputs
(async () => {
    const sharedConfig = { debugLogs: false };
    await multipleGenerate(`https://petstore3.swagger.io/api/v3/openapi.json`, [
        { ...sharedConfig, generator: 'typescript-react-query', output: `./typescript-react-query/src` },
        { ...sharedConfig, generator: 'typescript-axios', output: `./typescript-axios/src` },
        { ...sharedConfig, generator: 'c#', output: `./c#/src` },
        { ...sharedConfig, generator: 'go', output: `./go/src` },
        { ...sharedConfig, generator: 'python', output: `./python/src` },
    ]);
})();

// Generate a single output
(async () => {
    await generate({ pathOrUrl: `https://petstore3.swagger.io/api/v3/openapi.json`, generator: 'typescript-react-query', output: `./typescript-react-query/src` });
})();

CLI Options

Use the -h flag to see all available CLI options:

openapi-toolkit <command>, default command 'generate'

Commands:
  generate    auto generate proxy client from swagger file             [default]
  generators  generators list
  completion  generate completion script

Options:
      --version                Show version number                     [boolean]
  -h, --help                   Show help                               [boolean]
  -i, --pathOrUrl              path or url for swagger file           [required]
  -o, --output                 output path                            [required]
  -g, --generator              generator name      [default: "typescript-axios"]
  -t, --type                   [choices: "client", "server"] [default: "client"]
  -n, --namespace                         [default: "OpenapiDefinitionGenerate"]
      --modelsFolderName                                     [default: "models"]
      --modelNamePrefix                                            [default: ""]
      --modelNameSuffix                                            [default: ""]

VSCode Plugin

Boost productivity with the VSCode Plugin for Auto-Generate.

Examples

Check out the examples for more use cases.

Contribute

OpenAPI Toolkit thrives on community contributions! Found a bug or have a feature request? Visit the GitHub repository and join the discussion.

With OpenAPI Toolkit, API development has never been this effortless. Try it today and revolutionize your workflow!

codegen

Posts by Category : codegen

05 Dec 2024 C# LINQ to KQL with ORMGEN OpenSource

04 Dec 2024 Supercharge Your API Development with OpenAPI Toolkit 🚀

.NET

Posts by Category : .NET

05 Dec 2024 C# LINQ to KQL with ORMGEN OpenSource

sample_category

Posts by Category : {{ page.title }}

{% for post in site.categories.sample_category %}

{% endfor %}

Bar Nuri

C# LINQ to KQL with ORMGEN OpenSource

CSharp.OpenSource.LinqToKql: LINQ to KQL with ORMGEN

ORMGEN: Auto-Generation of KQL Queries

How ORMGEN Works

Example of using ORMGenerator

Generate

Usage

Manual DbContext Example

Benefits of Using CSharp.OpenSource.LinqToKql with ORMGEN

Getting Involved

Conclusion

Supercharge Your API Development with OpenAPI Toolkit 🚀

What is OpenAPI Toolkit?

Key Features

Installation

Getting Started

Auto-Generate Client/Server Code

Auto-Generate Programmatically

CLI Options

VSCode Plugin

Examples

Contribute

codegen

C# LINQ to KQL with ORMGEN OpenSource

Supercharge Your API Development with OpenAPI Toolkit 🚀

dotnet

C# LINQ to KQL with ORMGEN OpenSource

codegen

Posts by Category : codegen

.NET

Posts by Category : .NET

sample_category

Posts by Category : {{ page.title }}