Docs/Commands/config
OSSgenerated from cli/_parser_setup.py

dblift config

Inspect DBLift configuration. Prints every persistent property alongside the three ways you can set it — config file key, environment variable, and CLI flag — so you never have to guess a name.

Synopsis

$ dblift config [--list]

Options

FlagDescription
--listList all properties and how to set them (config key / env var / CLI flag)

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

Examples

Find the env var for a property you only know by its flag

$ dblift config --list
dblift configuration properties
╭─────────────────────────────┬──────────────────────────────┬────────────────────╮
│ PROPERTY                    │ ENV VAR                      │ CLI FLAG           │
├─────────────────────────────┼──────────────────────────────┼────────────────────┤
│ history_table               │ DBLIFT_HISTORY_TABLE         │ --table            │
│ snapshot_table              │ DBLIFT_SNAPSHOT_TABLE        │ --snapshot-table   │
│ max_snapshots               │ DBLIFT_MAX_SNAPSHOTS         │ --max-snapshots    │
│ installed_by                │ DBLIFT_INSTALLED_BY          │ --installed-by     │
│ baseline_version            │ DBLIFT_BASELINE_VERSION      │ --baseline-version │
│ target_version              │ DBLIFT_TARGET_VERSION        │ --target-version   │
│ mark_as_executed            │ DBLIFT_MARK_AS_EXECUTED      │ --mark-as-executed │
│ strict_mode                 │ DBLIFT_STRICT_MODE           │ --strict           │
│ clean_disabled              │ DBLIFT_CLEAN_DISABLED        │ --clean-disabled   │
│ dry_run                     │ DBLIFT_DRY_RUN               │ --dry-run          │
│ tags                        │ DBLIFT_TAGS                  │ --tags             │
│ exclude_tags                │ DBLIFT_EXCLUDE_TAGS          │ --exclude-tags     │
│ versions                    │ DBLIFT_VERSIONS              │ --versions         │
│ exclude_versions            │ DBLIFT_EXCLUDE_VERSIONS      │ --exclude-versions │
│ log_level                   │ DBLIFT_LOG_LEVEL             │ --log-level        │
│ log_format                  │ DBLIFT_LOG_FORMAT            │ --log-format       │
│ log_file                    │ DBLIFT_LOG_FILE              │ --log-file         │
│ log_dir                     │ DBLIFT_LOG_DIR               │ --log-dir          │
│ database.url                │ DBLIFT_DB_URL                │ --db-url           │
│ database.type               │ DBLIFT_DB_TYPE               │ (none)             │
│ database.username           │ DBLIFT_DB_USERNAME           │ --db-username      │
│ database.password           │ DBLIFT_DB_PASSWORD           │ --db-password      │
│ database.schema             │ DBLIFT_DB_SCHEMA             │ --db-schema        │
│ database.host               │ DBLIFT_DB_HOST               │ (none)             │
│ database.port               │ DBLIFT_DB_PORT               │ (none)             │
│ database.database           │ DBLIFT_DB_DATABASE           │ (none)             │
│ database.connection_timeout │ DBLIFT_DB_CONNECTION_TIMEOUT │ (none)             │
╰─────────────────────────────┴──────────────────────────────┴────────────────────╯

Exit codes

CodeMeaning
0Command completed successfully
4A paid-edition feature was invoked without a valid licence (EXIT_LICENSE_REQUIRED)
On this page