Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.MD #33

Merged
merged 1 commit into from
Sep 24, 2024
Merged

Update README.MD #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,21 @@
# Aardappel
![image](https://github.com/dcherednik/Aardappel/assets/1076097/ff74dfd7-1891-4247-878b-51d674923dea)

The Aardappel is an lightweight CDC receiver for consistent asynchronous replication of data changes between YDB databases. It is designed to simplify integration between different applications which use the YDB database for persistent storage, or the independently maintained/upgraded instances of a same application.

### How does it work
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>;

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

### How to build
Just run
```
go build
```
Loading