Skip to content

KeenMate/debee

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Debee — Database Migration and Management Tools

A collection of database migration orchestration tools. Debee coordinates PostgreSQL operations — migrations, backups, testing, and documentation — without embedding any SQL itself. Your database logic stays in SQL files where it belongs.

Database Support

PostgreSQL

Complete toolset with three cross-platform orchestrator implementations (PowerShell, Bash, Python).

See the PostgreSQL README for features, quick start, and architecture overview.

Documentation

Topic Description
Configuration Environment files, variables reference, local overrides
Operations All operations explained, migration naming, ad-hoc scripts
Testing Test runner, suites, isolation modes, shared setup
Version Table Database object tracking, output formats, HTML dashboard
Cross-Platform CLI reference for ps1/sh/py, platform guidance
Changelog Version history and migration notes

Quick Usage

# PowerShell
.\debee.ps1 -Operations fullService

# Bash
./debee.sh -o fullService

# Python
python debee.py -o fullService

HTML Dashboard

vivaldi_KLUI6zddbB

Interactive dashboard for exploring database objects across migrations. See Version Table docs.

Project Structure

debee/
├── README.md                              # This file
└── postgresql/                            # PostgreSQL tools
    ├── README.md                          # PostgreSQL overview & quick start
    ├── CHANGELOG.md                       # Version history
    ├── debee.ps1                          # PowerShell orchestrator
    ├── debee.sh                           # Bash orchestrator
    ├── debee.py                           # Python orchestrator
    ├── extract-db-objects.py              # Database object extractor
    ├── version_table_template.html        # HTML dashboard template
    └── docs/
        ├── configuration.md              # Environment & variables
        ├── operations.md                 # Operations reference
        ├── testing.md                    # Test framework
        ├── version-table.md              # Object tracking & formats
        └── cross-platform.md            # CLI reference & platform guide

Future Database Support

The project structure is designed for expansion:

debee/
├── postgresql/     # Current
├── mysql/          # Planned
├── sqlserver/      # Planned
└── oracle/         # Planned

Requirements

  • PostgreSQL client tools (psql, pg_restore)
  • One of: PowerShell 5.1+, Bash 4.0+, or Python 3.6+
  • Python 3.6+ (for extract-db-objects.py, standard library only)

Security Notes

  • Store credentials in .debee.env files (gitignored)
  • Use environment-specific configuration files
  • Restrict file permissions on configuration files

About

Debee is a cross-platform database migration orchestrator for PostgreSQL. It runs your SQL scripts in order — migrations, backups, tests — without embedding any database logic itself. Three implementations (PowerShell, Bash, Python) with identical interfaces.

Topics

Resources

Stars

Watchers

Forks

Contributors