ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2025-11-28 07:35:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

update review guide

Browse Source
This commit is contained in:
CJ Cobb
2021-08-19 10:35:24 -04:00
parent c452bc7e64
commit 236aea89be
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
REVIEW.md
View File

@@ -21,11 +21,13 @@ generally depends on the data model and the way we talk to the database.
Reviewers should start with the README in this folder to get a high level idea
of the data model and to review the data model itself. Then, reviewers should
dive into the implementation. A good way to approach the implementation would
be to go through the functions in BackendInterface, and review each of their
implementations in PostgresBackend and CassandraBackend. Reviewers can also
look at how these functions are being used. This will take you into other parts
of the code, which you can review as well.
dive into the implementation. The table schemas and queries for Cassandra are
defined in `CassandraBackend::open()`. The table schemas for Postgres are defined
in Pg.cpp. The queries for Postgres are defined in each of the functions of `PostgresBackend`.
A good way to approach the implementation would be to look at the table schemas,
and then go through the functions declared in `BackendInterface`. Reviewers could
also branch out to the rest of the code by looking at where these functions are
called from.
### server
The code in the server folder implements the web server for handling RPC requests.
@@ -66,6 +68,10 @@ in time. Refer to the `fetchAccountTransactions()` function in `CassandraBackend
It is unclear if this needs to be done for other tables.
### Postgres table partitioning
Originally, Postgres exhibited performance problems when the dataset approach 1
TB. This was solved by table partitioning.
### Threading
I used asio for multithreading. There are a lot of different io_contexts lying
around the code. This needs to be cleaned up a bit. Most of these are really