Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages


home | help
sqitch-deploy(3)      User Contributed Perl Documentation     sqitch-deploy(3)

       sqitch-deploy - Deploy changes to a database

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

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

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

       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.

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

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

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

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

	       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.

	       In the event of deploy failure, no changes will be reverted;
	       for a verify failure, only the failed change will be reverted.

	   Note	that Sqitch assumes that each change is	atomic.	Therefore,
	   when	a deploy script	fails, it assumes there	is nothing to revert.
	   If a	verify script fails, it	will of	course run the revert script
	   for the failed change.

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

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

	   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 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 mode.	The supported values are the same as for the "--mode"

	   Boolean indicating whether or not to	verify each change.

	   A section defining database client variables. Useful	if your
	   database engine supports variables in scripts, such as PostgreSQL's
	   "psql" variables
	   PSQL-INTERPOLATION>,	Vertica's "vsql" variables
	   MySQL's user	variables
	   <>, and
	   SQL*Plus's "DEFINE" variables

       Part of the sqitch suite.

perl v5.32.0			  2020-08-29		      sqitch-deploy(3)

Name | Synopsis | Description | Options | Configuration Variables | Sqitch

Want to link to this manual page? Use this URL:

home | help