Dubnium Documentation
Welcome to Dubnium, a SQL Server database versioning and migration tool from Booolean, used through the dbm command.
What is Dubnium?
Dubnium is a .NET global tool that manages SQL Server schema and reference-data changes from a single dubnium.yml file. It lets a team:
- Version database changes as numbered SQL scripts kept in source control
- Deploy consistently to any named database target, applying only the scripts it has not run yet
- Compare schemas between two databases, with an HTML diff report
- Promote settings safely as reviewable one-file-per-row setting files, deployed only on request
- Document the schema as Markdown (for diffs) and a printable PDF
- Automate verification and deployment in CI/CD pipelines
Key Features
- Named database targets: configure any number of databases (
local,test,prod...) and pass the key to each command, for exampledbm deploy test. - Secure connection sources: take a connection string inline, from an environment variable, or from a Cryptex-encrypted file.
- Script type folders:
Platform,Generated, andApplicationscripts each keep their own version sequence and watermark. - Variables:
{{NAME}}tokens in scripts are replaced from theVariablessection, and undefined variables fail the deployment. - Setting promotion:
settingdumpandsettingdeploymove table settings between environments, separately from script deployment. - Schema documentation:
schemadocwrites Markdown and PDF from the live database, with optional column-standard checks. - Configuration redirect: a
dubnium.ymlcan point to the real configuration file in another folder. - Safety options: dry-run mode, skip filters, and per-script-type reruns.
Command Categories
- Information Commands: version, database version, help, update hint, and connection test
- Project Commands: create a configuration and set up a database target
- Execution Commands: create scripts, deploy, compare, dump schema and data, promote settings, document the schema, back up, and clean
- Verification Commands: check configuration, connections, folders, and script names
Getting Started
Installation
dotnet tool install --global dubnium-cli
Quick Start
-
Create a configuration:
dbm init -
Edit
dubnium.yml: setProjectNameand at least one database target (see Configuration). -
Set up the database target:
dbm setup local -
Create a migration script:
dbm new Create Users Table # Application (default)
dbm new --platform Create Core Schema # Platform
dbm new --generated Refresh Module Output # Generated -
Deploy pending scripts:
dbm deploy local
Requirements
- .NET 10.0 SDK or runtime
- SQL Server
- Windows is required for
schemadocPDF output (it uses the installed Windows fonts)
Licensing
- Free commands: every command except those listed below
- Registered commands: need a registered Dubnium account (none at present)
- Paid commands: need an active subscription:
build,deploy, andshift
Registered and paid commands need Registration.LicensedEmail and Registration.RegistrationCode in dubnium.yml. Each command page marks its license.
Dubnium is provided "as is", without warranty, and the owner accepts no liability for damage, data loss or misleading output, on free or paid commands alike. Do not use it against a live or production environment without a current, tested backup. Read the Terms of Use before you install.