Name

sqitch-deploy - Deploy changes to a database

Synopsis

sqitch [options] deploy
sqitch [options] deploy <target>
sqitch [options] deploy --to-target <target>

Description

Deploy changes to the database. Changes will begin from the current deployment state. They will run to the latest change, unless a target is specified, either via --to or with no option flag, in which case changes will be deployed up-to and including that target.

If the database it up-to-date or already deployed to the specified target, no changes will be made. If the target appears earlier in the plan than the currently-deployed state, an error will be returned, along with a suggestion to instead use sqitch-revert.

Options

--to-target

--target

--to

Specify the deployment target. Defaults to the last point in the plan. See sqitchchanges for the various ways in which change targets can be specified.

--mode

Specify the reversion mode to use in case of failure. Possible values are:

all

In the event of failure, revert all deployed changes, back to the point at which deployment started. This is the default.

tag

In the event of failure, revert all deployed changes to the last successfully-applied tag. If no tags were applied during this deployment, all changes will be reverted to the point at which deployment began.

change

In the event of failure, no changes will be reverted. This is on the assumption that a change is atomic, and thus may may be deployed again.

--verify

Verify each change by running its verify script, if there is one. If a verify test fails, the deploy will be considered to have failed and the appropriate reversion will be carried out, depending on the value of --mode.

--no-verify

Don't verify each change. This is the default.

-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 configuration.

--log-only

Log the changes as if they were deployed, but without actually running the deploy scripts. Useful for an existing database that is being converted to Sqitch, and you need to log changes as deployed because they have been deployed by other means in the past.

Configuration Variables

deploy.to_target

Target to deploy to. You probably don't want to set this.

deploy.mode

Deploy mode. The supported values are the same as for the --mode option.

deploy.verify

Boolean indicating whether or not to verify each change.

[deploy.variables]

A section defining database client variables. Useful if your database engine supports variables in scripts, such as PostgreSQL's psql variables.

Sqitch

Part of the sqitch suite.