Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dotnetcore/CanalSharp
Alibaba mysql database binlog subscription & consumer components Canal's .NET client.
https://github.com/dotnetcore/CanalSharp
binlog canal canal-client cdc mysql netcore netstandard20 real-time
Last synced: 1 day ago
JSON representation
Alibaba mysql database binlog subscription & consumer components Canal's .NET client.
- Host: GitHub
- URL: https://github.com/dotnetcore/CanalSharp
- Owner: dotnetcore
- License: apache-2.0
- Created: 2018-08-15T11:16:55.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-27T06:00:41.000Z (about 2 months ago)
- Last Synced: 2024-10-07T08:18:29.548Z (about 1 month ago)
- Topics: binlog, canal, canal-client, cdc, mysql, netcore, netstandard20, real-time
- Language: C#
- Homepage:
- Size: 990 KB
- Stars: 576
- Watchers: 18
- Forks: 96
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# CanalSharp
[](https://www.nuget.org/packages/CanalSharp/) [](https://github.com/dotnetcore)
CanalSharp 是阿里巴巴开源项目 mysql 数据库 binlog 的增量订阅&消费组件 Canal 的 **.NET 客户端**。在数据库中，**更改数据捕获**（**CDC**）是一组软件设计模式，用于确定和跟踪已更改的数据，以便可以使用已更改的数据来采取措施，Canal 便是 mysql 数据库的一种 cdc 组件。
## 快速入门
### 安装
```shell
Install-Package CanalSharp
```
### 初始化日志
```csharp
var loggerFactory = LoggerFactory.Create(builder =>
{
builder
.AddFilter("Microsoft", LogLevel.Debug)
.AddFilter("System", LogLevel.Information)
.AddConsole();
});
var logger= loggerFactory.CreateLogger();
```
CanalSharp 使用 **Microsoft.Extensions.Logging.Abstractions** ，因为目前主流日志组件，如：nlog、serilog 等，全部支持此日志抽象接入，也就是说你可以通过安装 nlog、serilog 对其的适配，来使用它们，无论是 Console App 或则是 Web App。
### 创建连接
```csharp
var conn=new SimpleCanalConnection(new SimpleCanalOptions("127.0.0.1",11111,1234),logger);
//连接到 Canal Server
await conn.ConnectAsync();
//订阅
await conn.SubscribeAsync();
```
### 获取数据
```csharp
var msg = await conn.GetAsync(1024);
```
## 支持版本
| CanalSharp | Canal |
|------------|-------|
| 1.2.0 | 1.1.6 |
Mysql 版本由 Canal 决定。
## 文档
Github: [docs](https://github.com/dotnetcore/CanalSharp/tree/main/docs/zh)
WebSite: [Canal Document](https://canalsharp.azurewebsites.net/zh/) (推荐)
## 问题反馈
请通过 [Issue](https://github.com/dotnetcore/CanalSharp/issues/new) 向我们提交问题反馈，在提交时尽可能提供详细的信息，以便我们进行排查和解决。
## 贡献代码
如果你有一些好的想法，欢迎您提交 [Pull Request](https://github.com/dotnetcore/canalsharp/pulls) 或者 [Issue](https://github.com/dotnetcore/CanalSharp/issues/new)
## 重构进度
目前重构的版本已经完全覆盖旧版本，且性能更高，代码更优美，实现了旧版本未实现的部分功能，支持最新的 Canal。
| Task | Status |
|--------------------------------|---------------|
| protobuf 3 协议生成 | 已完成 |
| 对接 Canal | 已完成 |
| 数据订阅封装 | TODO |
| 集群支持(Service 集群和 Client 集tgi群) | 已完成 |
| 数据发送到Kafka | 直接通过 Canal 发送 |
| 数据发送到Redis | 直接通过 Canal 发送 |