Skip to content

Commit f0ed769

Browse files
committed
Add section on benchmarking
This closes #9 Signed-off-by: Sayan Nandan <[email protected]>
1 parent 7d38f2b commit f0ed769

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/benchmarking.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Benchmarking
2+
3+
Who doesn't like speed and as a consequence, benchmarks? So here's a guide on benchmarking TerrabaseDB with our tool `tdb-bench` .
4+
5+
## Step 0: Getting the benchmarking tool
6+
7+
The benchmark tool ( `tdb-bench` ) has been shipped as a part of the TerrabaseDB bundle ever since 0.3.2. So, you'll need to download a bundle from the [releases page](https://github.com/terrabasedb/terrabasedb/releases) and unzip it. In the following steps we'll assume that you have unzipped the archive and you're in that directory.
8+
9+
## Step 1: Starting the database server
10+
11+
Open a terminal in the current directory and [set executable permissions](/Getting-Started/#step-2-make-the-files-runnable). Now start the server by running `./tdb` (or just `tdb` on Windows).
12+
13+
## Step 2: Run the benchmark tool
14+
15+
Open another terminal in the current directory and then run `tdb-bench` with no arguments if you want to use the default options, or run `tdb-bench --help` to see available configuration options. Hold tight, you'll know when it happens 🚀.
16+
17+
### Bonus: JSON Output
18+
19+
If you're a bit nerdy, we know it — you'll like some structured data. Well, all you need to do is: run `tdb-bench --json` for JSON output!

0 commit comments

Comments
 (0)