Skip to content

README updates #599

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

README updates #599

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2742dfd
README updates
bpkroth Feb 13, 2025
b3a3bdd
Merge branch 'main' into readme-updates
bpkroth Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,19 @@ BenchBase (formerly [OLTPBench](https://github.com/oltpbenchmark/oltpbench/)) is

## Quickstart

### With Docker

To pull and use the BenchBase Docker image for `postgres`:

```bash
docker pull benchbase.azurecr.io/benchbase-postgres:latest
docker run -it --rm benchbase.azurecr.io/benchbase-postgres:latest -b tpcc -c config/postgres/sample_tpcc_config.xml --create=true --load=true --execute=true
```

> See below for additional details on using Docker and customizing the config and retrieving the results.

### With Java

To clone and build BenchBase using the `postgres` profile,

```bash
Expand Down Expand Up @@ -243,7 +256,7 @@ The original OLTPBench code was largely written by the authors of the original p

A significant portion of the modernization was contributed by [Tim Veil @ Cockroach Labs](https://github.com/timveil-cockroach), including but not limited to:

* Built with and for Java ~~17~~ 21.
* Built with and for Java 17.
* Migration from Ant to Maven.
* Reorganized project to fit Maven structure.
* Removed static `lib` directory and dependencies.
Expand All @@ -269,6 +282,16 @@ A significant portion of the modernization was contributed by [Tim Veil @ Cockro
* Simplified output flags by removing most of them, generally leaving the reporting functionality enabled by default.
* Provided an alternate `Catalog` that can be populated directly from the configured Benchmark database. The old catalog was proxied through `HSQLDB` -- this remains an option for DBMSes that may have incomplete catalog support.

Some additional maintenance has been taken up by [Brian Kroth](https://github.com/bpkroth) and others at [Microsoft's Gray Systems Lab](https://aka.ms/gsl):

* Docker support.
* Java ~~21~~ 23 support.
* Flexible templated benchmarking
* Advanced metrics collection
* Session startup scripts
* Expanded DBMS support
* Code maintenance and bug fixes.

## Citing This Repository

If you use this repository in an academic paper, please cite this repository:
Expand Down
Loading