Name

sqitch-revert - Revert changes to a database

Synopsis

sqitch [options] revert [<database>]
sqitch [options] revert [<database>] <change>
sqitch [options] revert [<database>] --to-change <change>

Description

Revert changes to the database. Starting from the current deployment state, changes will be reverted in reverse the order of application. All changes will be reverted unless a change is specified, either via --to or with no option flag, in which case changes will be reverted back to that change.

If the database has not been deployed to, or its state already matches the specified change, no changes will be made. If the change appears later in the plan than the currently-deployed state, an error will be returned, along with a suggestion to instead use sqitch-deploy.

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.

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.

--to-change

--change

--to

Specify the reversion change. Defaults to reverting all changes. 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 deploy.variables or revert.variables configurations.

--log-only

Log the changes as if they were reverted, but without actually running the revert scripts.

-y

Disable the prompt that normally asks whether or not to execute the revert.

Configuration Variables

[deploy.variables]

[revert.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. If they're not, use revert.variables to override deploy.variables.

These variables are 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.

[revert.no_prompt]

A boolean value indicating whether or not to disable the prompt before executing the revert. My be overridden by -y.

[revert.prompt_accept]

A boolean value indicating whether default reply to the prompt before executing the revert should be "yes" or "no". Defaults to true, meaning to accept the revert.

Sqitch

Part of the sqitch suite.