https://github.com/maxime-cllt/dbmscleaner
A Rust executable program that clean and optimise your DBMS, made to be run everyday as a back-end program.
https://github.com/maxime-cllt/dbmscleaner
cleaner dbms executable go golang mariadb mysql optimization postgresql
Last synced: about 2 months ago
JSON representation
A Rust executable program that clean and optimise your DBMS, made to be run everyday as a back-end program.
- Host: GitHub
- URL: https://github.com/maxime-cllt/dbmscleaner
- Owner: Maxime-Cllt
- Created: 2024-09-20T11:32:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-28T16:09:24.000Z (about 1 year ago)
- Last Synced: 2025-03-28T17:33:20.339Z (about 1 year ago)
- Topics: cleaner, dbms, executable, go, golang, mariadb, mysql, optimization, postgresql
- Language: Rust
- Homepage:
- Size: 81.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🗄️ DBMSCleaner
High-performance database optimization tool built with Rust
**Supported Databases**
**Platform Support**
## 📖 Overview
**DBMS Cleaner** is a lightweight, efficient tool designed to optimize and clean your database. Built with Rust, it
ensures optimal performance by reducing storage usage and optimizing all tables (except system tables) without altering
configurations or requiring manual intervention.
Whether you're running a server or an application, DBMS Cleaner keeps your database in peak condition, compatible across
all major platforms.
---
## ✨ Key Features
- 🚀 **Efficient Storage Optimization:** Reduce database size by rebuilding indexes.
- ⚙️ **Table Optimization:** Ensures all tables (excluding system tables) are optimized.
- 🖥️ **Cross-Platform Support:** Seamlessly run on Windows, MacOS, and Linux.
- 🛠️ **Simple Integration:** No changes to FILE configurations required.
- 🛡️ **Safe and Reliable:** Maintains database integrity without the need for backups.
- 🔧 **Customizable:** Easily configure settings via `config.json`.
- ⏱️ **Fast Execution:** Run it as a cron job or scheduled task for continuous optimization.
---
## 📋 Prerequisites
- **Rust Compiler** (Install via [Rustup](https://rustup.rs/))
- **Cargo Package Manager** (Installed with Rust)
- Supported database drivers: `mysql`, `mariadb`, or `postgres`
---
## 🔧 Installation
Follow these steps to get started:
### 1. Clone the Repository
```bash
git clone https://github.com/Maxime-Cllt/DBMSCleaner.git
cd DBMSCleaner
```
### 2. Compile the Program
```bash
cargo build --release
```
### 3. Configure the Connection
Create a file named `cleaner.json` in the same directory as the compiled program. DBMSCleaner supports multiple
databases in a single configuration file:
**Multi-Database Configuration (Recommended):**
```json
{
"databases": [
{
"name": "Production PostgreSQL",
"driver": "postgres",
"host": "localhost",
"port": "5432",
"username": "postgres",
"password_env": "POSTGRES_PASSWORD",
"schema": "public"
},
{
"name": "Analytics MySQL",
"driver": "mysql",
"host": "localhost",
"port": "3306",
"username": "root",
"password_env": "MYSQL_PASSWORD",
"schema": "analytics"
}
],
"dry_run": false,
"require_confirmation": true
}
```
**Security Features:**
- 🔐 Use `password_env` to reference environment variables instead of hardcoding passwords
- ⚠️ `require_confirmation` asks for approval before running (set to `false` for automation)
- 🔍 `dry_run` mode previews operations without executing them
**Multiple Schemas:**
You can include multiple schemas separated by commas or use `*` to clean all schemas (except system schemas):
```json
"schema": "test1,test2,test3"
```
For detailed configuration options, see [README_CONFIG.md](README_CONFIG.md)
### 4. Run the Program
**Set environment variables (if using `password_env`):**
```bash
# Linux/macOS
export POSTGRES_PASSWORD="your_secure_password"
export MYSQL_PASSWORD="your_mysql_password"
# Windows (PowerShell)
$env:POSTGRES_PASSWORD="your_secure_password"
$env:MYSQL_PASSWORD="your_mysql_password"
```
**Execute the cleaner:**
#### For MacOS & Linux:
```bash
./target/release/DBMSCleaner
```
#### For Windows:
```bash
.\target\release\DBMSCleaner.exe
```
---
## 🧪 Code Quality
### Unit Tests available
To ensure the reliability of the DBMS Cleaner, unit tests are included. You can run the tests using Cargo:
```bash
cargo test
```
## 📝 Notes
- **Exclusions:** Does not clean triggers, stored procedures, functions, or views.
- **Privileges Required:** Ensure the program has sufficient privileges to connect and clean the database.
- **Frequency:** Safe to run frequently for continuous optimization.
---
## 📊 Performance and Results
I use this program to clean my database every night. Here is a graph that show the size of my database before and after
the cleaning process.
### Size benefit
## 🔗 See Also
- [SQLiteCleaner](https://github.com/Maxime-Cllt/SqliteCleaner)
- [Rust Language](https://www.rust-lang.org/)
---
### 📜 License
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
## 🤝 Contributing
Contributions are welcome! To contribute:
- **Fork the Repository**
- **Create a Feature Branch**:
```bash
git checkout -b feature/your-feature-name
```