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.1.tar.gz (449.9 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.1-py3-none-any.whl (45.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dbwarden-0.3.1.tar.gz
Algorithm Hash digest
SHA256 8bc03744b8bb9435516268c5c97af0cd5cdd5678a24ff3915d528d4be98458a9
MD5 732f27682a0bb7ab0f0c4f457e60a6f2
BLAKE2b-256 1aa37fb230396e152f2c19ac4d0e783863d0ab2aa3af9af9b0c3908b579b5e5b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for dbwarden-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2a2271b976bb1347c02be371f2a2c5db9f74fb96a57b3a6c705a5d170f599384
MD5 3e1f2e10672da329fd6354a7cb2c8f37
BLAKE2b-256 23fc54561a5c1d8837cb3874a8391bd7607c73a7fc6d701c0e562e1379e280ef

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