David E. Wheeler > App-Sqitch > sqitch-verify

Download:
App-Sqitch-0.996.tar.gz

Annotate this POD

Website

View/Report Bugs
Source  

Name ^

sqitch-verify - Verify deployed database changes

Synopsis ^

  sqitch [options] verify [<database>]
  sqitch [options] verify --from-change <change>
  sqitch [options] verify --to-change <change>
  sqitch [options] verify --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:

The <database> parameter specifies the database to which to connect, and may also be specified as the --target option. It can be either a URI or the name of a target in the configuration.

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 the verify.variables configuration.

Configuration Variables ^

[verify.variables]

A section defining database client variables. Useful if your database engine supports variables in scripts, such as PostgreSQL's psql variables, Vertica's vsql variables, and SQL*Plus's DEFINE variables.

Sqitch ^

Part of the sqitch suite.

syntax highlighting: