David E. Wheeler > App-Sqitch > sqitch-target

Download:
App-Sqitch-0.996.tar.gz

Annotate this POD

Website

View/Report Bugs
Source  

Name ^

sqitch-target - Mange set of target databases

Synopsis ^

  sqitch target [-v | --verbose]
  sqitch target add [-r <registry>] [-c <client>] <name> <uri>
  sqitch target set-uri <name> <newuri>
  sqitch target set-registry <name> <newregistry>
  sqitch target set-client <name> <newclient>
  sqitch target remove <name>
  sqitch target rename <old> <new>
  sqitch target show <name>

Description ^

Manage the set of databases ("targets") you deploy to. Each target has three attributes:

uri

The database connection URI for the target. Required. Its format is:

  db:engine:[dbname]
  db:engine:[//[user[:password]@][host][:port]/][dbname][?params][#fragment]

Some examples:

db:sqlite:widgets.db
db:pg://dba@example.net/blanket
db:mysql://db.example.com/
db:firebird://localhost//tmp/test.fdb

See the DB URI Draft for details.

registry

The name of the registry schema or database. The default is sqitch.

client

The command-line client to use. If not specified, each engine looks in the OS Path for an appropriate client.

Each of these overrides the corresponding engine-specific configuration -- that is, the core.$engine.uri, core.$engine.registry, and core.$engine.client config options.

Options ^

-v
--verbose

Be a little more verbose and show remote URI after name.

-r
--registry
--set-registry

Set the registry for the target. Used only by the add action.

-r
--client
--set-client

Set the client for the target. Used only by the add action.

Actions ^

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

add

Add a target named <name> for the database at <uri>. The --registry option specifies the Sqitch registry schema or database to use. The --client option specifies the command-line client to use for deployment scripts.

set-uri

Set the URI for target <name>.

set-registry

Set the registry for target <name>.

set-client

Set the client for target <name>.

remove, rm

Remove the target named <name>.

rename

Rename the remote named <old> to <new>.

show

Gives some information about the remote <name>, including the associated URI, registry, and client. Specify multiple target names to see information for each.

Configuration Variables ^

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

Sqitch ^

Part of the sqitch suite.

syntax highlighting: