Skip to content

Commit

Permalink
Update version to 2.4.1 (#282)
Browse files Browse the repository at this point in the history
* Update version to 2.4.1

* Added trademark on Kafka
  • Loading branch information
masesdevelopers authored Sep 20, 2024
1 parent d49a027 commit 935ae75
Show file tree
Hide file tree
Showing 16 changed files with 124 additions and 124 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# KEFCore: [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/)
# KEFCore: [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/)

KEFCore is the [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/).
Based on [KNet](https://github.com/masesgroup/KNet) it allows to use [Apache Kafka](https://kafka.apache.org/) as a distributed database and more.
KEFCore is the [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/).
Based on [KNet](https://github.com/masesgroup/KNet) it allows to use [Apache Kafka](https://kafka.apache.org/) as a distributed database and more.

### Libraries and Tools

Expand All @@ -24,13 +24,13 @@ Its primary scope is to support other, public or internal, MASES Group projects:

The repository code and releases may contain bugs, the release cycle depends from critical discovered issues and/or enhancement requested from this or other projects.

Looking for the help of [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) and [Apache Kafka](https://kafka.apache.org/) experts? MASES Group can help you design, build, deploy, and manage [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) and [Apache Kafka](https://kafka.apache.org/) applications.
Looking for the help of [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) and [Apache Kafka](https://kafka.apache.org/) experts? MASES Group can help you design, build, deploy, and manage [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) and [Apache Kafka](https://kafka.apache.org/) applications.

---

## Scope of the project

This project aims to create a provider to access the information stored within an Apache Kafka cluster using the paradigm behind Entity Framework.
This project aims to create a provider to access the information stored within an Apache Kafka cluster using the paradigm behind Entity Framework.
The project is based on available information within the official [EntityFrameworkCore repository](https://github.com/dotnet/efcore), many classes was copied from there as reported in the official documentation within the Microsoft website at https://docs.microsoft.com/en-us/ef/core/providers/writing-a-provider.

### Community and Contribution
Expand Down Expand Up @@ -68,9 +68,9 @@ KEFCore uses [KNet](https://github.com/masesgroup/KNet), and indeed [JCOBridge](
* [JVM](https://en.wikipedia.org/wiki/Java_virtual_machine) and [CLR, or CoreCLR,](https://en.wikipedia.org/wiki/Common_Language_Runtime) runs in the same process, but are insulated from each other;
* JCOBridge does not make any code injection into JVM;
* JCOBridge does not use any other communication mechanism than JNI;
* .NET (CLR) inherently inherits the cyber-security levels of running JVM and Apache Kafka;
* .NET (CLR) inherently inherits the cyber-security levels of running JVM and Apache Kafka;
* **Direct access the JVM from any .NET application**:
* Any Java/Scala class behind Apache Kafka can be directly managed: Consumer, Producer, Administration, Streams, Server-side, and so on;
* Any Java/Scala class behind Apache Kafka can be directly managed: Consumer, Producer, Administration, Streams, Server-side, and so on;
* No need to learn new APIs: we try to expose the same APIs in C# style;
* No extra validation cycle on protocol and functionality: bug fix, improvements, new features are immediately available;
* Documentation is shared.
Expand Down
4 changes: 2 additions & 2 deletions src/documentation/articles/currentstate.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Current development state of KEFCore
_description: Describes the current development state of Entity Framework Core provider for Apache Kafka
_description: Describes the current development state of Entity Framework Core provider for Apache Kafka
---

# KEFCore: development state

The latest release implementes these features:

* [x] A working provider based on Apache Kafka Streams
* [x] A working provider based on Apache Kafka Streams
* [x] The provider can use KNetCompactedReplicator
* [x] A base package for serialization based on .NET Json serializers
* [x] An external package for serialization based on Apache Avro serializers
Expand Down
10 changes: 5 additions & 5 deletions src/documentation/articles/externalapplication.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: External applications of KEFCore
_description: Describes how to use data managed by Entity Framework Core provider for Apache Kafka from external applications
_description: Describes how to use data managed by Entity Framework Core provider for Apache Kafka from external applications
---

# KEFCore: external application

[Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/) shall convert the entities used within the model in something viable from the backend.
Continuing from the concepts introduced in [serialization](serialization.md), an external application can use the data stored in the topics in a way it decides: [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/) gives some helpers to get back the CLR Entity objects stored in the topics.
[Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/) shall convert the entities used within the model in something viable from the backend.
Continuing from the concepts introduced in [serialization](serialization.md), an external application can use the data stored in the topics in a way it decides: [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/) gives some helpers to get back the CLR Entity objects stored in the topics.

> 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.
## Basic concepts

An external application may want to be informed about data changes in the topics and want to analyze the Entity was previously managed from the EFCore application.
Within the core packages there is the `EntityExtractor` class which contains, till now, few methods and one accepts a raw `ConsumerRecord<byte[], byte[]>` from Apache Kafka.
Within the core packages there is the `EntityExtractor` class which contains, till now, few methods and one accepts a raw `ConsumerRecord<byte[], byte[]>` from Apache Kafka.
The method reads the info stored in the `ConsumerRecord<byte[], byte[]>` and returns the Entity object with the filled properties.

It is possible to build a new application which subscribe to a topic created from the EFCore application.
Expand Down Expand Up @@ -45,4 +45,4 @@ To work properly it needs, to be loaded in memory, at least:

## Possible usages

For possible usages of [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/), and this feature, see [use cases](usecases.md)
For possible usages of [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/), and this feature, see [use cases](usecases.md)
8 changes: 4 additions & 4 deletions src/documentation/articles/gettingstarted.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Getting started with KEFCore
_description: Describes how to start to use Entity Framework Core provider for Apache Kafka
_description: Describes how to start to use Entity Framework Core provider for Apache Kafka
---

# KEFCore: Getting started

To use [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/) you must have at least:
To use [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/) you must have at least:
- an installed JRE/JDK (11+)
- an accessible Apache Kafka broker (a full cluster or a local Dockerized version)
- 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.
Expand All @@ -19,7 +19,7 @@ To use [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provi
dotnet new console
```

- Entity Framework Core provider for Apache Kafka is available on [NuGet](https://www.nuget.org/packages/MASES.EntityFrameworkCore.KNet). Execute the following command to add the package to the newly created project:
- Entity Framework Core provider for Apache Kafka is available on [NuGet](https://www.nuget.org/packages/MASES.EntityFrameworkCore.KNet). Execute the following command to add the package to the newly created project:

```pwsh
dotnet add package MASES.EntityFrameworkCore.KNet
Expand Down
Loading

0 comments on commit 935ae75

Please sign in to comment.