sqitch-init - Create a new Sqitch project
sqitch init <project> sqitch init <project> --uri <uri>
This command creates an new Sqitch project -- basically a sqitch.conf file, a sqitch.plan file, and deploy, revert, and verify subdirectories.
Running sqitch init in an existing project is safe. It will not overwrite things that are already there.
sqitch init widgets --uri https://github.com/me/wigets
Optional URI to associate with the project. If present, the URI will be written to the project plan and used for added uniqueness in hashed object IDs.
sqitch init widgets --engine pg
Specifies the default database engine to use in the project. Supported engines include:
sqitch init widgets --top-dir sql
Specifies the top directory to use for the project. Typically contains the deployment plan file and the change script directories.
sqitch init widgets --plan-file my.plan
Specifies the path to the deployment plan file. Defaults to
sqitch init widgets --extension ddl
Specifies the file name extension to use for change script file names. Defaults to
sqitch init widgets --dir deploy=dep --dir revert=rev --dir verify=tst
Sets the path to a script directory. May be specified multiple times. Supported keys are:
sqitch init widgets --target db:pg:widgets
Specifies the name or URI of the default target database. If specified as a name, the default URI for the target will be
sqitch init widgets --registry meta
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
sqitch init widgets --client /usr/local/pgsql/bin/psql
Specifies the path to the command-line client for the database engine. Defaults to a client in the current path named appropriately for the specified engine.
The most important thing
sqitch init does is create the project plan file, sqitch.conf. The options determine what gets written to the file:
Sets the following configuration variables:
engine.$engine.targetconfiguration variable if
--engineis also passed and, if it's a target name,
engine.$engine.registryconfiguration variable if
--engineis also passed.
engine.$engine.clientconfiguration variable if
--engineis also passed.
As a general rule, you likely won't need any of these options except for
--engine, since many commands need to know what engine to use, and specifying it on the command-line forever after would be annoying.
These variables will only be written if their corresponding options are specified. Otherwise, core options get written as comments with user or system configuration settings, or, failing any values from those locations, from their default values. If no defaults are specified, they will still be written, commented out, with a bar
= and no value. This allows one to know what sorts of things are available to edit.
Start a new Sqitch project using the SQLite engine, setting the top directory for the project to sqlite:
sqitch init --engine sqlite --top-dir sqlite
Start a new Sqitch project using the PostgreSQL engine, setting the top directory to postgres, script extension to
ddl, reworked directory to
reworked and a version-specific client:
sqitch init --engine pg \ --top-dir postgres \ --client /opt/pgsql-9.1/bin/psql \ --extension ddl --dir reworked=reworked
Describes how Sqitch hierarchical engine and target configuration works.
Command to manage database engine configuration.
Command to manage target database configuration.
Command to manage all Sqitch configuration.
Part of the sqitch suite.