Skip to content

Commit aefbf48

Browse files
authored
Update README.md
1 parent b12d82d commit aefbf48

File tree

1 file changed

+29
-27
lines changed

1 file changed

+29
-27
lines changed

README.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,47 @@
11
# CanalSharp
22

3-
## 重构进度
3+
## 重构进度
44

5-
目前重构的版本已经完全覆盖旧版本,且性能更高,代码更优美,实现了旧版本未实现的部分功能。
5+
目前重构的版本已经完全覆盖旧版本,且性能更高,代码更优美,实现了旧版本未实现的部分功能。
66

77
English README.md Will be provided after the refactoring is complete.
88

9+
旧版本代码:https://github.com/dotnetcore/CanalSharp/tree/release/0.2.0
10+
911
| Task | Status |
1012
| ------------------- | ------ |
11-
| protobuf 3 协议生成 | 已完成 |
12-
| 对接 Canal | 已完成 |
13-
| 数据订阅封装 | |
14-
| 集群支持(热备) | |
15-
| 数据发送到Kafka | |
16-
| 数据发送到Redis | |
13+
| protobuf 3 协议生成 | 已完成 |
14+
| 对接 Canal | 已完成 |
15+
| 数据订阅封装 | |
16+
| 集群支持(热备) | |
17+
| 数据发送到Kafka | |
18+
| 数据发送到Redis | |
1719

18-
## 快速入门
20+
## 快速入门
1921

20-
>先决条件:安装Java环境和需要使用的数据库开启binlog
22+
>先决条件:安装Java环境和需要使用的数据库开启binlog
2123
22-
### 1.运行 Canal Server
24+
### 1.运行 Canal Server
2325

24-
(1)下载最新的 Canal Server https://github.com/alibaba/canal/releases/latest, 下载 `canal.deployer-版本号-SNAPSHOT.tar.gz` 文件
26+
(1)下载最新的 Canal Server https://github.com/alibaba/canal/releases/latest, 下载 `canal.deployer-版本号-SNAPSHOT.tar.gz` 文件
2527

26-
(2)配置
28+
(2)配置
2729

28-
编辑文件 `conf/example/instance.properties`
30+
编辑文件 `conf/example/instance.properties`
2931

30-
设置 MySql 地址:`canal.instance.master.address=`
32+
设置 MySql 地址:`canal.instance.master.address=`
3133

32-
设置 MySql 用户:`canal.instance.dbUsername=`
34+
设置 MySql 用户:`canal.instance.dbUsername=`
3335

34-
设置 MySql 密码:`canal.instance.dbPassword=`
36+
设置 MySql 密码:`canal.instance.dbPassword=`
3537

36-
(3)运行
37-
进入 `bin` 目录,根据你的系统选择脚本运行。
38+
(3)运行
39+
进入 `bin` 目录,根据你的系统选择脚本运行。
3840

39-
### 2.使用
41+
### 2.使用
4042

4143
````csharp
42-
//初始化日志
44+
//初始化日志
4345
using var loggerFactory = LoggerFactory.Create(builder =>
4446
{
4547
builder
@@ -48,19 +50,19 @@ using var loggerFactory = LoggerFactory.Create(builder =>
4850
.AddConsole();
4951
});
5052

51-
//创建连接
52-
var conn=new SimpleCanalConnection(new SimpleCanalConnectionOptions(Canal Server 地址,端口 默认 11111,ClientId 自定义), loggerFactory.CreateLogger<SimpleCanalConnection>());
53+
//创建连接
54+
var conn=new SimpleCanalConnection(new SimpleCanalConnectionOptions(Canal Server 地址,端口 默认 11111,ClientId 自定义), loggerFactory.CreateLogger<SimpleCanalConnection>());
5355

54-
//连接到 Canal Server
56+
//连接到 Canal Server
5557
await conn.ConnectAsync();
56-
//订阅需要处理的数据
58+
//订阅需要处理的数据
5759
await conn.SubscribeAsync();
5860
while (true)
5961
{
60-
//获取数据
62+
//获取数据
6163
var msg = await conn.GetAsync(1024);
6264
await Task.Delay(300);
6365
}
6466
````
6567

66-
>更详细的文档将在重构完成后提供
68+
>更详细的文档将在重构完成后提供

0 commit comments

Comments
 (0)