Skip to content

Development Adding a Database

Nate edited this page Oct 9, 2019 · 1 revision

You can think of each database folder as a "plugin". The steps to add a new database to TFB should look something like this, using redis as an example:

The name of the folder, the dockerfile, and the python file with the Database class should all be the name of the database. Framework tests can now use the new database in the "database" field in their benchmark_config.json. In this example, "database": "redis".

When submitting a new database, please keep the following in mind:

  • The database should be actively maintained.
  • The database should be production ready. (Unlike framework tests, please do not submit pet projects or multiple variations of the same database.)
  • The database should have licencing that allows use in benchmarking projects such as ours.
  • The database's API should allow test maintainers to implement all current database tests.

Clone this wiki locally