Sqitch

sqitch-engine

Name

sqitch-engine - Manage database engine configuration

Synopsis

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>
sqitch engine update-config

Description

Manage the database engines you deploy to. The list of supported engines includes:

Each engine may have a number of properties:

Each of these overrides the corresponding core configuration – for example, the core.target, core.plan_file, core.registry, and core.client config options.

Options

Actions

With no arguments, shows a list of existing engines. Several actions are available to perform operations on the engines.

add

Add an engine named <name> for the database at <uri>. The --set option specifies engine-specific properties. A new plan file and new script script directories will be created if they don’t already exist.

alter

Alter an engine named <name>. The --set option specifies engine-specific properties to set. New script script directories will be created if they don’t already exist.

remove, rm

Remove the engine named <name> from the configuration. The plan file and script directories will not be affected.

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.

Configuration Variables

The engines are stored in the configuration file, but the command itself currently relies on no configuration variables.

Sqitch

Part of the sqitch suite.