Skip to main content

Project Commands

Project commands help you initialize and configure Dubnium projects. These commands are free and do not require a commercial license.

init

Initialize a new Dubnium project.

Alias: -i

Usage:

dbm init
# or
dbm -i

Description: Creates a new dubnium.yml configuration file in your current directory with default settings. This is typically the first command you run when setting up Dubnium for a new project.

Generated Configuration: The command creates a dubnium.yml file with the following structure:

ProjectName: 'MyProject'
MigrationPath: 'Migration'
DatabaseOne:
ConnectionString: 'Server=localhost;Database=MyDB;Integrated Security=true;'
Name: 'MyDatabase'
DatabaseTwo: # Optional second database
ConnectionString: ''
Name: ''
Registration:
LicensedEmail: ''
RegistrationCode: ''
TempPath: 'c:\temp\'
Verbose: false
TablesToDump: # For dumpdata command
- 'Users'
- 'Products'

Next Steps:

  1. Edit the generated dubnium.yml file with your specific database connection details
  2. Configure the MigrationPath to point to your SQL scripts directory
  3. Set up licensing information if you plan to use paid features
  4. Run dbm setup to initialize the database environment

setup

Setup the database environment.

Usage:

dbm setup

Description: Initializes the database environment by creating necessary tables and structures that Dubnium uses to track database versions and manage migrations. This command should be run after configuring your dubnium.yml file.

Prerequisites:

  • Valid dubnium.yml configuration file
  • Database connection configured in DatabaseOne
  • Database server accessible and user has appropriate permissions

What it does:

  1. Connects to the configured database
  2. Creates Dubnium system tables for version tracking
  3. Initializes the migration history
  4. Sets up the environment for script execution

Permissions Required:

  • CREATE TABLE permissions on the target database
  • INSERT/UPDATE/SELECT permissions on created tables
  • EXECUTE permissions for stored procedures (if applicable)

Example Output:

Executing command: Setup
Database environment setup completed successfully
System tables created and initialized
Ready for migration script execution

Troubleshooting:

  • Connection Failed: Verify your connection string in dubnium.yml
  • Permission Denied: Ensure your database user has sufficient privileges
  • Database Not Found: Create the target database before running setup