MASES.EntityFrameworkCore.KNet
2.4.1
dotnet add package MASES.EntityFrameworkCore.KNet --version 2.4.1
NuGet\Install-Package MASES.EntityFrameworkCore.KNet -Version 2.4.1
<PackageReference Include="MASES.EntityFrameworkCore.KNet" Version="2.4.1" />
paket add MASES.EntityFrameworkCore.KNet --version 2.4.1
#r "nuget: MASES.EntityFrameworkCore.KNet, 2.4.1"
// Install MASES.EntityFrameworkCore.KNet as a Cake Addin #addin nuget:?package=MASES.EntityFrameworkCore.KNet&version=2.4.1 // Install MASES.EntityFrameworkCore.KNet as a Cake Tool #tool nuget:?package=MASES.EntityFrameworkCore.KNet&version=2.4.1
title: Getting started with KEFCore _description: Describes how to start to use Entity Framework Core provider for Apache Kafka™
KEFCore: Getting started
To use Entity Framework Core provider for Apache Kafka™ you must have at least:
- an installed JRE/JDK (11+)
- an accessible Apache Kafka™ broker (a full cluster or a local Dockerized version)
IMPORTANT NOTE: till the first major version, all releases shall be considered not stable: this means the API public, or internal, can change without notice.
First project setup
- Create a new simple empty project:
dotnet new console
- Entity Framework Core provider for Apache Kafka™ is available on NuGet. Execute the following command to add the package to the newly created project:
dotnet add package MASES.EntityFrameworkCore.KNet
- Edit Program.cs and replace the content with the following code:
using MASES.EntityFrameworkCore.KNet.Infrastructure;
using System.Collections.Generic;
namespace MASES.EntityFrameworkCore.KNet.Test
{
class Program
{
static void Main(string[] args)
{
KEFCore.CreateGlobalInstance();
using var context = new BloggingContext()
{
BootstrapServers = "MY-KAFKA-BROKER:9092",
ApplicationId = "MyAppId",
DbName = "MyDBName",
};
// add standard EFCore queries
}
}
public class BloggingContext : KafkaDbContext { }
public class Blog
{
public int BlogId { get; set; }
public string Url { get; set; }
public int Rating { get; set; }
public List<Post> Posts { get; set; }
}
public class Post
{
public int PostId { get; set; }
public string Title { get; set; }
public string Content { get; set; }
public int BlogId { get; set; }
public Blog Blog { get; set; }
}
}
The previous code follows the example of https://learn.microsoft.com/en-us/ef/core/. See KEFCore usage and KafkaDbContext to find more information.
- Build the project
dotnet build
Environment initialization
KEFCore shall initialize the environment before any operation can be done. The initialization is done executing the following command at first stages of your application:
KEFCore.CreateGlobalInstance();
The previous command identify the JVM and start it, loads the needed libraries and setup the environment. Browsing the repository within the test folder there are some examples. KEFCore accepts many command-line switches to customize its behavior, the full list is available at Command line switch of KNet.
JVM identification
One of the most important command-line switch is JVMPath and it is available in JCOBridge switches: it can be used to set-up the location of the JVM library if JCOBridge is not able to identify a suitable JRE/JDK installation. If a developer is using KEFCore within its own product it is possible to override the JVMPath property with a snippet like the following one:
class MyKEFCore : KEFCore
{
public override string JVMPath
{
get
{
string pathToJVM = "Set here the path to JVM library or use your own search method";
return pathToJVM;
}
}
}
IMPORTANT NOTE: pathToJVM
shall be escaped
string pathToJVM = "C:\\Program Files\\Eclipse Adoptium\\jdk-11.0.18.10-hotspot\\bin\\server\\jvm.dll";
string pathToJVM = @"C:\Program Files\Eclipse Adoptium\jdk-11.0.18.10-hotspot\bin\server\jvm.dll";
Special initialization conditions
JCOBridge try to identify a suitable JRE/JDK installation within the system using some standard mechanism of JRE/JDK: JAVA_HOME
environment variable or Windows registry if available.
However it is possible, on Windows operating systems, that the library raises an InvalidOperationException: Missing Java Key in registry: Couldn't find Java installed on the machine.
This means that neither JAVA_HOME
nor Windows registry contains information about a default installed JRE/JDK: some vendors may not setup them.
If the developer/user encounter this condition can do the following steps:
- On a command prompt execute
set | findstr JAVA_HOME
and verify the result; - If something was reported maybe the
JAVA_HOME
environment variable is not set at system level, but at a different level like user level which is not visible from the KEFCore process that raised the exception; - Try to set
JAVA_HOME
at system level e.g.JAVA_HOME=C:\Program Files\Eclipse Adoptium\jdk-11.0.18.10-hotspot\
; - Try to set
JCOBRIDGE_JVMPath
at system level e.g.JCOBRIDGE_JVMPath=C:\Program Files\Eclipse Adoptium\jdk-11.0.18.10-hotspot\
.
IMPORTANT NOTES:
- One of
JCOBRIDGE_JVMPath
orJAVA_HOME
environment variables or Windows registry (on Windows OSes) shall be available JCOBRIDGE_JVMPath
environment variable takes precedence overJAVA_HOME
and Windows registry: you can setJCOBRIDGE_JVMPath
toC:\Program Files\Eclipse Adoptium\jdk-11.0.18.10-hotspot\bin\server\jvm.dll
and avoid to overrideJVMPath
in your code- After first initialization steps,
JVMPath
takes precedence overJCOBRIDGE_JVMPath
/JAVA_HOME
environment variables or Windows registry
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. 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. |
-
net6.0
- MASES.EntityFrameworkCore.KNet.Serialization (>= 2.4.1)
-
net7.0
- MASES.EntityFrameworkCore.KNet.Serialization (>= 2.4.1)
-
net8.0
- MASES.EntityFrameworkCore.KNet.Serialization (>= 2.4.1)
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 |
---|---|---|
2.4.1 | 72,996 | 9/20/2024 |
2.4.0 | 39,967 | 8/17/2024 |
2.3.5 | 13,391 | 8/1/2024 |
2.3.4 | 5,249 | 7/30/2024 |
2.3.3 | 28,562 | 7/2/2024 |
2.3.2 | 53,580 | 6/27/2024 |
2.3.1 | 27,102 | 6/24/2024 |
2.3.0 | 41,100 | 5/27/2024 |
2.2.0 | 13,441 | 5/18/2024 |
2.1.1 | 17,839 | 5/4/2024 |
2.1.0 | 138,206 | 3/1/2024 |
2.0.2 | 57,226 | 2/12/2024 |
2.0.1 | 46,950 | 1/27/2024 |
2.0.0 | 11,160 | 1/21/2024 |
1.1.0 | 91,477 | 11/25/2023 |
1.0.0 | 26,724 | 10/22/2023 |