David E. Wheeler > App-Sqitch-0.951 > sqitch-init

Download:
App-Sqitch-0.951.tar.gz

Annotate this POD

Website

View/Report Bugs
Source   Latest Release: App-Sqitch-0.992

Name ^

sqitch-init - Create a new Sqitch project

Synopsis ^

  sqitch [options] init project
  sqitch [options] init --uri uri project

Description ^

This command creates an new Sqitch project -- basically a sqitch.conf file, a sqitch.plan file, and a sql directory with deploy, revert, and verify subdirectories.

Running sqitch init in an existing repository is safe. It will not overwrite things that are already there.

Options ^

--uri

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.

Configuration ^

The most important thing sqitch init does is create the project plan file, sqitch.conf. While the init command has no options of its own, it relies on several of the options to sqitch to determine what to write to this file:

--plan-file

Sets the core.plan_file configuration variable.

--top-dir

Determines the top-level directory to use when writing the plan and thecore.deploy_dir, core.revert_dir, and core.verify_dir variables -- unless they are overridden by their more-specific options, detailed below.

--deploy-dir

Sets the core.deploy_dir configuration variable.

--revert-dir

Sets the core.revert_dir configuration variable.

--verify-dir

Sets the core.verify_dir configuration variable.

--extension

Sets the core.extension configuration variable.

--engine

Sets the core.engine configuration variable.

As a general rule, you likely won't need any of them except for --engine, since your project can have only one engine at a time, 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, they 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.

Relatedly, the engine-specific sqitch options will also be used to write variables, as follows:

--db-client

Used to set core.pg.client, core.sqlite.client, or core.mysql.client.

--db-name

Used to set core.pg.db_name, core.sqlite.db_name, or core.mysql.db_name.

--db-user

Used to set core.pg.username, or core.mysql.username.

--db-host

Used to set core.pg.host, or core.mysql.host.

--db-port

Used to set core.pg.port, or core.mysql.port.

Again, if these are no specified, the engine-specific options will still be written out, but as comments with values either from user or system configuration, or default values.

Examples ^

Start a new Sqitch project using the SQLite engine, setting the default database file to /var/db/widgets.db

  sqitch --engine --db-name /var/db/widgets.db sqlite init

Start a new Sqitch project using the PostgreSQL engine, with the default database name "widgets", the default user name "postgres", and a version-specific client:

  sqitch --engine pg \
  --db-name   widgets \
  --db-user   postgres \
  --db-client /opt/pgsql-9.1/bin/psql init

Sqitch ^

Part of the sqitch suite.

syntax highlighting: