sqitch-engine - Manage database engine configuration
sqitch engine sqitch engine add <name> <target> [-s <property>=<value> ...] sqitch engine set-target <name> <target> sqitch engine set-registry <name> <registry> sqitch engine set-client <name> <client> sqitch engine set-top-dir <name> <directory> sqitch engine set-plan-file <name> <file> sqitch engine set-deploy-dir <name> <directory> sqitch engine set-revert-dir <name> <directory> sqitch engine set-verify-dir <name> <directory> sqitch engine set-extension <name> <extension> sqitch engine remove <name> sqitch engine show <name> sqitch engine update-config
Manage the the database engines you deploy to. The list of supported engines includes:
firebird
mysql
oracle
pg
sqlite
vertica
Each engine may have a number of properties:
target
The name or URI of the database target. The default is db:$engine. See sqitch-target for details on target configuration.
db:$engine
registry
The name of the registry schema or database. The default is sqitch.
sqitch
client
The command-line client to use. If not specified, each engine looks in the OS Path for an appropriate client.
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. The default is ., the current directory.
plan_file
The plan file to use for this engine. The default is $top_dir/sqitch.plan.
$top_dir/sqitch.plan
deploy_dir
The path to the deploy directory for the engine. This directory contains all of the deploy scripts referenced by changes in the plan_file. The default is $top_dir/deploy.
$top_dir/deploy
revert_dir
The path to the revert directory for the engine. This directory contains all of the revert scripts referenced by changes in the plan_file. The default is $top_dir/revert.
$top_dir/revert
verify_dir
The path to the verify directory for the engine. This directory contains all of the verify scripts referenced by changes in the plan_file. The default is $top_dir/verify.
$top_dir/verify
extension
The file name extension to append to change names to create script file names. The default is sql.
sql
Each of these overrides the corresponding core configuration -- for example, the core.target, core.plan_file, core.registry, and core.client config options.
core.target
core.plan_file
core.registry
core.client
-s
--set
sqitch engine add pg -s top_dir=pg -s client=/usr/local/pgsql/bin/psql
Set a engine property key/value pair. May be specified multiple times. Used only by the add action. Supported keys are:
add
With no arguments, shows a list of existing engines. Several actions are available to perform operations on the engines.
Add a engine named <name> for the database at <uri>. The --set option specifies engine-specific properties.
<name>
<uri>
set-target
Set the target for engine <name>.
set-registry
Set the registry for engine <name>.
set-client
Set the client for engine <name>.
set-top-dir
Set the top directory for engine <name>.
set-plan-file
Set the plan file for engine <name>.
set-deploy-dir
Set the deploy directory for engine <name>.
set-revert-dir
Set the revert directory for engine <name>.
set-verify-dir
Set the verify directory for engine <name>.
set-extension
Set the extension for engine <name>.
remove
rm
Remove the engine named <name>.
show
Gives some information about the engine <name>, including the associated properties. Specify multiple engine names to see information for each.
update-config
Update the configuration from a configuration file that predates the addition of the engine command to Sqitch.
engine
The engines are stored in the configuration file, but the command itself currently relies on no configuration variables.
Part of the sqitch suite.
To install App::Sqitch, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::Sqitch
CPAN shell
perl -MCPAN -e shell install App::Sqitch
For more information on module installation, please visit the detailed CPAN module installation guide.