ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2025-12-06 17:27:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

style: Add markdownlint pre-commit hook (#2038)

Browse Source 
Co-authored-by: Maria Shodunke <maria-robobug@users.noreply.github.com>
This commit is contained in:
Ayaz Salikhov
2025-04-28 16:31:07 +01:00
committed by GitHub
parent b51ed8dd98
commit 4a0267fbac
13 changed files with 116 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/migration/README.md
View File

@@ -6,9 +6,10 @@ Clio maintains the off-chain data of XRPL and multiple indexes tables to powerin
Clio provides a migration command-line tool to migrate data in database.
> Note: We need a **configuration file** to run the migration tool. This configuration file has the same format as the configuration file of the Clio server, ensuring consistency and ease of use. It reads the database configuration from the same session as the server's configuration, eliminating the need for separate setup or additional configuration files. Be aware that migration-specific configuration is under `.migration` session.
> [!NOTE]
> We need a **configuration file** to run the migration tool. This configuration file has the same format as the configuration file of the Clio server, ensuring consistency and ease of use. It reads the database configuration from the same session as the server's configuration, eliminating the need for separate setup or additional configuration files. Be aware that migration-specific configuration is under `.migration` session.
### To query migration status:
### Query migration status
./clio_server --migrate status ~/config/migrator.json
@@ -17,7 +18,7 @@ This command returns the current migration status of each migrator. The example
Current Migration Status:
Migrator: ExampleMigrator - Feature v1, Clio v3 - not migrated
### To start a migration:
### Start a migration
./clio_server --migrate ExampleMigrator ~/config/migrator.json
@@ -51,7 +52,8 @@ Sometimes migrator isn't able to query the historical data by table's partition
Most indexes are based on either ledger states or transactions. We provide the `objects` and `transactions` scanner. Developers only need to implement the callback function to receive the historical data. Please find the examples in `tests/integration/migration/cassandra/ExampleTransactionsMigrator.cpp` and `tests/integration/migration/cassandra/ExampleObjectsMigrator.cpp`.
> **Note** The full table scanner splits the table into multiple ranges by token(https://opensource.docs.scylladb.com/stable/cql/functions.html#token). A few of rows maybe read 2 times if its token happens to be at the edge of ranges. **Deduplication is needed** in the callback function.
> [!NOTE]
> The full table scanner splits the table into multiple ranges by token(<https://opensource.docs.scylladb.com/stable/cql/functions.html#token>). A few of rows maybe read 2 times if its token happens to be at the edge of ranges. **Deduplication is needed** in the callback function.
## How to write a full table scan adapter (Only for Cassandra/ScyllaDB)
@@ -68,7 +70,7 @@ If you need to do full scan against other table, you can follow below steps:
Please take ObjectsAdapter/TransactionsAdapter as example.
## Examples:
## Examples
We have some example migrators under `tests/integration/migration/cassandra` folder.