diff --git a/README.md b/README.md index 717141f..808dcaa 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,28 @@ # TPCH-sqlite -SQLite TPCH database + +This small shell script that generates an sqlite3 database following the [TPC-H standard](http://www.tpc.org/tpch/). +It uses the official [tpch-dbgen](https://github.com/electrum/tpch-dbgen) tool to generate the data, and then imports it into an sqlite database. + +## Download the database + +If you don’t want to generate the database yourself, you can download it from the **realeases** section of this github repo. + +## How to use + +Clone this repository and its submodule. Then just run `make` from the root directory of this repo. Be sure to have `sqlite3` and a C compiler installed. + +``` +git clone --recursive git@github.com:lovasoa/TPCH-sqlite.git +cd TPCH-sqlite +make +``` + +This generates an SQLite3 database under the name `TPC-H.db`. + +### How to set a custom scale factor + +By default, the database is generated with a scale factor of 1. You can set a different *scale factor* (**SF**) with + +``` +SCALE_FACTOR=10 make +```