db-stress-bench - GitLite

KO | EN

gitlite — search

#agents #rag #dotnet #cloud-native #graphql #command-line #database #editor #tensorflow #shell

db-stress-bench

(★ 13)

Simple, easily customizable and powerful database load testing tool. Provides real-time in-browser aggregate stats. Supports MySQL, Postgres, SQLite, DuckDB and CassandraDB. Adding support for a new database requires a simple 3-method interface implementation.

File Explorer

ZIP Download

- screenshot.png
- data_duckdb_customers.csv
- data_duckdb_customers_3_cols.csv
- data_duckdb_order_counts.csv
- data_sqlite_name_age.csv
- duckdb_ecommerce.db
- sqlite_name_age.db
.gitignore
config.yaml
LICENSE
pom.xml
README.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

`git clone`

View Details ▼

Clone an existing repository.

git clone {{remote_repository_location}} {{path/to/directory}}

Clone an existing repository into a new directory (the default directory is the repository name):

git clone --recursive {{remote_repository_location}}

Clone an existing repository and its submodules:

git clone {{[-n|--no-checkout]}} {{remote_repository_location}}

Clone only the `.git` directory of an existing repository:

🔍

`java`

View Details ▼

Java application launcher.

java {{classname}}

Execute a Java `.class` file that contains a main method by using just the class name:

java -classpath {{path/to/classes1}}:{{path/to/classes2}}:. {{classname}}

Execute a Java program and use additional third-party or user-defined classes:

java -jar {{filename.jar}}

Execute a `.jar` program:

🔍

`mvn`

View Details ▼

Apache Maven: build and manage Java-based projects.

mvn compile

Compile a project:

mvn package

Compile and package the compiled code in its distributable format, such as a `jar`:

mvn package {{[-D|--define]}} skipTests

Compile and package, skipping unit tests:

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

🚀 **Load Testing Made Simple for Databases**

🔥 **db-stress-bench** is a simple but powerful tool to **load test any database** with minimal configuration 🛠️

[![Open Source Helpers](https://www.codetriage.com/freakynit/db-stress-bench/badges/users.svg)](https://www.codetriage.com/freakynit/db-stress-bench)

---

![images/screenshot.png](https://raw.githubusercontent.com/freakynit/db-stress-bench/main/images/screenshot.png)
> Only 3 of 11 available realtime graphs are shown in this image.

## ✨ **Key Features**
### 1. **📊 Live Running Stats**
- Monitor real-time aggregate statistics directly in your browser.
- Available *live* in-browser aggregate stat graphs: 
  - Queries Per Second
  - Average Query Time (ms)
  - Query StdDev (ms)
  - Min Query Time (ms)
  - Max Query Time (ms)
  - Median Query Time (ms)
  - Successfully Completed Queries
  - Failed Queries
  - Invalid Input Payloads
  - Total Queries
  - Percentiles: 20th, 50th, 75th, 90th, 95th, 99th
- Support for these same metrics at prometheus compatible metrics endpoint at `/metrics`.

### 2. **🖋️ Query Templates**
- Configure **multiple queries** to stress-test your database.
- Use **per-query csv file** to repace query template variables from the CSV dynamically at runtime, allowing you to thoroughly stress your database bypassing caching effects.
- Sample query: `select * from Customers where customer_name = '${customer_name}'`

### 3. **⚡ High Concurrency Support**
- Harness the power of **Java Virtual Threads** to run thousands of concurrent queries effortlessly (Even works/compiles on java-8+ if not using virtual threads (`useVirtualThreads: false`)).
- Gradually **ramp up concurrency** with configurable options for smooth stress testing.

### 4. **🗂️ Extensive Database Support**
- Out-of-the-box support for:
    - **MySQL** 🐬
    - **PostgreSQL** 🐘
    - **SQLite** 📦
    - **DuckDB** 🦆
    - **CassandraDB** 🟣

### 5. **🧩 Easy Extensibility**
Add support for new databases by implementing a **simple 3-method interface**.

### 6. **📄 Logging**
Log **raw query results** to files for detailed analysis.

### 7. **🛠️ Ready-to-Run Samples**
You can start playing around immediately. This project already has:
- Sample **test queries**
- Sample **template data**
- Pre-configured **test databases** (SQLite and DuckDB)

Run with a **single command**:

```bash
java -jar target/db-stress-bench-1.0.1.jar
```

No setup or configuration required! 🎉

Above one runs load tests against the provided duckdb database. To load test the provided sample **SQLite test database**, just update `activeDatabase` value to `com.freakynit.sql.db.stress.bench.db.sqlite.SqliteDatabaseInterface` and run again.

---

## 🚀 **Getting Started**
1. Clone this repository:
   ```bash
   git clone https://github.com/freakynit/db-stress-bench.git
   ```
2. Build the project:
   ```bash
   mvn clean package
   ```
3. Run with sample data:
   ```bash
   java -jar target/db-stress-bench-1.0.1.jar
   ```
4. Open your browser at **http://localhost:8080** to monitor live stats.
5. Check out `config.yaml` for all customizations.
6. Works/compiles on java-8+ (java-21+ if `useVirtualThreads` is true).

---

## 🌐 **Supported Databases**
| Database    | Status     |  
|-------------|------------|  
| MySQL       | ✅ Supported |  
| PostgreSQL  | ✅ Supported |  
| SQLite      | ✅ Supported |  
| DuckDB      | ✅ Supported |
| CassandraDB | ✅ Supported |

**Adding a new database?** Implement these 3 methods in the `DatabaseInterface` and you’re good to go! 🚀

---

## 📥 **Contributing**
We welcome contributions! 🤝
- **Report bugs** 🐛
- **Suggest features** ✨
- **Submit pull requests** 🚀

---

## 📜 **License**
This project is licensed under the [MIT License](LICENSE).

---

### 🌟 Star this repo if you find it useful! ⭐