Benchmark guide (#50)

Author: mwiewior

.gitignore

@@ -20,3 +20,4 @@ sandbox/*.csv
 sandbox/*.parquet/
 .history
 bin/
+sandbox/bugfixing.md

README.md

@@ -24,4 +24,15 @@ echo -1 | sudo tee /proc/sys/kernel/perf_event_paranoid
 
 cargo build --release
 flamegraph -- target/release/sequila-cli -f queries/q1-coitrees.sql
+```
+
+## How to run benchmark locally:
+1. Download and unpack test [dataset](https://drive.google.com/file/d/1lctmude31mSAh9fWjI60K1bDrbeDPGfm/view?usp=sharing).
+2. Export env variable with path to the root folder with benchmark data, e.g.:
+```bash
+export BENCH_DATA_ROOT=/Users/mwiewior/research/databio/ 
+```
+3. Run benchmark
+```bash
+RUSTFLAGS="-Ctarget-cpu=native" cargo bench --bench databio_benchmark -- --quick
 ```