https://github.com/w-kuipers/alphadb
AlphaDB is a versatile tool for managing MySQL database versions, using JSON to define structures and simplify migrations across environments.
https://github.com/w-kuipers/alphadb
database database-management database-management-system migration-tool mysql mysql-versions sql version-control version-control-system
Last synced: 4 months ago
JSON representation
AlphaDB is a versatile tool for managing MySQL database versions, using JSON to define structures and simplify migrations across environments.
- Host: GitHub
- URL: https://github.com/w-kuipers/alphadb
- Owner: w-kuipers
- License: gpl-3.0
- Created: 2023-10-29T16:01:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-23T17:50:43.000Z (5 months ago)
- Last Synced: 2025-09-24T23:32:48.492Z (5 months ago)
- Topics: database, database-management, database-management-system, migration-tool, mysql, mysql-versions, sql, version-control, version-control-system
- Language: Rust
- Homepage: https://alphadb.w-kuipers.com/
- Size: 1.34 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/w-kuipers/alphadb/releases)
[](https://crates.io/crates/alphadb)
[](https://pypi.org/project/alphadb/)
[](https://www.npmjs.com/package/@w-kuipers/alphadb)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://github.com/w-kuipers/alphadb)
[](https://github.com/w-kuipers/alphadb/actions/workflows/run-tests.yml)
# AlphaDB
AlphaDB is a powerful and flexible tool for managing MySQL database versions. It allows you to define the structure of your database in a JSON format and simplifies the process of applying and managing migrations across multiple databases. With AlphaDB, you can ensure consistency and control in your database schema evolution, whether you’re working in development, staging, or production environments.
---
## Beta
AlphaDB is currently in `beta` stage. Breaking changes should be expected.
---
## Key Features
- **JSON-Based Database Schema**: Define your database structure in a clear, human-readable JSON format.
- **Easy Migration Management**: Apply, track, and roll back migrations seamlessly across multiple databases.
- **Version Control for Your Database**: Keep your database schema in sync with your application code.
- **Lightweight and Developer-Friendly**: Designed to integrate smoothly into your development workflow.
## Documentation
Visit the [official documentation](https://alphadb.w-kuipers.com/)
## Installation
### Install using `Cargo`
cargo install alphadb-cli
## Usage
Connect to a database
```bash
alphadb connect
```
You will be asked to provide the database credentials. After connecting the connection will be saved for later use.
Make sure the database is empty, back it up if necessary. If the database is not empty, you can use the `vacate` method.
Note that this function will erase ALL data in the database and this action is irriversible.
```bash
alphadb vacate
```
The database is now ready to be initialized. The `init` command will create the `adb_conf` table. This holds configuration data for the database.
```bash
alphadb init
```
Now we update the database. For this we need to give it a structure. Read more about [version sources](https://alphadb.w-kuipers.com/version-source).
```json
{
"name": "mydb",
"version": [
{
"_id": "0.1.0",
"createtable": {
"customers": {
"primary_key": "id",
"name": {
"type": "VARCHAR",
"length": 100
},
"id": {
"type": "INT",
"a_i": true
}
}
}
},
{
"_id": "1.0.0",
"createtable": {
"orders": {
"primary_key": "id",
"id": {
"type": "INT",
"a_i": true
},
"date": {
"type": "DATETIME"
},
"note": {
"type": "TEXT",
"null": true
}
}
}
}
]
}
```
Then run the update command.
```bash
alphadb update
```
You will be asked to select a version source. This can be a path to a JSON file or a URL returning JSON data.
## License
[GPL-3.0 LICENSE](https://github.com/w-kuipers/alphadb/blob/main/LICENSE)