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:

sqlalchemy_url = "sqlite:///./development.db"

Basic Commands

Command Description
dbwarden init Initialize migrations directory
dbwarden make-migrations "name" Generate SQL from SQLAlchemy models
dbwarden migrate Apply pending migrations
dbwarden migrate --verbose Apply with detailed logging
dbwarden rollback Revert the last migration
dbwarden history Show migration history
dbwarden status Show current status
dbwarden config Show current configuration
dbwarden check-db Inspect DB schema
dbwarden diff Show models vs DB differences

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. Generate migration from models
dbwarden make-migrations "create users table"

# 4. Apply
dbwarden migrate --verbose

# 5. View history
dbwarden history

# 6. Check configuration
dbwarden config

Supported Databases

  • PostgreSQL
  • SQLite
  • MySQL

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.1.5.tar.gz (101.6 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.1.5-py3-none-any.whl (37.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dbwarden-0.1.5.tar.gz
Algorithm Hash digest
SHA256 1a09802b75fd5a9a3b070435bd9f7fde6b81a9c75acd6070407f024443a1a731
MD5 319ad2f09027ce2319b8ca015f36e6f5
BLAKE2b-256 7ce366fa4d3b20474d22f41fecc53418f478fce87d540dfb574865803f43deb3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dbwarden-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 37.3 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.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d688d4fc3491ea166f048a25dc1018ccd5437ed7dc918d76ae7ae320a8dae9fc
MD5 b07e8e78d2008db2ee02b04e0ead8ef3
BLAKE2b-256 472ca865b7308db3a4eaf48c0749197e1ebf4fd7eabf1e0cd095724a492a98bc

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