.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "sqitch-rebase 3pm"
.TH sqitch-rebase 3pm "2014-09-28" "perl v5.20.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "Name"
.IX Header "Name"
sqitch-rebase \- Revert and redeploy database changes
.SH "Synopsis"
.IX Header "Synopsis"
.Vb 6
\&  sqitch [options] rebase [<database>]
\&  sqitch [options] rebase [<database>] \-\-onto\-change <change>
\&  sqitch [options] rebase [<database>] \-\-onto\-change <change> \-\-upto\-change <change>
\&  sqitch [options] rebase [<database>] <change>
\&  sqitch [options] rebase [<database>] <change> \-\-upto\-change <change>
\&  sqitch [options] rebase [<database>] <change> <change>
.Ve
.SH "Description"
.IX Header "Description"
Revert and redeploy changes to the database. It's effectively a shortcut for
running \f(CW\*(C`sqitch revert\*(C'\fR and \f(CW\*(C`sqitch deploy\*(C'\fR
in succession.
.PP
More specifically, 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 \f(CW\*(C`\-\-onto\*(C'\fR or with no option flag, in
which case changes will be reverted back to that change. If nothing needs to
be reverted, a message will be emitted explaining why and nothing will be
reverted.
.PP
Once the revert finishes, changes will be deployed starting from the deployed
state through the rest of the deployment plan. They will run to the latest
change in the plan, unless a change is specified, either via \f(CW\*(C`\-\-upto\*(C'\fR or with
no option flag, in which case changes will be deployed up-to and including
that change.
.PP
If the database has not been deployed to, or its state already matches the
specified change, no reverts will be run. And if, at that point, the database
is up-to-date, no deploys will be run.
.PP
The \f(CW\*(C`<database>\*(C'\fR parameter specifies the database to which to connect,
and may also be specified as the \f(CW\*(C`\-\-target\*(C'\fR option. It can be either a \s-1URI\s0 or
the name of a target in the configuration.
.SH "Options"
.IX Header "Options"
.ie n .IP """\-t""" 4
.el .IP "\f(CW\-t\fR" 4
.IX Item "-t"
.PD 0
.ie n .IP """\-\-target""" 4
.el .IP "\f(CW\-\-target\fR" 4
.IX Item "--target"
.PD
The target database to which to connect. This option can be either a \s-1URI\s0 or
the name of a target in the configuration.
.ie n .IP """\-\-onto\-change""" 4
.el .IP "\f(CW\-\-onto\-change\fR" 4
.IX Item "--onto-change"
.PD 0
.ie n .IP """\-\-onto""" 4
.el .IP "\f(CW\-\-onto\fR" 4
.IX Item "--onto"
.PD
Specify the reversion change. Defaults to reverting all changes. See
sqitchchanges for the various ways in which changes can be specified.
.ie n .IP """\-\-upto\-change""" 4
.el .IP "\f(CW\-\-upto\-change\fR" 4
.IX Item "--upto-change"
.PD 0
.ie n .IP """\-\-upto""" 4
.el .IP "\f(CW\-\-upto\fR" 4
.IX Item "--upto"
.PD
Specify the deployment change. Defaults to the last point in the plan. See
sqitchchanges for the various ways in which changes can be specified.
.ie n .IP """\-\-mode""" 4
.el .IP "\f(CW\-\-mode\fR" 4
.IX Item "--mode"
Specify the reversion mode to use in case of deploy failure. Possible values
are:
.RS 4
.ie n .IP """all""" 4
.el .IP "\f(CWall\fR" 4
.IX Item "all"
In the event of failure, revert all deployed changes, back to
\&\f(CW\*(C`\-\-onto\-change\*(C'\fR. This is the default.
.ie n .IP """tag""" 4
.el .IP "\f(CWtag\fR" 4
.IX Item "tag"
In the event of failure, revert all deployed changes to the last
successfully-applied tag. If no tags were applied, all changes will be
reverted to \f(CW\*(C`\-\-onto\-change\*(C'\fR.
.ie n .IP """change""" 4
.el .IP "\f(CWchange\fR" 4
.IX Item "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.
.RE
.RS 4
.RE
.ie n .IP """\-\-verify""" 4
.el .IP "\f(CW\-\-verify\fR" 4
.IX Item "--verify"
Verify each change by running its verify script, if there is one, immediate
after deploying it. 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 \f(CW\*(C`\-\-mode\*(C'\fR.
.ie n .IP """\-\-no\-verify""" 4
.el .IP "\f(CW\-\-no\-verify\fR" 4
.IX Item "--no-verify"
Don't verify each change. This is the default.
.ie n .IP """\-s""" 4
.el .IP "\f(CW\-s\fR" 4
.IX Item "-s"
.PD 0
.ie n .IP """\-\-set""" 4
.el .IP "\f(CW\-\-set\fR" 4
.IX Item "--set"
.PD
Set a variable name and value for use by the database engine client, if it
supports variables. The format must be \f(CW\*(C`name=value\*(C'\fR, e.g., \f(CW\*(C`\-\-set
defuser=\*(AqHomer Simpson\*(Aq\*(C'\fR. Overrides any values loaded from the
\&\f(CW\*(C`deploy.variables\*(C'\fR or \f(CW\*(C`revert.variables\*(C'\fR configurations.
.ie n .IP """\-d""" 4
.el .IP "\f(CW\-d\fR" 4
.IX Item "-d"
.PD 0
.ie n .IP """\-\-set\-deploy""" 4
.el .IP "\f(CW\-\-set\-deploy\fR" 4
.IX Item "--set-deploy"
.PD
Set a variable name and value for use by the database engine client when
deploying, if it supports variables. The format must be \f(CW\*(C`name=value\*(C'\fR, e.g.,
\&\f(CW\*(C`\-\-set defuser=\*(AqHomer Simpson\*(Aq\*(C'\fR. Overrides any values from \f(CW\*(C`\-\-set\*(C'\fR or loaded
from the \f(CW\*(C`deploy.variables\*(C'\fR configuration.
.ie n .IP """\-r""" 4
.el .IP "\f(CW\-r\fR" 4
.IX Item "-r"
.PD 0
.ie n .IP """\-\-set\-revert""" 4
.el .IP "\f(CW\-\-set\-revert\fR" 4
.IX Item "--set-revert"
.PD
Sets a variable name to be used by the database engine client during when
reverting, if it supports variables. The format must be \f(CW\*(C`name=value\*(C'\fR, e.g.,
\&\f(CW\*(C`\-\-set defuser=\*(AqHomer Simpson\*(Aq\*(C'\fR. Overrides any values from \f(CW\*(C`\-\-set\*(C'\fR or loaded
from the \f(CW\*(C`deploy.variables\*(C'\fR and \f(CW\*(C`revert.variables\*(C'\fR configurations.
.ie n .IP """\-\-log\-only""" 4
.el .IP "\f(CW\-\-log\-only\fR" 4
.IX Item "--log-only"
Log the changes as if they were deployed and reverted, but without actually
running the deploy and revert scripts.
.ie n .IP """\-y""" 4
.el .IP "\f(CW\-y\fR" 4
.IX Item "-y"
Disable the prompt that normally asks whether or not to execute the revert.
.SH "Configuration Variables"
.IX Header "Configuration Variables"
.ie n .IP """[deploy.variables]""" 4
.el .IP "\f(CW[deploy.variables]\fR" 4
.IX Item "[deploy.variables]"
.PD 0
.ie n .IP """[revert.variables]""" 4
.el .IP "\f(CW[revert.variables]\fR" 4
.IX Item "[revert.variables]"
.PD
A section defining database client variables. The \f(CW\*(C`deploy.variables\*(C'\fR
configuration is read from the \f(CW\*(C`deploy\*(C'\fR command configuration, on the
assumption that the values will generally be the same. If they're not, use
\&\f(CW\*(C`revert.variables\*(C'\fR to override \f(CW\*(C`deploy.variables\*(C'\fR.
.Sp
These variables are Useful if your database engine supports variables in
scripts, such as PostgreSQL's
\&\f(CW\*(C`psql\*(C'\fR variables <http://www.postgresql.org/docs/current/static/app-psql.html#APP-PSQL-INTERPOLATION>.
.ie n .IP """rebase.verify""" 4
.el .IP "\f(CWrebase.verify\fR" 4
.IX Item "rebase.verify"
.PD 0
.ie n .IP """deploy.verify""" 4
.el .IP "\f(CWdeploy.verify\fR" 4
.IX Item "deploy.verify"
.PD
Boolean indicating whether or not to verify each change after deploying it.
.ie n .IP """rebase.mode""" 4
.el .IP "\f(CWrebase.mode\fR" 4
.IX Item "rebase.mode"
.PD 0
.ie n .IP """deploy.mode""" 4
.el .IP "\f(CWdeploy.mode\fR" 4
.IX Item "deploy.mode"
.PD
Deploy mode. The supported values are the same as for the \f(CW\*(C`\-\-mode\*(C'\fR option.
.ie n .IP """[rebase.no_prompt]""" 4
.el .IP "\f(CW[rebase.no_prompt]\fR" 4
.IX Item "[rebase.no_prompt]"
.PD 0
.ie n .IP """[revert.no_prompt]""" 4
.el .IP "\f(CW[revert.no_prompt]\fR" 4
.IX Item "[revert.no_prompt]"
.PD
A boolean value indicating whether or not to disable the prompt before
executing the revert. The \f(CW\*(C`rebase.no_prompt\*(C'\fR variable takes precedence over
\&\f(CW\*(C`revert.no_prompt\*(C'\fR, and both may of course be overridden by \f(CW\*(C`\-y\*(C'\fR.
.ie n .IP """[rebase.prompt_accept]""" 4
.el .IP "\f(CW[rebase.prompt_accept]\fR" 4
.IX Item "[rebase.prompt_accept]"
.PD 0
.ie n .IP """[revert.prompt_accept]""" 4
.el .IP "\f(CW[revert.prompt_accept]\fR" 4
.IX Item "[revert.prompt_accept]"
.PD
A boolean value indicating whether default reply to the prompt before
executing the revert should be \*(L"yes\*(R" or \*(L"no\*(R". The \f(CW\*(C`rebase.prompt_accept\*(C'\fR
variable takes precedence over \f(CW\*(C`revert.prompt_accept\*(C'\fR, and both default to
true, meaning to accept the revert by default.
.SH "Sqitch"
.IX Header "Sqitch"
Part of the sqitch suite.