- Configuration File
sqitch-config - Get and set local, user, or system Sqitch options
sqitch config [<file-option>] [type] name [value [value_regex]] sqitch config [<file-option>] [type] --add name value sqitch config [<file-option>] [type] --replace-all name value [value_regex] sqitch config [<file-option>] [type] --get name [value_regex] sqitch config [<file-option>] [type] --get-all name [value_regex] sqitch config [<file-option>] [type] --get-regexp name_regex [value_regex] sqitch config [<file-option>] --unset name [value_regex] sqitch config [<file-option>] --unset-all name [value_regex] sqitch config [<file-option>] --rename-section old_name new_name sqitch config [<file-option>] --remove-section name sqitch config [<file-option>] -l | --list sqitch config [<file-option>] -e | --edit
You can query/set/replace/unset Sqitch options with this command. The name is actually the section and the key separated by a dot, and the value will be escaped.
Multiple lines can be added to an option by using the
--add option. If you want to update or unset an option which can occur on multiple lines, a Perl regular expression
value_regex needs to be given. Only the existing values that match the regex will be updated or unset. If you want to handle lines that do not match the regex, just prepend a single
! (exclamation point) in front (see Examples).
type specifier can be
--bool, to ensure that the variable(s) are of the given type and convert the value to the canonical form (simple integer for
--int, decimal number for
--num, a "true" or "false" string for
--bool) If no type specifier is passed, no checks or transformations are performed on the value.
file-option can be one of
--file, which specify where the values will be read from or written to. The default is to assume the local config file in the current project directory, for editing, and the all files merged for fetching (see Files).
On success, the command returns the exit code 0.
The default behavior is to replace at most one line. This replaces all lines matching the key (and optionally the
Adds a new line to the option without altering any existing values. This is the same as providing
^$as the value_regex in
Get the value for a given key (optionally filtered by a regex matching the value). Returns error code 1 if the key was not found and error code 2 if multiple values were found.
--get, but does not fail if the number of values for the key is not exactly one.
--get-all, but interprets the name as a regular expression and writes out the key names and value.
For writing options: write to the local ./sqitch.conf file. This is the default if no file option is specified.
For reading options: read only from the local ./sqitch.conf file rather than from all available files.
See also Files.
For writing options: write to the user ~/.sqitch/sqitch.conf file rather than the repository ./sqitch.conf.
For reading options: read only from the user ~/.sqitch/sqitch.conf file rather than from all available files.
See also Files.
For writing options: write to system-wide $(etc_path)/sqitch.conf file rather than the repository ./sqitch.conf.
For reading options: read only from system-wide $($etc_prefix)/sqitch.conf file rather than from all available files.
See also Files.
-f config-file, --file config-file
Use the given config file instead of the one specified by
Remove the given section from the configuration file.
Rename the given section to a new name.
Remove the line matching the key from config file.
Remove all lines matching the key from config file.
List all variables set in config file.
sqitch configwill ensure that the output is "true" or "false".
sqitch configwill ensure that the output is a simple integer.
sqitch configwill ensure that the output is a simple decimal number.
sqitch configwill ensure that the output matches the format of either
--int, as described above.
Opens an editor to modify the specified config file; either
--file. If none of those options is specified, the local file will be opened.
If not set explicitly with
--file, there are three files in which
sqitch config will search for configuration options:
Local, project-specific configuration file.
User-specific configuration file.
System-wide configuration file.
Take the local configuration from the given file instead of
Take the user configuration from the given file instead of
Take the system configuration from the given file instead of
Given a ./sqitch.conf like this:
# # This is the config file, and # a '#' or ';' character indicates # a comment # ; core variables [core] ; Use PostgreSQL engine = pg ; Bundle command settings. [bundle] from = gamma tags_only = false dest_dir = _build/sql ; Revert command settings [core "pg"] set = foo=bar set = baz=yo
You can set the the
tags_only setting to true with
% sqitch config bundle.tags_only true
set key in the
core.pg section might need to set
foo to "hi" instead of "bar". Here's how to make that change:
% sqitch config core.pg.set foo=bar foo=hi
To delete the entry for
% sqitch config --unset bundle.from
If you want to delete an entry for a multivalue setting (like
core.pg.set), provide a regex matching the value of exactly one line.
To query the value for a given key, do:
% sqitch config --get core.engine
% sqitch config core.engine
Or, to query a multivalue setting for only those values that match
% sqitch config --get core.pg.set ba
If you want to know all the values for a multivalue setting, do:
% sqitch config --get-all core.pg.set
If you like to live dangerously, you can replace all
core.pg.set with a new one with
% sqitch config --replace-all core.pg.set bring=funk
However, if you only want to replace the line without
baz, do something like this:
% sqitch config core.pg.set = '!baz'
To match only values with an exclamation mark, you have to escape them:
% sqitch config section.key value '[!]'
To add a new setting without altering any of the existing ones, use:
% sqitch config core.pg.set widget=fred
The sqitch configuration file contains a number of variables that affect the sqitch command's behavior. The ./sqitch.conf file local to each project is used to store the configuration for that project, and $HOME/.sqitch/sqitch.conf is used to store a per-user configuration as fallback values for the ./sqitch.conf file. The file $($etc_prefix)/sqitch.conf can be used to store a system-wide default configuration.
The variables are divided into sections, wherein the fully qualified variable name of the variable itself is the last dot-separated segment and the section name is everything before the last dot. The variable names are case-insensitive, allow only alphanumeric characters and -, and must start with an alphabetic character. Some variables may appear multiple times.
The syntax is fairly flexible and permissive; white space is mostly ignored. The
; characters begin comments to the end of line, blank lines are ignored.
The file consists of sections and variables. A section begins with the name of the section in square brackets and continues until the next section begins. Section names are not case sensitive. Only alphanumeric characters,
. are allowed in section names. Each variable must belong to some section, which means that there must be a section header before the first setting of a variable.
Sections can be further divided into subsections. To begin a subsection put its name in double quotes, separated by space from the section name, in the section header, like in the example below:
Subsection names are case sensitive and can contain any characters except newline (double quote and backslash have to be escaped as
\\, respectively). Section headers cannot span multiple lines. Variables may belong directly to a section or to a given subsection. You can have
[section] if you have
[section "subsection"], but you don't need to.
All the other lines (and the remainder of the line after the section header) are recognized as setting variables, in the form
name = value. If there is no equal sign on the line, the entire line is taken as name and the variable is recognized as boolean
true. The variable names are case-insensitive, allow only alphanumeric characters and
-, and must start with an alphabetic character. There can be more than one value for a given variable; we say then that the variable is multivalued.
Leading and trailing whitespace in a variable value is discarded. Internal whitespace within a variable value is retained verbatim.
The values following the equals sign in variable assignments are either strings, integers, numbers, or booleans. Boolean values may be given as yes/no, 1/0, true/false or on/off. Case is not significant in boolean values, when converting value to the canonical form using the
--bool type specifier;
sqitch config will ensure that the output is "true" or "false".
String values may be entirely or partially enclosed in double quotes. You need to enclose variable values in double quotes if you want to preserve leading or trailing whitespace, or if the variable value contains comment characters (i.e. it contains
;). Double quote and backslash characters in variable values must be escaped: use
The following escape sequences (beside
\\) are recognized:
\n for newline character (NL),
\t for horizontal tabulation (HT, TAB) and
\b for backspace (BS). No other character escape sequence or octal character sequence is valid.
Variable values ending in a
\ are continued on the next line in the customary UNIX fashion.
Some variables may require a special value format.
# Core variables [core] engine = pg top_dir = migrations extension = ddl [core "pg"] db_name = widgetopolis [revert] to = gamma [bundle] from = gamma tags_only = yes dest_dir = _build/sql
Note that this list is not comprehensive and not necessarily complete. For command-specific variables, you will find a more detailed description in the appropriate manual page.
The plan file to use. Defaults to $top_dir/sqitch.plan.
The database engine to use. Supported engines include:
Path to directory containing deploy, revert, and verify SQL scripts. It should contain subdirectories named
revert, and (optionally)
verify. These may be overridden by
verify_dir. Defaults to
Path to a directory containing SQL deployment scripts. Overrides the value implied by
Path to a directory containing SQL reversion scripts. Overrides the value implied by
Path to a directory containing SQL verify scripts. Overrides the value implied by
The file name extension on deploy, revert, and verify SQL scripts. Defaults to
An integer determining how verbose Sqitch should be. Defaults to 1. Set to 0 to silence status messages and to 2 or three to increase verbosity. Error message output will not be affected by this property.
Configuration properties that identify the user.
Your full name, to be recorded in changes and tags added to the plan, and to to commits to the database.
Your email address, to be recorded in changes and tags added to the plan, and to to commits to the database.
Configuration properties for the PostgreSQL engine.
Path to the
psqlcommand-line client. Defaults to the first instance found in the path.
User name to use when connecting to the PostgreSQL database. Defaults to the contents of the
$PGUSERenvironment variable or to the current system user name.
Password to use when connecting to the PostgreSQL database. Defaults to the contents of the
$PGPASSWORDenvironment variable or to the relevant line in ~/.pgpass, if available.
Name of the PostgreSQL database. Defaults to the same as
--db-useror to the contents of the
Host name to use when connecting to the database. Defaults to the contents of the
Port number to connect to. Does not apply to all engines. Defaults to the contents of the
The name of the schema in which Sqitch metadata will be stored. No other data should be stored in this schema. Defaults to
Configuration properties for the MySQL engine. All except
client can also be set via the MySQL options file
Path to the
mysqlcommand-line client. Defaults to the first instance found in the path.
User name to use when connecting to the MySQL database.
Password to use when connecting to the MySQL database.
Name of the MySQL database.
Host name to use when connecting to the database.
Port number to connect to. Does not apply to all engines.
Prefix to use for Sqitch metadata tables. Defaults to
Configuration properties for the SQLite engine.
Path to the
sqlite3command-line client. Defaults to the first instance found in the path.
Path to the SQLite database file.
Path to the file to use for the Sqitch database. This is where Sqitch will store all of its metadata. If you manage multiple databases with Sqitch, each should have its own corresponding Sqitch database. If you want the Sqitch metadata to be stored in the same file as the database it builds, make this value the same as
core.sqlite.db_name. Defaults to sqitch.db in the same directory as
Your email address to be recorded in any newly planned changes.
Your full name to be recorded in any newly planned changes.
Part of the sqitch suite.