https://github.com/firebolt-db/benchmarks
https://github.com/firebolt-db/benchmarks
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/firebolt-db/benchmarks
- Owner: firebolt-db
- License: mit
- Created: 2024-11-25T15:45:38.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-04-29T02:03:02.000Z (about 1 month ago)
- Last Synced: 2025-04-29T21:18:17.671Z (about 1 month ago)
- Language: Python
- Size: 3.52 MB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Firebolt Benchmarks
In this repo, you’ll find the FireScale benchmark, as well as the benchmarking clients
and benchmark results that Firebolt has published. This includes the DDL and queries
for setting up and running FireScale on different vendors, as well as the results for
how various vendors performed on FireScale.
## FireScale Benchmark Results
[To view benchmark results, click here.](results/)
## Run FireScale Yourself
Firebolt has provided two clients in this repo: one written in Python, and one written
with Node.js with Grafana K6. The Python client is for power runs (executing one query
at a time in a sequential pattern) and for concurrency benchmarking with low expected
query throughput (<100 QPS). The K6 client is for benchmarking concurrent scenarios
with high query volumes and hundreds or thousands of queries being completed each second.
The Python client can be extended with benchmarks beyond just FireScale, though at this
time, only FireScale and TPCH queries are provided.
View each client:
* [Python client](/clients/python/)
* [K6 client](/clients/k6/)
### Credentials
To connect to each data warehouse vendor, you need to provide a single credentials file located
at `config/credentials/credentials.json`. The expected format for this file is as follows:
```json
{
"snowflake": {
"account": "your_account",
"user": "your_username",
"password": "your_password",
"database": "your_database",
"schema": "your_schema",
"warehouse": "your_warehouse"
},
"redshift": {
"host": "your_cluster.region.redshift.amazonaws.com",
"port": 5439,
"database": "your_database",
"user": "your_user",
"password": "your_password"
},
"firebolt": {
"account_name": "your firebolt account name",
"database": "your_database",
"engine_name": "your_engine",
"auth": {
"id": "your firebolt service account id",
"secret": "your firebolt service account secret"
}
},
"bigquery": {
"project_id": "your_project_id",
"dataset": "your_dataset",
"key": "your json key generated from google cloud"
}
}
```
Create your `credentials.json` file, paste this template in, and then fill in the
appropriate credentials for the vendors you wish to connect with. Please note that
if you have a different means of authenticating with these vendors, you may also
need to modify how the benchmarking clients handle authentication.
### Ingest Data
In order to load the data into each system, you will need to run the `setup.sql` scripts
present in the `/benchmarks` folder. You can do this manually in each vendor, or for ease,
the Python client can do this programmatically at the start of a benchmark run. For example,
to load data into Firebolt, configure your credentials, run:
```bash
/clients/python$ pip install -r requirements.txt
```
If you have other Python-based projects, it's recommended to do this with
[venv](https://docs.python.org/3/library/venv.html) or [uv](https://github.com/astral-sh/uv).
Then run:
```bash
/clients/python$ python -m src.main FireScale --vendors firebolt --execute-setup True
```
This will ingest the data and then kick off an initial benchmark power run.
## Directory Structure
```
project-root/
│
├── benchmarks/ # Contains benchmark definitions
│ ├── sample_benchmark/
│ │ ├── benchmark.sql # General benchmark SQL file for sample_benchmark
│ │ ├── setup.sql # General setup SQL file for sample_benchmark
│ │ └── firebolt/
│ │ └── setup.sql # firebolt specific setup SQL file
│ │
│ ├── FireScale/
│ │ ├── firebolt/
│ │ │ ├── benchmark.sql # firebolt specific benchmark SQL file
│ │ │ ├── setup.sql # firebolt specific setup SQL file
│ │ | ├── warmup.sql # firebolt specific warmup SQL file
│ │ | └── queries.json # queries for concurrent benchmarking w/Python
│ │ │
│ │ ├── snowflake/
│ │ | ├── benchmark.sql # snowflake specific benchmark SQL file
│ │ | ├── setup.sql # snowflake specific setup SQL file
│ │ | ├── warmup.sql # snowflake specific warmup SQL file
│ │ | └── queries.json # queries for concurrent benchmarking w/Python
│ │ │
│ │ ├── bigquery/
│ │ | ├── benchmark.sql # bigquery specific benchmark SQL file
│ │ | └── setup.sql # bigquery specific setup SQL file
│ │ │
│ │ ├── redshift/
│ │ | ├── benchmark.sql # redshift specific benchmark SQL file
│ │ | ├── setup.sql # redshift specific setup SQL file
│ │ | ├── warmup.sql # redshift specific warmup SQL file
│ │ | └── queries.json # queries for concurrent benchmarking w/Python
| | |
│ | └── warmup.sql # generic SQL warmup file for FireScale
| |
| ├── FireScale_k6/ # query files for K6 concurrent benchmarking for each vendor
| | ├── queries_firebolt.js
| | ├── queries_redshift.js
| | └── queries_snowflake.js
| |
| └── tpch/
| ├── firebolt/
| | └── benchmark.sql # TPCH queries for Firebolt
| └── warmup.sql # generic SQL warmup file for TPCH benchmark
|
├── clients/
│ ├── python/
| | ├── src/
| | │ ├── connectors/ # Contains connector implementations
| | │ │ ├── base.py
| | │ │ ├── firebolt.py
| | │ │ ├── bigquery.py
| | │ │ ├── redshift.py
| | │ │ └── snowflake.py
| | | ├── exporters/ # Contains exporter implementations
| | │ │ ├── base.py
| | │ │ ├── csv_exporter.py
| | │ │ └── visual_exporter.py
| | │ ├── main.py # Entry point for the Python client tool
| | │ └── runner.py # Python benchmark runner logic
| | ├── README.md # Python client documentation
| | └── requirements.txt # Python package dependencies
| |
│ └── k6/
| ├── connections-cluster.js # entrypoint for K6 benchmarking
| ├── connections-server.js # connections to vendors for K6
| ├── fb-benchmark-k6.js # K6 benchmark runner
| ├── package-lock.json
| ├── package.json
| └── README.md # K6 client documentation
|
├── config/ # Contains configuration files for the application
│ ├── credentials/ # Contains credential files
│ │ ├── credentials.json # Single credentials file for all vendors (ignored)
│ │ └── sample_credentials.json # Sample credentials file with dummy data
│ ├── k6config.json # k6 configuration options
│ └── settings.py # python client settings (not recommneded to change)
|
├── results/ # benchmark results for various benchmarks and vendors
| └── ...
|
├── requirements.txt # Python package dependencies
├── LICENSE # MIT License
└── README.md # Project documentation
```
## Contributing
Contributions are welcome! Please follow these steps to contribute:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes and commit them (`git commit -m 'Add new feature'`).
4. Push to the branch (`git push origin feature-branch`).
5. Create a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.