https://github.com/ldbc/ldbc_finbench_driver
https://github.com/ldbc/ldbc_finbench_driver
finbench ldbc
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ldbc/ldbc_finbench_driver
- Owner: ldbc
- License: apache-2.0
- Created: 2022-04-24T11:56:52.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T06:06:58.000Z (about 1 year ago)
- Last Synced: 2025-04-14T03:07:14.959Z (about 1 year ago)
- Topics: finbench, ldbc
- Language: Java
- Homepage:
- Size: 6.67 MB
- Stars: 3
- Watchers: 15
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE.txt
- Code of conduct: code_of_conduct.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# LDBC FinBench Driver
The LDBC FinBench Driver is a powerful tool designed for benchmarking the performance of graph databases. This is the alpha version of the FinBench driver, currently undergoing alpha testing.
## 1. Configurations
The Driver initiates by reading the configuration file. The default configuration file path for DummyDB is `src/main/resources/example/ldbc_finbench_driver_dummy.properties`.
### 1.1 SUT Defined
If required, the System Under Test (SUT) can customize the configuration parameters to connect to the database or read the query file. This can include the request host, port, path, etc.
```shell
host=localhost
port=9091
user=admin
pass=123456
path=cypher/
```
### 1.2 DB
For a new implementation of the SUT, update this configuration parameter accordingly.
```shell
db=org.ldbcouncil.finbench.impls.dummy.DummyDb
```
### 1.3 Params
Please update based on your parameter path. The `parameters_dir` is the `ComplexRead` parameter path, and `updates_dir` is the `Write` and `ReadWrite` incremental data path.
```shell
ldbc.finbench.transaction.queries.parameters_dir=src/main/resources/example/data/read_params
ldbc.finbench.transaction.queries.updates_dir=src/main/resources/example/data/incremental_data
```
### 1.4 Mode
The driver operates in three modes:
- CREATE_VALIDATION
- VALIDATE_DATABASE
- EXECUTE_BENCHMARK
#### CREATE_VALIDATION
With `CREATE_VALIDATION` mode, you create a database result. `validation_parameters_size` denotes the number of results created, while `validate_database` refers to the file where the created results are stored.
```shell
mode=CREATE_VALIDATION
validation_parameters_size=100
validate_database=validation_params.csv
```
#### VALIDATE_DATABASE
`VALIDATE_DATABASE` mode allows you to verify the SUT. The `validate_database` is the result created by `CREATE_VALIDATION` mode.
```shell
mode=VALIDATE_DATABASE
validate_database=validation_params.csv
```
#### EXECUTE_BENCHMARK
Perform the performance test with `EXECUTE_BENCHMARK` mode. Here are some crucial configuration parameters that need adjustment when operating the driver:
1. **thread_count**: Represents the number of concurrent requests that the driver can handle, corresponding to the number of active threads running simultaneously within the driver.
2. **time_compression_ratio**: Controls the intensity of the driver's workload. A lower value yields a higher workload in a shorter timeframe.
3. **ignore_scheduled_start_times**: Determines whether the driver should follow the scheduled timings for sending requests. If set to true, the driver sends requests as soon as they are prepared, regardless of the schedule.
4. **warmup**: Denotes the number of preliminary test items processed before the actual benchmarking begins.
5. **operation_count**: Sets the number of test items executed during the actual benchmarking phase after the warm-up.
```shell
mode=EXECUTE_BENCHMARK
thread_count=1
time_compression_ratio=0.001
ignore_scheduled_start_times=false
warmup=5
operation_count=10000
```
## 2. Quick Start
To get started, clone the repository and build it with Maven:
```bash
git clone https://github.com/ldbc/ldbc_finbench_driver.git
cd ldbc_finbench_driver
mvn clean package -DskipTests
```
For a quick trial of the driver, utilize the DummyDB shipped with it by running the following command:
```bash
java -cp target/driver-0.2.0-alpha.jar org.ldbcouncil.finbench.driver.driver.Driver -P src/main/resources/example/ldbc_finbench_driver_dummy.properties
```
## 3. Reference
- FinBench Specification: https://github.com/ldbc/ldbc_finbench_docs
- FinBench DataGen: https://github.com/ldbc/ldbc_finbench_datagen
- FinBench Driver: https://github.com/ldbc/ldbc_finbench_driver
- FinBench Transaction Reference Implementation: https://github.com/ldbc/ldbc_finbench_transaction_impls
Please visit these links for further documentation and related resources.