dbpm check-core

Verify that Core is installed in the target database and optionally meets a minimum version requirement. This is a read-only command — it makes no changes.

Syntax

dbpm check-core [--minimum-version VERSION] [--connect STRING | --connect-name NAME] [--runner EXEC]

EBNF diagram

flowchart LR
    command["command"] --> dbpm["dbpm"]
    dbpm --> check_core["check-core"]
    check_core --> options["{ option }"]
    options --> end_node(("end"))

    options -. expands to .-> option["option"]
    option --> minimum_version["--minimum-version VERSION"]
    option --> connect["--connect STRING or --connect-name NAME"]
    option --> runner["--runner EXEC"]

    minimum_version -. constrains success .-> version_note["Core must be at least VERSION"]

Arguments

Argument	Default	Description
`--minimum-version`	none	Minimum acceptable Core version, such as `3.2.0`. If omitted, any installed Core version passes.
`--connect`	`DBPM_CONNECT`	Raw SQL*Plus/SQLcl connect string, such as `user/pass@service`. Mutually exclusive with `--connect-name`.
`--connect-name`	`DBPM_CONNECT_NAME`	SQLcl saved connection name. Requires SQLcl via `--runner` or `DBPM_SQL_RUNNER`.
`--runner`	`DBPM_SQL_RUNNER` or `sqlplus`	SQL runner executable.

Output

On success:

CORE_VERSION=3.5.0

On failure, dbpm exits with code 2 and prints an error to stderr.

Examples

Check that any Core version is installed:

dbpm check-core --connect user/pass@db

Check that Core meets a minimum version:

dbpm check-core --minimum-version 3.2.0 --connect user/pass@db

Using environment variables:

export DBPM_CONNECT=user/pass@db
unset DBPM_CONNECT_NAME
dbpm check-core --minimum-version 3.0.0

Using a SQLcl saved connection:

unset DBPM_CONNECT
export DBPM_CONNECT_NAME="Development Database (APP_USER)"
export DBPM_SQL_RUNNER=sql
dbpm check-core

Or pass the saved connection name directly:

dbpm check-core \
  --connect-name "Development Database (APP_USER)" \
  --runner sql

Notes

Run check-core before any non-Core deployment to verify the substrate is ready.
Core must be bootstrapped with dbpm bootstrap-core before ordinary package installs can run.
SQLcl saved connections are local to the OS user running dbpm.
Do not put a SQLcl saved connection name in DBPM_CONNECT; use DBPM_CONNECT_NAME or --connect-name.

Source: docs/commands/check-core.md