Name

       sqitch-checkout - Revert, checkout another VCS branch, and re-deploy changes

Synopsis

         sqitch [options] checkout [<database>] <branch>

Description

       Checkout another branch in your project's VCS (such as git <http://git-scm.org/>), while performing the
       necessary database changes to update your database for the new branch.

       More specifically, the "checkout" command compares the plan in the current branch to that in the branch
       to check out, identifies the last common changes between them, reverts to that change as if "sqitch
       revert" was called (unless there have been no changes deployed since that change), checks out the new
       branch, and then deploys all changes as if "sqitch deploy" had been called.

       If the VCS is already on the specified branch, nothing will be done.

       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.

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.

       "--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" or "revert.variables" configurations.

       "-d"
       "--set-deploy"
           Set  a  variable  name and value for use by the database engine client when deploying, if it supports
           variables. The format must be "name=value", e.g.,  "--set  defuser='Homer  Simpson'".  Overrides  any
           values from "--set" or loaded from the "deploy.variables" configuration.

       "-r"
       "--set-revert"
           Sets  a  variable name to be used by the database engine client during when reverting, if it supports
           variables. The format must be "name=value", e.g.,  "--set  defuser='Homer  Simpson'".  Overrides  any
           values from "--set" or loaded from the "deploy.variables" and "revert.variables" configurations.

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

       "-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 <http://www.postgresql.org/docs/current/static/app-psql.html#APP-PSQL-
           INTERPOLATION>,                    Vertica's                     "vsql"                     variables
           <http://my.vertica.com/docs/7.1.x/HTML/index.htm#Authoring/ConnectingToHPVertica/vsql/Variables.htm>,
           and                        SQL*Plus's                        "DEFINE"                       variables
           <http://docs.oracle.com/cd/B19306_01/server.102/b14357/ch12017.htm>.

       "checkout.verify"
       "deploy.verify"
           Boolean indicating whether or not to verify each change after deploying it.

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

       "[checkout.no_prompt]"
       "[revert.no_prompt]"
           A boolean value indicating whether or not to disable the prompt  before  executing  the  revert.  The
           "checkout.no_prompt"  variable  takes  precedence  over "revert.no_prompt", and both may of course be
           overridden by "-y".

       "[checkout.prompt_accept]"
       "[revert.prompt_accept]"
           A boolean value indicating whether default reply to the prompt before executing the revert should  be
           "yes"  or  "no".  The "checkout.prompt_accept" variable takes precedence over "revert.prompt_accept",
           and both default to true, meaning to accept the revert.

Sqitch

       Part of the sqitch suite.

perl v5.26.1                                       2018-01-13                               sqitch-checkout(3pm)