Ksql.Linq 1.0.0

dotnet add package Ksql.Linq --version 1.0.0
                    
NuGet\Install-Package Ksql.Linq -Version 1.0.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Ksql.Linq" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Ksql.Linq" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Ksql.Linq" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Ksql.Linq --version 1.0.0
                    
#r "nuget: Ksql.Linq, 1.0.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Ksql.Linq@1.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Ksql.Linq&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Ksql.Linq&version=1.0.0
                    
Install as a Cake Tool

Ksql.Linq — An Entity Framework-style library for Kafka / ksqlDB

It enables database engineers to use Kafka and ksqlDB with an Entity Framework-style development model, and your AI, powered by the AI Assistant Guide, can help a lot when you need support with Kafka.

AI-assisted guidance for developers

To use the AI Assistant Guide with your AI assistant (ChatGPT, Claude, Gemini, etc.):

  1. Install the CLI (Ksql.Linq.Cli version 1.0.0 or later):
dotnet tool install --global Ksql.Linq.Cli --version 1.0.0
  1. Copy the AI Assistant Guide to your clipboard:
dotnet ksql ai-assist --copy
  1. Paste it into your AI console and ask it to act as a design assistant for your Ksql.Linq project.

Release Notes

Version-specific changes (including v0.9.7 and later) are documented in the Release notes section of this NuGet page.


Documentation

For full documentation, advanced usage, and design notes, see the project wiki:

Ksql.Linq Wiki
https://github.com/synthaicode/Ksql.Linq/wiki

Minimal Quick Start

NOTE: In this repo's docker-compose test environment, use
127.0.0.1:39092 (Kafka) / 18081 (Schema Registry) / 18088 (ksqlDB).
Samples below align to these ports. Adjust URLs when using external services.

This document is a minimal quick start guide for Ksql.Linq NuGet consumers.


Prerequisites

  • .NET 8 SDK
  • Kafka / Schema Registry / ksqlDB running

Minimal appsettings.json

{
  "KsqlDsl": {
    "Common": {
      "BootstrapServers": "127.0.0.1:39092",
      "ClientId": "my-app"
    },
    "SchemaRegistry": {
      "Url": "http://127.0.0.1:18081"
    },
    "KsqlDbUrl": "http://127.0.0.1:18088"
  }
}

Minimal code (produce / consume)

using Ksql.Linq;
using Ksql.Linq.Core.Attributes;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;

[KsqlTopic("quickstart-basic")]
public class Hello
{
    public int Id { get; set; }
    public string Text { get; set; } = "";
}

public class AppCtx : KsqlContext
{
    public AppCtx(IConfiguration cfg, ILoggerFactory? lf = null)
        : base(cfg, lf) { }

    public EventSet<Hello> Hellos { get; set; } = null!;

}

var cfg = new ConfigurationBuilder()
    .AddJsonFile("appsettings.json")
    .Build();

await using var ctx = new AppCtx(
    cfg,
    LoggerFactory.Create(b => b.AddConsole())
);

await ctx.Hellos.AddAsync(new Hello
{
    Id = 1,
    Text = "Hello Ksql.Linq"
});

await ctx.Hellos.ForEachAsync(m =>
{
    Console.WriteLine(m.Text);
    return Task.CompletedTask;
});

Notes

Use KsqlDsl:Topics.{name}.Creation.* to control partitions / retention per topic.

For secured clusters, configure SecurityProtocol / Sasl* under KsqlDsl:Common.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 652 12/1/2025
0.9.8 179 11/24/2025
0.9.7 147 11/23/2025
0.9.6 277 11/21/2025
0.9.5 392 11/19/2025
0.9.4 121 11/16/2025
0.9.3 120 11/16/2025
0.9.2 118 11/16/2025
0.9.1-rc5 256 11/12/2025
0.9.1-rc4 266 11/12/2025