Skip to main content

Database migration system for Python/SQLAlchemy projects

Project description

DBWarden

A database migration system for Python/SQLAlchemy projects.

Documentation Ask DeepWiki

Installation

pip install dbwarden

Configuration

⚠️ Warning

This is an experimental package. Your fuckups are not mine to fix. You have been warned.

Even though this is an experimental package, I added lots of failsafes to protect the connected DB as to avoid issues.

Create warden.toml in your project:

# Default database
default = "primary"

# Database configurations
[database.primary]
database_type = "sqlite"
sqlalchemy_url = "sqlite:///./development.db"

[database.analytics]
database_type = "postgresql"
sqlalchemy_url = "postgresql://user:password@localhost:5432/analytics"

Basic Commands

Command Description
dbwarden init Initialize migrations directory
dbwarden database list List all configured databases
dbwarden database add <name> Add a new database
dbwarden make-migrations "name" Generate SQL from SQLAlchemy models
dbwarden migrate Apply pending migrations
dbwarden migrate -d <name> Migrate specific database
dbwarden migrate --all Migrate all databases
dbwarden rollback Revert the last migration
dbwarden history Show migration history
dbwarden status Show current status

Multi-Database Support

Manage multiple databases from a single configuration:

# Add databases
dbwarden database add analytics --url "postgresql://user:pass@localhost:5432/analytics"
dbwarden database add legacy --url "mysql://user:pass@localhost:3306/legacy"

# List all databases
dbwarden database list

# Migrate specific database
dbwarden migrate -d analytics

# Migrate all databases (sequentially)
dbwarden migrate --all

SQLAlchemy Models

DBWarden automatically detects models in models/:

# models/user.py
from sqlalchemy import Column, Integer, String
from sqlalchemy.orm import declarative_base

Base = declarative_base()

class User(Base):
    __tablename__ = "users"
    id = Column(Integer, primary_key=True)
    name = Column(String(100))
    email = Column(String(255), unique=True)

Complete Example

# 1. Initialize
dbwarden init

# 2. Create models in models/

# 3. Add more databases
dbwarden database add analytics --url "postgresql://user:pass@localhost:5432/analytics"

# 4. Generate migration from models
dbwarden make-migrations "create users table"

# 5. Apply
dbwarden migrate --verbose

# 6. Migrate all databases
dbwarden migrate --all

# 7. View history
dbwarden history

Supported Databases

Database Type Value Features
PostgreSQL postgresql SERIAL, TIMESTAMP, BYTEA
MySQL mysql AUTO_INCREMENT, ENUM
SQLite sqlite Built-in, zero config
ClickHouse clickhouse Analytics, MergeTree
MariaDB mariadb MySQL-compatible

Docs

For more information, see DBWarden Docs or DBWarden DeepWiki page

License

This Project is Licensed under the MIT License. See LICENSE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dbwarden-0.3.3.tar.gz (453.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dbwarden-0.3.3-py3-none-any.whl (45.9 kB view details)

Uploaded Python 3

File details

Details for the file dbwarden-0.3.3.tar.gz.

File metadata

  • Download URL: dbwarden-0.3.3.tar.gz
  • Upload date:
  • Size: 453.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for dbwarden-0.3.3.tar.gz
Algorithm Hash digest
SHA256 ac5d91523949c6c904f63d1a48f7b6f03b3774db8d7b2d84830f3524e460226c
MD5 98335aa1123c593dd191975b1f7033bb
BLAKE2b-256 3749de6041a446fc8594d854c50effd9ea8004cbe1a5b6cd7f38c1187c80c31f

See more details on using hashes here.

File details

Details for the file dbwarden-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: dbwarden-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 45.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for dbwarden-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9989de61ae315f46b602f96485286a269bed2909c6721277c374e0a939e18e72
MD5 b0f7ee205c812f75d46f255cbfafc6f5
BLAKE2b-256 bcdbb10e91f8d1dd7cb2c8e2f593b0ca27cc041da34966a937cdb981f1a8e323

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page