Skip to content

Commit

Permalink
Update README.md (#34)
Browse files Browse the repository at this point in the history
  • Loading branch information
dcherednik authored Sep 24, 2024
1 parent dd24579 commit 04da8e8
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@ The Aardappel is an lightweight CDC receiver for consistent asynchronous replica
The Apprdappel pod receives CDC streams from a source YDB database, restores linearizability of transaction using heartbeat info, and applies modifications atomically into the target YDB database.

### How to create compatible CDC
```
YDB_EXEC="ydb -e <DATABASE_ENDPOINT> -d <DATABASE_NAME>"
${YDB_EXEC} 'alter table <TABLE_NAME> add changefeed <CDC_NAME> with (format="JSON", mode="UPDATES", virtual_timestamps=true, resolved_timestamps = Interval("PT1S"));'
${YDB_EXEC} 'alter topic <TABLE_NAME>/<CDC_NAME> add consumer <CDC_CONSUMER_NAME>;
${YDB_EXEC} 'alter topic <TABLE_NAME>/<CDC_NAME> add consumer <CDC_CONSUMER_NAME>;'
```

### How to configure aardappel
[Configuration example](https://github.com/ydb-platform/aardappel/blob/main/cmd/aardappel/config.yaml)
Expand Down

0 comments on commit 04da8e8

Please sign in to comment.