dblift db

Database utility commands. Four subcommands for checking that DBLift can see your driver, read your config, and reach your database — before you ask it to change anything. A subcommand is required.

Synopsis

$ dblift db

Options

FlagDescription

No command-specific options. Global flags still apply.

Subcommands

list-drivers

dblift db list-drivers [-h]

validate-config

dblift db validate-config [-h] [--db-url DB_URL]
                                 [--db-schema DB_SCHEMA]
                                 [--db-username DB_USERNAME]
                                 [--db-password DB_PASSWORD]

--db-urlDatabase connection URL

--db-schemaDatabase schema

--db-usernameDatabase username

--db-passwordDatabase password

diagnose-connection

dblift db diagnose-connection [-h] [--format {text,json,pretty}]

--formatOutput format (default: text)

check-connection

dblift db check-connection [-h] [--db-url DB_URL]
                                  [--db-schema DB_SCHEMA]
                                  [--db-username DB_USERNAME]
                                  [--db-password DB_PASSWORD]
                                  [--format {text,json,pretty}]

--db-url, --urlDatabase connection URL

--db-schemaDatabase schema

--db-username, --usernameDatabase username

--db-password, --passwordDatabase password

--formatOutput format (default: text)

Global flags apply to every command: --config, --env, --scripts, --dry-run, --quiet, --log-level. See global flags.

Examples

Check which native drivers are installed

$ dblift db list-drivers

Native Driver Status:
=====================
  alloydb            : Available
  aurora-postgresql  : Available
  citus              : Available
  cockroachdb        : Available
  cosmosdb           : Available
  db2                : Available
  duckdb             : Available
  mariadb            : Available
  mongodb            : Available
  mysql              : Available
  neon               : Available
  oracle             : Available
  postgresql         : Available
  redshift           : Available
  snowflake          : Available
  sqlite             : Available
  sqlserver          : Available
  supabase           : Available
  timescaledb        : Available
  yugabytedb         : Available

Validate a config file without opening the database

$ dblift --config dblift.yaml db validate-config

Database configuration and driver are valid.

Exit codes

CodeMeaning

0Command completed successfully

4A paid-edition feature was invoked without a valid licence (EXIT_LICENSE_REQUIRED)

Previousimport-flyway Nextconfig