.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 >0, 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
.\" ========================================================================
.\"
.IX Title "sqitch-engine 3pm"
.TH sqitch-engine 3pm 2024-02-08 "perl v5.38.2" "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-engine \- Manage database engine configuration
.SH Synopsis
.IX Header "Synopsis"
.Vb 6
\&  sqitch engine
\&  sqitch engine [\-v | \-\-verbose]
\&  sqitch engine add <name> [engine\-options]
\&  sqitch engine alter <name> [engine\-options]
\&  sqitch engine remove <name>
\&  sqitch engine show <name>
.Ve
.SH Description
.IX Header "Description"
Manage the database engines you deploy to. The list of supported engines
includes:
.IP \(bu 4
\&\f(CW\*(C`firebird\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`mysql\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`oracle\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`pg\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`sqlite\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`vertica\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`exasol\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`snowflake\*(C'\fR
.PP
Each engine may have a number of properties:
.ie n .IP """target""" 4
.el .IP \f(CWtarget\fR 4
.IX Item "target"
The name or URI of the database target. Note that if the value is a URI, the
engine in the URI must match the engine being added or altered. The default is
\&\f(CW\*(C`db:$engine\*(C'\fR. See sqitch-target for details on target configuration.
.ie n .IP """registry""" 4
.el .IP \f(CWregistry\fR 4
.IX Item "registry"
The name of the registry schema or database. The default is \f(CW\*(C`sqitch\*(C'\fR.
.ie n .IP """client""" 4
.el .IP \f(CWclient\fR 4
.IX Item "client"
The command-line client to use. If not specified, each engine looks in the OS
Path for an appropriate client.
.ie n .IP """top_dir""" 4
.el .IP \f(CWtop_dir\fR 4
.IX Item "top_dir"
The path to the top directory for the engine. This directory generally
contains the plan file and subdirectories for deploy, revert, and verify
scripts, as well as reworked instances of those scripts. The default is \fI.\fR,
the current directory.
.ie n .IP """plan_file""" 4
.el .IP \f(CWplan_file\fR 4
.IX Item "plan_file"
The plan file to use for this engine. The default is \f(CW\*(C`$top_dir/sqitch.plan\*(C'\fR.
.ie n .IP """deploy_dir""" 4
.el .IP \f(CWdeploy_dir\fR 4
.IX Item "deploy_dir"
The path to the deploy directory for the engine. This directory contains all
of the deploy scripts referenced by changes in the \f(CW\*(C`plan_file\*(C'\fR. The default
is \f(CW\*(C`$top_dir/deploy\*(C'\fR.
.ie n .IP """revert_dir""" 4
.el .IP \f(CWrevert_dir\fR 4
.IX Item "revert_dir"
The path to the revert directory for the engine. This directory contains all
of the revert scripts referenced by changes in the \f(CW\*(C`plan_file\*(C'\fR. The default
is \f(CW\*(C`$top_dir/revert\*(C'\fR.
.ie n .IP """verify_dir""" 4
.el .IP \f(CWverify_dir\fR 4
.IX Item "verify_dir"
The path to the verify directory for the engine. This directory contains all
of the verify scripts referenced by changes in the \f(CW\*(C`plan_file\*(C'\fR. The default
is \f(CW\*(C`$top_dir/verify\*(C'\fR.
.ie n .IP """reworked_dir""" 4
.el .IP \f(CWreworked_dir\fR 4
.IX Item "reworked_dir"
The path to the reworked directory for the engine. This directory contains all
subdirectories for all reworked scripts referenced by changes in the
\&\f(CW\*(C`plan_file\*(C'\fR. The default is \f(CW$top_dir\fR.
.ie n .IP """reworked_deploy_dir""" 4
.el .IP \f(CWreworked_deploy_dir\fR 4
.IX Item "reworked_deploy_dir"
The path to the reworked deploy directory for the engine. This directory
contains all of the reworked deploy scripts referenced by changes in the
\&\f(CW\*(C`plan_file\*(C'\fR. The default is \f(CW\*(C`$reworked_dir/deploy\*(C'\fR.
.ie n .IP """reworked_revert_dir""" 4
.el .IP \f(CWreworked_revert_dir\fR 4
.IX Item "reworked_revert_dir"
The path to the reworked revert directory for the engine. This directory
contains all of the reworked revert scripts referenced by changes in the
\&\f(CW\*(C`plan_file\*(C'\fR. The default is \f(CW\*(C`$reworked_dir/revert\*(C'\fR.
.ie n .IP """reworked_verify_dir""" 4
.el .IP \f(CWreworked_verify_dir\fR 4
.IX Item "reworked_verify_dir"
The path to the reworked verify directory for the engine. This directory
contains all of the reworked verify scripts referenced by changes in the
\&\f(CW\*(C`plan_file\*(C'\fR. The default is \f(CW\*(C`$reworked_dir/verify\*(C'\fR.
.ie n .IP """extension""" 4
.el .IP \f(CWextension\fR 4
.IX Item "extension"
The file name extension to append to change names to create script file names.
The default is \f(CW\*(C`sql\*(C'\fR.
.PP
Each of these overrides the corresponding core configuration \-\- for example,
the \f(CW\*(C`core.target\*(C'\fR, \f(CW\*(C`core.plan_file\*(C'\fR, \f(CW\*(C`core.registry\*(C'\fR, and \f(CW\*(C`core.client\*(C'\fR
config options.
.SH Options
.IX Header "Options"
.IP "List Option" 4
.IX Item "List Option"
.RS 4
.PD 0
.ie n .IP """\-v""" 4
.el .IP \f(CW\-v\fR 4
.IX Item "-v"
.ie n .IP """\-\-verbose""" 4
.el .IP \f(CW\-\-verbose\fR 4
.IX Item "--verbose"
.PD
.Vb 1
\&  sqitch engine \-\-verbose
.Ve
.Sp
Be more verbose when listing engines.
.RE
.RS 4
.RE
.IP "Add and Alter Options" 4
.IX Item "Add and Alter Options"
.RS 4
.PD 0
.ie n .IP """\-\-top\-dir""" 4
.el .IP \f(CW\-\-top\-dir\fR 4
.IX Item "--top-dir"
.PD
.Vb 1
\&  sqitch engine add pg \-\-top\-dir sql
.Ve
.Sp
Specifies the top directory to use for the engine. Typically contains the
deployment plan file and the change script directories.
.ie n .IP """\-\-plan\-file""" 4
.el .IP \f(CW\-\-plan\-file\fR 4
.IX Item "--plan-file"
.PD 0
.ie n .IP """\-f""" 4
.el .IP \f(CW\-f\fR 4
.IX Item "-f"
.PD
.Vb 1
\&  sqitch engine add pg \-\-plan\-file my.plan
.Ve
.Sp
Specifies the path to the deployment plan file. Defaults to
\&\f(CW\*(C`$top_dir/sqitch.plan\*(C'\fR.
.ie n .IP """\-\-extension""" 4
.el .IP \f(CW\-\-extension\fR 4
.IX Item "--extension"
.Vb 1
\&  sqitch engine add pg \-\-extension ddl
.Ve
.Sp
Specifies the file name extension to use for change script file names.
Defaults to \f(CW\*(C`sql\*(C'\fR.
.ie n .IP """\-\-dir""" 4
.el .IP \f(CW\-\-dir\fR 4
.IX Item "--dir"
.Vb 1
\&  sqitch engine add pg \-\-dir deploy=dep \-\-dir revert=rev \-\-dir verify=tst
.Ve
.Sp
Sets the path to a script directory. May be specified multiple times.
Supported keys are:
.RS 4
.IP \(bu 4
\&\f(CW\*(C`deploy\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`revert\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`verify\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`reworked\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`reworked_deploy\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`reworked_revert\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`reworked_verify\*(C'\fR
.RE
.RS 4
.RE
.ie n .IP """\-\-target""" 4
.el .IP \f(CW\-\-target\fR 4
.IX Item "--target"
.Vb 1
\&  sqitch engine add pg \-\-target db:pg:widgets
.Ve
.Sp
Specifies the name or URI <https://github.com/libwww-perl/uri-db/> of the target
database for the engine.
.ie n .IP """\-\-registry""" 4
.el .IP \f(CW\-\-registry\fR 4
.IX Item "--registry"
.Vb 1
\&  sqitch engine add pg \-\-registry meta
.Ve
.Sp
Specifies the name of the database object where Sqitch's state and history
data is stored. Typically a schema name (as in PostgreSQL and Oracle) or a
database name (as in SQLite and MySQL). Defaults to \f(CW\*(C`sqitch\*(C'\fR.
.ie n .IP """\-\-client""" 4
.el .IP \f(CW\-\-client\fR 4
.IX Item "--client"
.Vb 1
\&  sqitch engine add pg \-\-client /usr/local/pgsql/bin/psql
.Ve
.Sp
Specifies the path to the command-line client for the engine. Defaults to a
client in the current path named appropriately for the engine.
.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.
.RE
.RS 4
.RE
.SH Actions
.IX Header "Actions"
With no arguments, shows a list of existing engines. Several actions are
available to perform operations on the engines.
.ie n .SS """add"""
.el .SS \f(CWadd\fP
.IX Subsection "add"
Add an engine named \f(CW\*(C`<name>\*(C'\fR for the database at \f(CW\*(C`<uri>\*(C'\fR. The
\&\f(CW\*(C`\-\-set\*(C'\fR option specifies engine-specific properties. A new plan file and
new script script directories will be created if they don't already exist.
.ie n .SS """alter"""
.el .SS \f(CWalter\fP
.IX Subsection "alter"
Alter an engine named \f(CW\*(C`<name>\*(C'\fR. The \f(CW\*(C`\-\-set\*(C'\fR option specifies
engine-specific properties to set. New script script directories will be
created if they don't already exist.
.ie n .SS """remove"", ""rm"""
.el .SS "\f(CWremove\fP, \f(CWrm\fP"
.IX Subsection "remove, rm"
Remove the engine named \f(CW\*(C`<name>\*(C'\fR from the configuration. The plan file
and script directories will not be affected.
.ie n .SS """show"""
.el .SS \f(CWshow\fP
.IX Subsection "show"
Gives some information about the engine \f(CW\*(C`<name>\*(C'\fR, including the
associated properties. Specify multiple engine names to see information for
each.
.SH "Configuration Variables"
.IX Header "Configuration Variables"
The engines are stored in the configuration file, but the command itself
currently relies on no configuration variables.
.SH Sqitch
.IX Header "Sqitch"
Part of the sqitch suite.