1

Improve readme

This commit is contained in:
2018-05-05 19:40:42 +03:00
parent 361f0998c6
commit fe7a994921

View File

@@ -4,3 +4,30 @@ This is a framework for working with SQL transactions in a distributed network.
transactions of multiple queries on different nodes and execute them later. transactions of multiple queries on different nodes and execute them later.
To ensure the reliability of the transactions a ledger using blockchain is used to keep track on ongoing transactions. To ensure the reliability of the transactions a ledger using blockchain is used to keep track on ongoing transactions.
## DBT Core
The core library containing the DBTModule to include in your Ratpack application.
The DBT module can be added like so:
```groovy
bindings {
module (DBTModule) { config ->
config.ledger.remoteUrl = 'http://localhost:5050/ledger'
config.executor.remoteUrl = 'http://localhost:5050/executor'
}
}
```
## DBT Demo
Demo application for testing the transactions.
The demo application has a database with one table LOGS which you can use to insert and select data from.
The demo can be run by running ``./gradlew :dbt-demo:run`` after which the demo is running on http://localhost:5050
## DBT Test
The test module contains all the integration tests for the module.