view release on metacpan or  search on metacpan

lib/sqitch-config.pod  view on Meta::CPAN

=over

=item C<user.name>

Your full name, to be recorded in changes and tags added to the plan,
and to commits to the database.

=item C<user.email>

Your email address, to be recorded in changes and tags added to the plan, and
to commits to the database.

=back

=head3 C<engine.$engine>

Each supported engine offers a set of configuration variables, falling under
the key C<engine.$engine> where C<$engine> may be any value accepted for
C<core.engine>.

=over

=item C<engine.$engine.target>

A database target, either the name of target managed by the
L<C<target>|sqitch-target> command, or a database connection URI. If it's a
target name, then the associated C<uri>, C<registry>, and C<client> values
will override any values specified for the values below. Targets are the
preferred way to configure engines on a per-database basis, and the one
specified here should be considered the default.

=item C<engine.$engine.uri>

A database connection URI.

=item C<engine.$engine.registry>

The name of the Sqitch registry schema or database. Sqitch will store its own
data in this schema.

=item C<engine.$engine.client>

Path to the engine command-line client. Defaults to the first instance found
in the path.

=back

Notes on engine-specific configuration:

=over

=item C<engine.pg.registry>

For the PostgreSQL engine, the C<registry> value identifies the schema for
Sqitch to use for its own data. No other data should be stored there. Defaults
to C<sqitch>.

=item C<engine.sqlite.registry>

For the SQLite engine, if the C<registry> value looks like an absolute path,
then it will be the database file. Otherwise, it will be in the same directory
as the database specified by the C<uri>. Defaults to C<sqitch>.

=item C<engine.mysql.registry>

For the MySQL engine, the C<registry> value identifies the database for Sqitch
to use for its own data. If you need to manage multiple databases on a single
server, and don't want them all to share the same registry, change this
property to a value specific for your database. Defaults to C<sqitch>.

=item C<engine.oracle.registry>

For Oracle, C<registry> value identifies the schema for Sqitch to use for its
own data. No other data should be stored there. Uses the current schema by
default (usually the same name as the connection user).

=item C<engine.firebird.registry>

For the Firebird engine, if the C<registry> value looks like an absolute path,
then it will be the database file. Otherwise, it will be in the same directory
as the database specified by the C<uri>. Defaults to C<sqitch.$extension>,
where C<$extension> is the same as that in the C<uri>, if any.

=item C<engine.vertica.registry>

For the Vertica engine, the C<registry> value identifies the schema for Sqitch
to use for its own data. No other data should be stored there. Defaults to
C<sqitch>.

=item C<engine.exasol.registry>

For the Exasol engine, the C<registry> value identifies the schema for Sqitch
to use for its own data. No other data should be stored there. Defaults to
C<sqitch>.

=item C<engine.snowflake.registry>

For the Snowflake engine, the C<registry> value identifies the schema for
Sqitch to use for its own data. No other data should be stored there. Defaults
to C<sqitch>.

=item C<engine.clickhouse.registry>

For the ClickHouse engine, the C<registry> value identifies the database for
Sqitch to use for its own data. If you need to manage multiple databases on a
single server, and don't want them all to share the same registry, change this
property to a value specific for your database. Defaults to C<sqitch>.

=back

=head3 C<core.vcs>

Configuration properties for the version control system. Currently, only Git
is supported.

=over

=item C<core.vcs.client>

Path to the C<VCS> command-line client. Defaults to the first instance of
F<git> found in the path.

=back

=head3 C<user>

=over

=item C<user.email>

Your email address to be recorded in any newly planned changes.

=item C<user.name>

Your full name to be recorded in any newly planned changes.

=back

=head1 Sqitch