An open API service indexing awesome lists of open source software.

https://github.com/maxime-cllt/sqlitecleaner

A simple program that clean and optimize your SQLite file
https://github.com/maxime-cllt/sqlitecleaner

cargo cicd cleaner github-actions optimizer rust sqlite

Last synced: about 2 months ago
JSON representation

A simple program that clean and optimize your SQLite file

Awesome Lists containing this project

README

          


SQLiteCleaner



Rust
Database Cleaner
Version

## ๐Ÿ“œ Description

SQLiteCleaner is a program designed to clean your SQLite database efficiently. It reduces database storage and
optimizes all tables (except system tables). Built with Rust, it is compatible with all platforms, ensuring smooth
operation across servers and applications. Download the program from the releases section and keep your database in top
shape!

## โœจ Features

- ๐Ÿ—ƒ๏ธ Reduce database storage but don't delete any data.
- ๐Ÿš€ Optimize all tables except system tables.
- ๐Ÿ’ก Simple and efficient way to clean SQLite databases.
- ๐ŸŒ Cross-platform compatibility.
- โš™๏ธ Maintain databases in optimal condition.
- โŒ No need for dumps or backups.
- ๐Ÿ”’ Does not modify your configuration files.
- ๐Ÿ–ฅ๏ธ Easily run on any server or application.
- ๐Ÿ› ๏ธ User-friendly and easy to use.

## ๐Ÿ’ป Platform Support



macOS


Linux


Windows

## ๐Ÿ–ผ๏ธ Example of Execution


Example

## ๐Ÿ“ฅ Installation

To run the program:

1. Clone the repository:

```bash
git clone https://github.com/Maxime-Cllt/SQLiteCleaner.git
```

2. Build the program:

```bash
cargo build --release
```

3. Execute the program:

You may need to give the program execute permissions on Linux and macOS:

```bash
chmod +x target/release/SQLiteCleaner
```

### MacOS & Linux

```bash
./target/release/SQLiteCleaner "path/to/your_database.db"
```

### Windows

```bash
.\target\release\SQLiteCleaner.exe "path/to/your_database.db"
```

### Cargo

You can also run the program using Cargo:

```bash
cargo run --release -- "path/to/your_database.db"
```

## ๐Ÿงช Code Quality

### Unit Tests available

To run unit tests, use the following command:

```bash
cargo test
```

## ๐Ÿ“ Notes

- โฑ๏ธ Fast execution.
- โš ๏ธ Does not clean triggers, stored procedures, functions, and views.
- ๐Ÿ“‰ May not reduce storage significantly but is quick to run and can be executed frequently.

## ๐Ÿ”— See Also

- ๐ŸŒ [DBMSCleaner](https://github.com/Maxime-Cllt/DBMSCleaner)