sqitch-checkout(3)

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

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

Description
Checkout another branch in your project's VCS (such as git <https://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 "Configuration Variables".

"-e"
"--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 values loaded from "Configuration Variables".

"-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 values loaded from "Configuration Variables".

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

"--lock-timeout"
      sqitch checkout --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 working on 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 checkout --registry registry

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

"--db-client"
"--client"
      sqitch checkout --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 checkout --db-name widgets
      sqitch checkout -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 checkout --db-username root
      sqitch checkout --db-user postgres
      sqitch checkout -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 checkout --db-host db.example.com
      sqitch checkout -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 checkout --db-port 7654
      sqitch checkout -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 checkout --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. These variables are useful if your database engine supports variables in scripts, such as PostgreSQL's "psql" variables <https://www.postgresql.org/docs/current/static/app-psql.html#APP-PSQL-INTERPOLATION>, Vertica's "vsql" variables <https://docs.vertica.com/24.2.x/en/connecting-to/using-vsql/variables/>, MySQL's user variables <https://dev.mysql.com/doc/refman/5.6/en/user-variables.html>, SQL*Plus's "DEFINE" variables <https://docs.oracle.com/cd/B19306_01/server.102/b14357/ch12017.htm>, Snowflake's SnowSQL variables <https://docs.snowflake.com/en/user-guide/snowsql-use.html#using-variables>, and ClickHouse's queries with parameters <https://clickhouse.com/docs/interfaces/cli#cli-queries-with-parameters>.

    May be overridden by "--set", "--set-deploy", "--set-revert", or target and engine configuration. Variables are merged in the following priority order:

    "--set-revert"
        Used only while reverting changes.

    "--set-deploy"
        Used only while deploying changes.

    "--set"
        Used while reverting and deploying changes.

    "target.$target.variables"
        Used while reverting and deploying changes.

    "engine.$engine.variables"
        Used while reverting and deploying changes.

    "revert.variables"
        Used only while reverting changes.

    "deploy.variables"
        Used while reverting and deploying changes.

    "core.variables"
        Used while reverting and deploying changes.

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

"checkout.strict"
"revert.strict"
    A boolean value that, when true, disables the "checkout" command. The "checkout.strict" variable takes precedence over "revert.strict".

    When the checkout command is disabled, use the "deploy" and "revert" commands directly.

Sqitch
Part of the sqitch suite.