README.md
1# JMH Benchmarks for RocksJava
2
3These are micro-benchmarks for RocksJava functionality, using [JMH (Java Microbenchmark Harness)](https://openjdk.java.net/projects/code-tools/jmh/).
4
5## Compiling
6
7**Note**: This uses a specific build of RocksDB that is set in the `<version>` element of the `dependencies` section of the `pom.xml` file. If you are testing local changes you should build and install a SNAPSHOT version of rocksdbjni, and update the `pom.xml` of rocksdbjni-jmh file to test with this.
8
9```bash
10$ mvn package
11```
12
13## Running
14```bash
15$ java -jar target/rocksdbjni-jmh-1.0-SNAPSHOT-benchmarks.jar
16```
17
18NOTE: you can append `-help` to the command above to see all of the JMH runtime options.
19