sqitch-verify(3pm)

Name
sqitch-verify - Verify deployed database changes

Synopsis
  sqitch verify [options] [<database>]
  sqitch verify [options] --from-change <change>
  sqitch verify [options] --to-change <change>
  sqitch verify [options] --from-change <change> --to-change <change>

Description
Verify that a database is valid relative to the plan and the verification scripts for each deployed change.

More specifically, "verify" iterates over all deployed and planned changes (or the subset identified by "--from-change" and/or "--to-change") and checks that each:

•   Is deployed.

•   Is present in the plan.

•   Was deployed in the proper order.

•   Passes its verify test, if one exists and the change has not been reworked.

The "<database>" parameter specifies the database to which to connect, and may also be specified as the "--target" option. It can be target name, a URI, an engine name, or plan file path.

Verify tests are scripts that may be associated with each change. If a change has no verify script, a warning is emitted, but it is not considered a failure. If a change has been reworked, only the most recent reworking will have its verify script executed.

Verify scripts should make no assumptions about the contents of the database, as unit tests might. Rather, their job is to ensure that the state of a database is correct after a deploy script has completed. Verify scripts are run through the database engine command-line client, just like deploy and revert scripts. They should cause the client to exit with a non-zero exit code if they fail.

Options

"-t"
"--target"
    The target database to which to connect. This option can be either a URI or the name of a target in the configuration.

"--from-change"
"--from"
    Specify the change with which to start the verification. Defaults to the earliest deployed change. See sqitchchanges for the various ways in which changes can be specified.

"--to-change"
"--to"
    Specify the change with which to complete the verification. Defaults to the last deployed change. See sqitchchanges for the various ways in which changes can be specified.

"-s"
"--set"
    Set a variable name and value for use by the database engine client, if it supports variables. The format must be "name=value", e.g., "--set defuser='Homer Simpson'". Overrides any values loaded from "configuration Variables".

"--registry"
      sqitch verify --registry registry

    The name of the Sqitch registry schema or database in which sqitch stores its own data.

"--db-client"
"--client"
      sqitch verify --client /usr/local/pgsql/bin/psql

    Path to the command-line client for the database engine. Defaults to a client in the current path named appropriately for the database engine.

"-d"
"--db-name"
      sqitch verify --db-name widgets
      sqitch verify -d bricolage

    Name of the database. In general, targets and URIs are preferred, but this option can be used to override the database name in a target.

"-u"
"--db-user"
"--db-username"
      sqitch verify --db-username root
      sqitch verify --db-user postgres
      sqitch verify -u Mom

    User name to use when connecting to the database. Does not apply to all engines. In general, targets and URIs are preferred, but this option can be used to override the user name in a target.

"-h"
"--db-host"
      sqitch verify --db-host db.example.com
      sqitch verify -h appdb.example.net

    Host name to use when connecting to the database. Does not apply to all engines. In general, targets and URIs are preferred, but this option can be used to override the host name in a target.

"-p"
"--db-port"
      sqitch verify --db-port 7654
      sqitch verify -p 5431

    Port number to connect to. Does not apply to all engines. In general, targets and URIs are preferred, but this option can be used to override the port in a target.

"--plan-file"
"-f"
      sqitch verify --plan-file my.plan

    Path to the deployment plan file. Overrides target, engine, and core configuration values. Defaults to $top_dir/sqitch.plan.

Configuration Variables

"[deploy.variables]"
"[verify.variables]"
    A section defining database client variables. The "deploy.variables" configuration is read from the "deploy" command configuration, on the assumption that the values will generally be the same on verify. If they're not, use "verify.variables" to override "deploy.variables".

    These variables are useful if your database engine supports variables in scripts, such as PostgreSQL's "psql" variables <https://www.postgresql.org/docs/current/static/app-psql.html#APP-PSQL-INTERPOLATION>, Vertica's "vsql" variables <https://docs.vertica.com/24.2.x/en/connecting-to/using-vsql/variables/>, MySQL's user variables <https://dev.mysql.com/doc/refman/5.6/en/user-variables.html>, SQL*Plus's "DEFINE" variables <https://docs.oracle.com/cd/B19306_01/server.102/b14357/ch12017.htm>, Snowflake's SnowSQL variables <https://docs.snowflake.com/en/user-guide/snowsql-use.html#using-variables>, and ClickHouse's queries with parameters <https://clickhouse.com/docs/interfaces/cli#cli-queries-with-parameters>.

    May be overridden by "--set" or target and engine configuration. Variables are merged in the following priority order:

    "--set"
    "target.$target.variables"
    "engine.$engine.variables"
    "verify.variables"
    "deploy.variables"
    "core.variables"

Sqitch
Part of the sqitch suite.