Name

sqitch-revert - Revert changes to a database

Synopsis

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

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 target name, a URI, an engine name, or plan file path.

Attention Git Users

If you’re a git user thinking this is like git revert, it’s not. sqitch revert is more like time travel. It takes your database back to the state it had just after applying the target change. It feels like magic, but it’s actually all the time you spent writing revert scripts that finally pays off. Starting from the last change currently deployed, sqitch revert runs each revert script in turn until the target change is reached and becomes the last change deployed.

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.

• -m

• --modified

  Finds the change to revert onto based on modifications to deploy scripts. Reverts the change prior to earliest change with a revised deploy script.

• -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”.

• --log-only

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

• --lock-timeout

  sqitch deploy --lock-timeout 600
  

  Set the number of seconds for Sqitch to wait to get an exclusive advisory lock on the target database, for engines that support such a lock. This lock prevents other instances of Sqitch from deploying to the target at the same time, but prevents no other database activity. Defaults to 60.

• -y

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

• --registry

  sqitch revert --registry registry
  

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

• --db-client

• --client

  sqitch revert --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 revert --db-name widgets
  sqitch revert -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 revert --db-username root
  sqitch revert --db-user postgres
  sqitch revert -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 revert --db-host db.example.com
  sqitch revert -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 revert --db-port 7654
  sqitch revert -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 revert --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]

• [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 on revert. 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, MySQL’s user variables, SQL*Plus’s DEFINE variables, Snowflake’s SnowSQL variables, and ClickHouse’s 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
  • revert.variables
  • deploy.variables
  • core.variables

• revert.strict

  A boolean value indicating whether or not the change to revert to must be specified.

• revert.no_prompt

  A boolean value indicating whether or not to disable the prompt before executing the revert. May 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.