👁 Image
Ksql.Linq 1.1.0

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

2. Copy the AI Assistant Guide to your clipboard:

dotnet ksql ai-assist --copy

3. 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.