Sqitch

https://sqitch.org/docs
Admin
Sqitch is a database change management application that uses native SQL scripts and dependency...
Tokens:85,959
Snippets:1,187
Trust Score:9.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example sqitch.conf configuration

Source: https://sqitch.org/docs/manual/sqitch-config

A comprehensive example showing core variables, engine-specific settings, and bundle configurations.

```ini
# Core variables
[core]
    engine    = pg
    top_dir   = migrations
    extension = ddl

[engine "pg"]
    registry  = widgetopolis

[revert]
    to        = gamma

[bundle]
    from      = gamma
    tags_only = yes
    dest_dir  = _build/sql
```

--------------------------------

### Display Sqitch help and guides

Source: https://sqitch.org/docs/manual/sqitch-help

Use these commands to view the general help synopsis or list available documentation guides.

```bash
sqitch help [COMMAND]
sqitch help --guide
```

--------------------------------

### Deploy to Database Engines

Source: https://sqitch.org/docs/manual/sqitch-configuration

Examples of deploying to specific engines or using database URIs.

```bash
sqitch deploy pg
```

```bash
sqitch deploy db:pg://db.example.com/widgets
```

```bash
sqitch log db:sqlite:/var/db/widgets.db
```

--------------------------------

### Example sqitch.conf file structure

Source: https://sqitch.org/docs/manual/sqitch-config

A sample configuration file demonstrating section headers, comments, and key-value pairs.

```ini
#
# 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

; Fuzzle command settings
[core "fuzzle"]
        clack        = foo
        clack        = bar
        clack        = barzlewidth
```

--------------------------------

### Starting a New Exasol Instance

Source: https://sqitch.org/docs/manual/sqitchtutorial-exasol

Launch a new Exasol database container for testing the deployment bundle.

```bash
> docker run --detach --privileged --stop-timeout 120 -p 127.0.0.1:9999:8888  exasol/docker-db:latest
```

--------------------------------

### sqitch-add command usage examples

Source: https://sqitch.org/docs/manual/sqitch-add

Common command-line patterns for adding changes to Sqitch plans.

```bash
sqitch add widgets [options
sqitch add blankets --all
sqitch add --change sprockets pg sql
sqitch add slinkies --require sprockets --set schema=industry
```

--------------------------------

### Start Exasol Docker Container

Source: https://sqitch.org/docs/manual/sqitchtutorial-exasol

Command to launch an Exasol database instance using Docker.

```bash
> docker run --detach --privileged --stop-timeout 120 -p 127.0.0.1:8563:8888  exasol/docker-db:latest
```

--------------------------------

### Custom format example

Source: https://sqitch.org/docs/manual/sqitch-plan

Example of using the printf-style custom format string.

```text
format:The planner of %h was %{name}p%vThe title was >>%s<<%v

```

--------------------------------

### Sqitch Status Output Example

Source: https://sqitch.org/docs/manual/sqitchtutorial

Displays the status of a project deployment, indicating that the database is up-to-date.

```text
# On database flipr_test
# Project:  flipr
# Change:   d3ffa30b72abaf9619ae1f0e726026667612f2b1
# Name:     change_pass
# Deployed: 2013-12-30 17:05:08 -0800
# By:       Marge N. O’Vera <marge@example.com>
# 
Nothing to deploy (up-to-date)
```

--------------------------------

### Show Change Information

Source: https://sqitch.org/docs/manual/sqitch-show

Examples of retrieving information about changes using names, IDs, or references.

```bash
sqitch show change add_users_table
```

```bash
sqitch show change be7cd00571d7151eacb0691e825dfc8980cc14ff
```

```bash
sqitch show change @HEAD
```

--------------------------------

### Custom format output example

Source: https://sqitch.org/docs/manual/sqitch-plan

Example output generated by the custom format string.

```text
The planner of f26a3s was Tom Lane
The title was >>We really need to get this right.<<

```

--------------------------------

### Exasol EXAplus and ODBC configuration

Source: https://sqitch.org/docs/manual/sqitch-authentication

Examples for configuring EXAplus profiles and ODBC connection settings for Exasol.

```bash
> exaplus -u sys -p exasol -c localhost:8563 -wp flipr_test
EXAplus 6.0.4 (c) EXASOL AG

Profile flipr_test is saved.
> exaplus -profile flipr_test -q -sql "select current_timestamp;"

CURRENT_TIMESTAMP
--------------------------
2017-11-02 13:35:48.360000

```

```ini
[flipr_test]
DRIVER = Exasol
EXAHOST = localhost:8563
EXAUID = sys
EXAPWD = exasol
AUTHMETHOD = refreshtoken

```

```bash
> sqitch status db:exasol:flipr_test
# On database db:exasol:flipr_test
# Project:  flipr
# ...
#
Nothing to deploy (up-to-date)
> sqitch rebase --onto '@HEAD^' -y db:exasol:flipr_test
Reverting changes to hashtags @v1.0.0-dev2 from db:exasol:flipr_test
  - userflips .. ok
Deploying changes to db:exasol:flipr_test
  + userflips .. ok

```

--------------------------------

### User-level ~/.sqitch/sqitch.conf configuration

Source: https://sqitch.org/docs/manual/sqitch

Example configuration for user identity and system-specific engine client paths.

```ini
[user]
    name      = Marge N. O’Vera
    email     = marge@example.com

[engine "pg"]
    client    = /usr/local/pgsql/bin/psql

[engine "mysql"]
    client    = /usr/local/mysql/bin/mysql

[engine "oracle"]
    client    = /usr/local/instantclient_11_2/sqlplus

[engine "sqlite"]
    client    = /usr/local/bin/sqlite3
```

--------------------------------

### Custom Format Example

Source: https://sqitch.org/docs/manual/sqitch-log

Demonstrates the use of the format:<string> option to define a custom output structure.

```text
format:The committer of %h was %{name}c%vThe title was >>%s<<%v

```

```text
The committer of f26a3s was Tom Lane
The title was >>We really need to get this right.<<

```

--------------------------------

### Example Template Directory Structure

Source: https://sqitch.org/docs/manual/sqitch-add

A sample layout showing how templates are organized by script type and engine.

```text
templates/deploy/pg.tmpl
templates/deploy/create_table.tmpl
templates/revert/pg.tmpl
templates/revert/create_table.tmpl
templates/test/pg.tmpl
templates/verify/pg.tmpl
templates/verify/create_table.tmpl
```

--------------------------------

### Configure Snowflake connection URI

Source: https://sqitch.org/docs/manual/sqitchtutorial-snowflake

Examples of Snowflake database connection strings for Sqitch.

```text
db:snowflake://movera@example/flipr?Driver=Snowflake;warehouse=sqitch
```

```text
db:snowflake://movera@example/flipr?Driver=Snowflake;warehouse=%22sqitch.dev%22&role=%22app.sqitch%22
```

--------------------------------

### Project-level sqitch.conf configuration

Source: https://sqitch.org/docs/manual/sqitch

Example configuration for a project using PostgreSQL, custom directory structures, and specific deployment targets.

```ini
[core]
    engine    = pg
    top_dir   = migrations
    extension = ddl

[engine "pg"]
    target    = widgetopolis

[revert]
    to        = gamma

[bundle]
    from      = gamma
    tags_only = yes
    dest_dir  = _build/sql

[target "widgetopolis"]
    uri       = db:pg:widgetopolis
```

--------------------------------

### Run Oracle-XE Docker Container

Source: https://sqitch.org/docs/manual/sqitchtutorial-oracle

Start an Oracle-XE instance using Docker for testing purposes.

```bash
docker run -d -p 1521:1521 \
  -e ORACLE_PASSWORD=oracle \
  -e APP_USER=scott \
  -e APP_USER_PASSWORD=tiger \
  gvenzl/oracle-xe:18-slim
```

--------------------------------

### Configure Exasol ODBC Driver

Source: https://sqitch.org/docs/manual/sqitchtutorial-exasol

Example entry for the odbcinst.ini file to register the Exasol ODBC driver.

```ini
[Exasol]
Description = ODBC for Exasol
Driver      = /opt/EXASOL_ODBC-6.0.4/lib/linux/x86_64/libexaodbc-uo2214lv2.so
```

--------------------------------

### URL encoded username example

Source: https://sqitch.org/docs/manual/sqitch-target

Example of a database URI with a percent-encoded username.

```text
db:pg://ro%7Cmichelle@examle.org/inventory
```

--------------------------------

### Initialize with custom plan file

Source: https://sqitch.org/docs/manual/sqitch-init

Sets a custom path for the deployment plan file.

```bash
sqitch init widgets --plan-file my.plan
```

--------------------------------

### Manual pgcrypto Installation

Source: https://sqitch.org/docs/manual/sqitchtutorial

Install pgcrypto manually for PostgreSQL versions 9.0 or lower.

```bash
psql -d flipr_test -f /path/to/pgsql/share/contrib/pgcrypto.sql
```

--------------------------------

### Install DBD::Oracle

Source: https://sqitch.org/docs/manual/sqitchtutorial-oracle

Install the required Perl module for Oracle database connectivity.

```bash
cpanm DBD::Oracle
```

--------------------------------

### Initialize Sqitch Project

Source: https://sqitch.org/docs/manual/sqitchtutorial-exasol

Initialize Sqitch with the Exasol engine and a project URI.

```bash
> sqitch init flipr --uri https://github.com/sqitchers/sqitch-exasol-intro/ --engine exasol
Created sqitch.conf
Created sqitch.plan
Created deploy/
Created revert/
Created verify/
```

--------------------------------

### URL encoded query parameters example

Source: https://sqitch.org/docs/manual/sqitch-target

Example of a database URI with encoded special characters in query parameters.

```text
db:snowflake://example/flipr?Driver=Snowflake;warehouse=%22sqitch.dev%22
```

--------------------------------

### Initialize with custom client path

Source: https://sqitch.org/docs/manual/sqitch-init

Sets the path to the database engine's command-line client.

```bash
sqitch init widgets --client /usr/local/pgsql/bin/psql
```

--------------------------------

### Bundling the Project

Source: https://sqitch.org/docs/manual/sqitchtutorial-exasol

Create a bundle directory containing the project configuration, plan, and scripts.

```bash
> sqitch bundle
Bundling into bundle
Writing config
Writing plan
Writing scripts
  + appschema
  + users
  + flips
  + userflips @v1.0.0-dev1
```

--------------------------------

### Initialize with custom directories

Source: https://sqitch.org/docs/manual/sqitch-init

Configures custom paths for deployment, revert, and verify scripts.

```bash
sqitch init widgets --dir deploy=dep --dir revert=rev --dir verify=tst
```

--------------------------------

### Oracle Error Examples

Source: https://sqitch.org/docs/manual/sqitchtutorial-oracle

Common Oracle connection errors.

```text
ORA-01017: invalid username/password; logon denied ORA-21561: OID
generation failed
```

--------------------------------

### Deploy from Bundle

Source: https://sqitch.org/docs/manual/sqitchtutorial-mysql

Create a new database and deploy the bundled Sqitch project.

```bash
> cd bundle
> mysql -u root --execute 'CREATE DATABASE flipr_dev'
> sqitch deploy db:mysql://root@/flipr_dev
Deploying changes to db:mysql://root@/flipr_dev
  + appuser ................... ok
  + users ..................... ok
  + insert_user ............... ok
  + change_pass @v1.0.0-dev1 .. ok
```

--------------------------------

### Test verification failure

Source: https://sqitch.org/docs/manual/sqitchtutorial-vertica

Examples of how to trigger verification errors to test the script.

```sql
CREATE TABLE nonesuch.verify__ (id int);
```

```sql
SELECT 1/COUNT(*) FROM v_catalog.schemata WHERE schema_name = 'nonesuch';
```

--------------------------------

### Initialize with database engine

Source: https://sqitch.org/docs/manual/sqitch-init

Sets the default database engine for the project.

```bash
sqitch init widgets --engine pg
```

--------------------------------

### Initialize a new engine directory

Source: https://sqitch.org/docs/manual/sqitch-configuration

Create a new engine-specific directory and initialize it as a Sqitch project.

```bash
> sqitch engine add sqlite --top-dir sqlite
Created sqlite/
Created sqlite/sqitch.plan
Created sqlite/deploy/
Created sqlite/revert/
Created sqlite/verify/
```

--------------------------------

### Initialize a PostgreSQL Sqitch project with custom configuration

Source: https://sqitch.org/docs/manual/sqitch-init

Creates a new project named 'bey' using the PostgreSQL engine with specific directory, extension, and client path configurations.

```bash
sqitch init --engine  pg \
            --top-dir postgres \
            --client  /opt/pgsql-9.1/bin/psql \
            --extension ddl --dir reworked=reworked \
            bey
```

--------------------------------

### Invalid verify script example

Source: https://sqitch.org/docs/manual/sqitchtutorial-exasol

A test case for the verify script using a non-existent schema.

```sql
CREATE TABLE nonesuch.verify__ (id int);
```

--------------------------------

### Display Help

Source: https://sqitch.org/docs/manual/sqitch

Shows a list of all known Sqitch commands.

```bash
sqitch --help
```

--------------------------------

### Display Manual

Source: https://sqitch.org/docs/manual/sqitch

Outputs the full documentation for the tool.

```bash
sqitch --man
```

--------------------------------

### Exasol OpenID Authentication URI

Source: https://sqitch.org/docs/manual/sqitch-authentication

Example URI for connecting to Exasol using OpenID authentication.

```text
db:exasol://sys:exasol@localhost:8563/?Driver=Exasol&AUTHMETHOD=refreshtoken
```

--------------------------------

### Initialize Sqitch Project

Source: https://sqitch.org/docs/manual/sqitchtutorial-firebird

Initializes a new Sqitch project with a specific URI and engine.

```bash
> sqitch init flipr --uri https://github.com/sqitchers/sqitch-firebird-intro/ --engine firebird
Created sqitch.conf
Created sqitch.plan
Created deploy/
Created revert/
Created verify/
```

--------------------------------

### View the generated sqitch.conf file

Source: https://sqitch.org/docs/manual/sqitch-configuration

Displays the contents of the default configuration file created during project initialization.

```bash
> cat sqitch.conf
[core]
  engine = pg
  # plan_file = sqitch.plan
  # top_dir = .
# [engine "pg"]
  # target = db:pg:
  # registry = sqitch
  # client = psql
```

--------------------------------

### Verify schema existence via division by zero failure

Source: https://sqitch.org/docs/manual/sqitchtutorial-snowflake

Example of a failing division-by-zero verification script.

```sql
USE WAREHOUSE &warehouse;
SELECT 1/COUNT(*) FROM information_schema.schemata WHERE schema_name = 'NONESUCH';
```

--------------------------------

### Initialize a new Sqitch project

Source: https://sqitch.org/docs/manual/sqitch-init

Basic usage to initialize a project with or without a URI.

```bash
sqitch init <project>
sqitch init <project> --uri <uri>
```

--------------------------------

### Create temporary table in non-existent schema

Source: https://sqitch.org/docs/manual/sqitchtutorial-snowflake

Example of a failing verify script targeting a non-existent schema.

```sql
CREATE TEMPORARY TABLE nonesuch.verify__ (id INT);
```

--------------------------------

### Print Configuration Path

Source: https://sqitch.org/docs/manual/sqitch

Outputs the path to the system-wide configuration directory.

```bash
sqitch --etc-path
```

--------------------------------

### View sqitch.plan

Source: https://sqitch.org/docs/manual/sqitchtutorial-firebird

Displays the contents of the project plan file.

```bash
> cat sqitch.plan
%syntax-version=1.0.0
%project=flipr
%uri=https://github.com/sqitchers/sqitch-firebird-intro/
```

--------------------------------

### Verify schema failure test

Source: https://sqitch.org/docs/manual/sqitchtutorial

Example of a failing verify script using a non-existent schema name.

```sql
SELECT pg_catalog.has_schema_privilege('nonesuch', 'usage');
```

--------------------------------

### Define Exasol Database Connection

Source: https://sqitch.org/docs/manual/sqitchtutorial-exasol

Example entry for the .odbc.ini file to define a connection named flipr_test.

```ini
[flipr_test]
Driver = Exasol
EXAHOST = 127.0.0.1:8563
EXAUID = sys
EXAPWD = exasol
```

--------------------------------

### Initialize with top directory

Source: https://sqitch.org/docs/manual/sqitch-init

Specifies the top-level directory for the project's plan and scripts.

```bash
sqitch init widgets --top-dir sql
```

--------------------------------

### Deploy and verify changes

Source: https://sqitch.org/docs/manual/sqitchtutorial-exasol

Execute the deployment and check the database state using exaplus.

```bash
> sqitch deploy
Deploying changes to flipr_test
  + flips ...... ok
  + userflips .. ok
```

```bash
> exaplus -q -u sys -p exasol -c localhost:8563 -sql "select table_name from exa_all_tables where table_schema = 'FLIPR';"

TABLE_NAME
--------------------------------------------------------------------------------------------------------------------------------
USERS
FLIPS

> exaplus -q -u sys -p exasol -c localhost:8563 -sql "describe flipr.userflips;"

COLUMN_NAME                                                                                                                      SQL_TYPE                                 NULLABLE DISTRIBUTION_KEY
-------------------------------------------------------------------------------------------------------------------------------- ---------------------------------------- -------- ----------------
ID                                                                                                                               DECIMAL(18,0)
NICKNAME                                                                                                                         VARCHAR(64) UTF8
FULLNAME                                                                                                                         VARCHAR(256) UTF8
BODY                                                                                                                             VARCHAR(180) UTF8
TS                                                                                                                               TIMESTAMP WITH LOCAL TIME ZONE
```

--------------------------------

### Basic sqitch-deploy Usage

Source: https://sqitch.org/docs/manual/sqitch-deploy

Standard command patterns for deploying database changes.

```bash
sqitch deploy [options] [<database>]
sqitch deploy [options] [<database>] <change>
sqitch deploy [options] [<database>] --to-change <change>
```

--------------------------------

### Deploying the Bundle

Source: https://sqitch.org/docs/manual/sqitchtutorial-exasol

Deploy the bundled project to the new Exasol database instance.

```bash
> cd bundle
> sqitch deploy 'db:exasol://sys:exasol@localhost:9999/?Driver=Exasol'
Adding registry tables to db:exasol://sys:@localhost:9999/?Driver=Exasol
Deploying changes to db:exasol://sys:@localhost:9999/?Driver=Exasol
  + appschema ............... ok
  + users ................... ok
  + flips ................... ok
  + userflips @v1.0.0-dev1 .. ok
```

--------------------------------

### Initialize with custom file extension

Source: https://sqitch.org/docs/manual/sqitch-init

Sets the file extension for change scripts.

```bash
sqitch init widgets --extension ddl
```

--------------------------------

### Invalid verify script example

Source: https://sqitch.org/docs/manual/sqitchtutorial-clickhouse

A modified verify script targeting a non-existent table to demonstrate error handling.

```sql
SELECT nickname, password, fullname, mastodon, created_at
  FROM users_nonesuch
 WHERE false;
```

--------------------------------

### Initialize Sqitch Project

Source: https://sqitch.org/docs/manual/sqitchtutorial-oracle

Output generated when initializing a new Sqitch project.

```text
Created sqitch.conf
Created sqitch.plan
Created deploy/
Created revert/
Created verify/
```

--------------------------------

### Configure ClickHouse ODBC Driver

Source: https://sqitch.org/docs/manual/sqitchtutorial-clickhouse

Example entry for the odbcinst.ini file to register the ClickHouse Unicode ODBC driver.

```ini
[ClickHouse]
Description = Unicode ODBC Driver for ClickHouse
Driver      = /opt/clickhouse/lib/libclickhouseodbcw.so
```

--------------------------------

### Tag and bundle the release

Source: https://sqitch.org/docs/manual/sqitchtutorial-firebird

Tag the database version and create a deployment bundle in a specific directory.

```bash
> sqitch tag v1.0.0-dev2 -n 'Tag v1.0.0-dev2.'
Tagged "hashtags" with @v1.0.0-dev2
> git commit -am 'Tag the database with v1.0.0-dev2.'
[main 7d07ee3] Tag the database with v1.0.0-dev2.
 1 file changed, 1 insertion(+)
> git tag v1.0.0-dev2 -am 'Tag v1.0.0-dev2'
> sqitch bundle --dest-dir flipr-1.0.0-dev2
Bundling into flipr-1.0.0-dev2
Writing config
Writing plan
Writing scripts
  + users
  + flips
  + userflips @v1.0.0-dev1
  + lists
  + hashtags @v1.0.0-dev2
```

--------------------------------

### Initialize Git Repository

Source: https://sqitch.org/docs/manual/sqitchtutorial-firebird

Creates a new directory and initializes a Git repository for the project.

```bash
> mkdir flipr
> cd flipr
> git init .
Initialized empty Git repository in /flipr/.git/
> touch README.md
> git add .
> git commit -am 'Initialize project, add README.'
[main (root-commit) 761ffcd] Initialize project, add README.
 1 files changed, 39 insertions(+), 0 deletions(-)
 create mode 100644 README.md
```

--------------------------------

### Modify deployment script for view update

Source: https://sqitch.org/docs/manual/sqitchtutorial-vertica

Example diff showing the addition of a column to a view within a deployment script.

```diff
@@ -4,8 +4,9 @@
 
 BEGIN;
 
@@ -4,6 +4,6 @@
 -- requires: flips
 
 CREATE OR REPLACE VIEW flipr.userflips AS
-SELECT f.id, u.nickname, u.fullname, f.body, f.timestamp
+SELECT f.id, u.nickname, u.fullname, u.twitter, f.body, f.timestamp
   FROM flipr.users u
   JOIN flipr.flips f ON u.nickname = f.nickname;
```

--------------------------------

### Initialize a new Sqitch project

Source: https://sqitch.org/docs/manual/sqitch-configuration

Initializes a new project named 'widgets' configured for the PostgreSQL engine.

```bash
> sqitch init widgets --engine pg
Created sqitch.conf
Created sqitch.plan
Created deploy/
Created revert/
Created verify/
```

--------------------------------

### Configure Snowflake ODBC Driver

Source: https://sqitch.org/docs/manual/sqitchtutorial-snowflake

Example entry for the odbcinst.ini file to register the Snowflake ODBC driver on Unix-like systems.

```ini
[Snowflake]
Description = ODBC for Snowflake
Driver      = /usr/lib64/snowflake/odbc/lib/libSnowflake.so
```

--------------------------------

### Bundle the Sqitch project

Source: https://sqitch.org/docs/manual/sqitchtutorial-firebird

Create a bundle directory containing the project configuration and deployment scripts.

```bash
> sqitch bundle
Bundling into bundle
Writing config
Writing plan
Writing scripts
  + users
  + flips
  + userflips @v1.0.0-dev1
```

--------------------------------

### Synopsis of sqitch-bundle usage

Source: https://sqitch.org/docs/manual/sqitch-bundle

Basic command-line usage patterns for the sqitch-bundle command.

```bash
sqitch bundle [options]
sqitch bundle --dest-dir widgets-1.0.0
sqitch bundle --all
sqitch bundle pg mysql
```

--------------------------------

### Bundle the project

Source: https://sqitch.org/docs/manual/sqitchtutorial-sqlite

Create a bundle directory containing the project files for distribution.

```bash
> rm -rf dev
> sqitch bundle
Bundling into bundle
Writing config
Writing plan
Writing scripts
        + users
        + flips
        + userflips @v1.0.0-dev1
```

--------------------------------

### Inspect Deployment Plan

Source: https://sqitch.org/docs/manual/sqitchtutorial

View the contents of the sqitch.plan file to see the sequence of changes and dependencies.

```text
> cat sqitch.plan
%syntax-version=1.0.0
%project=flipr
%uri=https://github.com/sqitchers/sqitch-intro/

appschema 2013-12-30T23:19:45Z Marge N. O’Vera <marge@example.com> # Add schema for all flipr objects.
users [appschema] 2013-12-30T23:49:00Z Marge N. O’Vera <marge@example.com> # Creates table to track our users.
insert_user [users appschema] 2013-12-30T23:57:36Z Marge N. O’Vera <marge@example.com> # Creates a function to insert a user.
change_pass [users appschema] 2013-12-30T23:57:45Z Marge N. O’Vera <marge@example.com> # Creates a function to change a user password.
```

--------------------------------

### Basic Usage Synopsis

Source: https://sqitch.org/docs/manual/sqitch-show

The general syntax for invoking the sqitch-show command.

```bash
sqitch show [options] <type> <object>
```

--------------------------------

### Initialize with project URI

Source: https://sqitch.org/docs/manual/sqitch-init

Associates a URI with the project for uniqueness in hashed object IDs.

```bash
sqitch init widgets --uri https://github.com/me/wigets
```

--------------------------------

### Initialize with custom registry

Source: https://sqitch.org/docs/manual/sqitch-init

Specifies the database object name for storing Sqitch state and history.

```bash
sqitch init widgets --registry meta
```

--------------------------------

### Initialize a SQLite Sqitch project

Source: https://sqitch.org/docs/manual/sqitch-init

Creates a new project named 'quack' using the SQLite engine with a custom top directory.

```bash
sqitch init --engine sqlite --top-dir sqlite quack
```

--------------------------------

### List Global Options

Source: https://sqitch.org/docs/manual/sqitch

Displays the available global command-line options and their descriptions.

```bash
-C --chdir --cd DIR       Change to directory before performing any actions.
   --etc-path             Print path to etc directory and exit.
   --no-pager             Do not pipe output into a pager.
   --quiet                Quiet mode with non-error output suppressed.
-V --verbose              Increment verbosity.
   --version              Print version number and exit.
   --help                 Show a list of commands and exit.
   --man                  Print introductory documentation and exit.
```

--------------------------------

### Verify table creation

Source: https://sqitch.org/docs/manual/sqitchtutorial-oracle

Use SQL*Plus to inspect the table structure after deployment.

```bash
> echo "DESCRIBE flipr.users;" | sqlplus -S scott/tiger@flipr_test

 Name                                      Null?    Type
 ----------------------------------------- -------- ----------------------------
 NICKNAME                                  NOT NULL VARCHAR2(512 CHAR)
 PASSWORD                                  NOT NULL VARCHAR2(512 CHAR)
 TIMESTAMP                                 NOT NULL TIMESTAMP(6) WITH TIME ZONE
```

--------------------------------

### Deploy and Verify Changes

Source: https://sqitch.org/docs/manual/sqitchtutorial-mysql

Execute the deployment and verify the presence of the new procedures in the database.

```bash
> sqitch deploy
Deploying changes to flipr_test
  + insert_user .. ok
  + change_pass .. ok
```

```bash
> mysql -u root --execute "SELECT routine_name FROM information_schema.routines WHERE routine_schema = 'flipr_test'"
+--------------+
| routine_name |
+--------------+
| change_pass  |
| insert_user  |
+--------------+
```

--------------------------------

### Show SQLite engine configuration

Source: https://sqitch.org/docs/manual/sqitch-configuration

Verify the configuration details for the newly added SQLite engine.

```bash
> sqitch engine show sqlite
* sqlite
    Target:        db:sqlite:
    Registry:      sqitch
    Client:        sqlite3
    Top Directory: sqlite
    Plan File:     sqlite/sqitch.plan
    Extension:     sql
    Script Directories:
      Deploy:      sqlite/deploy
      Revert:      sqlite/revert
      Verify:      sqlite/verify
    Reworked Script Directories:
      Reworked:    sqlite
      Deploy:      sqlite/deploy
      Revert:      sqlite/revert
      Verify:      sqlite/verify
    No Variables
```

--------------------------------

### Deploy from a bundle

Source: https://sqitch.org/docs/manual/sqitchtutorial-firebird

Deploy the project using the files generated in the bundle directory.

```bash
> cd bundle
> sudo -u firebird mkdir /tmp/flipr_prod
> echo "CREATE DATABASE 'localhost:/tmp/flipr_prod/flipr.fdb'; exit;" \
  | isql-fb -q -u SYSDBA -p masterkey
> sqitch deploy db:firebird://sysdba:masterkey@localhost//tmp/flipr_prod/flipr.fdb
Adding registry tables to db:firebird://sysdba:@localhost//tmp/flipr_prod/sqitch.fdb
Deploying changes to db:firebird://sysdba:@localhost//tmp/flipr_prod/flipr.fdb
  + users ................... ok
  + flips ................... ok
  + userflips @v1.0.0-dev1 .. ok
```

--------------------------------

### Configure User and Client Settings

Source: https://sqitch.org/docs/manual/sqitchtutorial-snowflake

Set the path to the SnowSQL client and define user identity for Sqitch.

```bash
> sqitch config --user engine.snowflake.client /Applications/SnowSQL.app/Contents/MacOS/snowsql
```

```bash
> sqitch config --user user.name 'Marge N. O’Vera'
> sqitch config --user user.email 'marge@example.com'
```

--------------------------------

### View User Configuration

Source: https://sqitch.org/docs/manual/sqitchtutorial-firebird

Displays the contents of the user-specific sqitch.conf file.

```bash
> cat ~/.sqitch/sqitch.conf
[engine "firebird"]
  client = /opt/local/bin/isql
[user]
  name = Marge N. O’Vera
  email = marge@example.com
```

--------------------------------

### Create test database

Source: https://sqitch.org/docs/manual/sqitchtutorial-mysql

Creates the target database using the MySQL command-line client.

```bash
> mysql -u root --execute 'CREATE DATABASE flipr_test'
```

--------------------------------

### Deploy and Verify Functions

Source: https://sqitch.org/docs/manual/sqitchtutorial

Deploy the new changes and verify the existence of the functions in the database.

```bash
> sqitch deploy
Deploying changes to flipr_test
  + insert_user .. ok
  + change_pass .. ok
```

```bash
> psql -d flipr_test -c '\df flipr.*'
                                    List of functions
 Schema |    Name     | Result data type |          Argument data types          |  Type  
--------+-------------+------------------+---------------------------------------+--------
 flipr  | change_pass | boolean          | nick text, oldpass text, newpass text | normal
 flipr  | insert_user | void             | nickname text, password text          | normal
```

--------------------------------

### Verify deployment with psql

Source: https://sqitch.org/docs/manual/sqitchtutorial

Use psql to verify that the new password hashing logic is working correctly.

```sql
> psql -d flipr_test -c "
    DELETE FROM flipr.users;
    SELECT flipr.insert_user('foo', 'secr3t'), flipr.insert_user('bar', 'secr3t');
    SELECT * FROM flipr.users;
"
 nickname |              password              |           timestamp           
----------+------------------------------------+-------------------------------
 foo      | $1$pRNfJjI9$CdcEXJ9xCoJPD.R5Z/7.R1 | 2013-12-31 01:03:15.398572+00
 bar      | $1$Nf1LcU.p$B9sKzdu8vMgu5oxbimo5P1 | 2013-12-31 01:03:15.398572+00
```

--------------------------------

### View sqitch.conf Configuration

Source: https://sqitch.org/docs/manual/sqitchtutorial-oracle

Display the contents of the generated sqitch.conf file.

```ini
> cat sqitch.conf
[core]
        engine = oracle
        # plan_file = sqitch.plan
        # top_dir = .
# [engine "oracle"]
        # target = db:oracle:
        # registry = 
        # client = sqlplus
```

--------------------------------

### Deploy changes to Exasol

Source: https://sqitch.org/docs/manual/sqitchtutorial-exasol

Execute the sqitch deploy command using a database URI.

```bash
> sqitch deploy 'db:exasol://sys:exasol@localhost:8563/?Driver=Exasol'
Adding registry tables to db:exasol://sys:@localhost:8563/?Driver=Exasol
Deploying changes to db:exasol://sys:@localhost:8563/?Driver=Exasol
  + appschema .. ok
```

--------------------------------

### Specify database client

Source: https://sqitch.org/docs/manual/sqitch-check

Use the --client option to provide a custom path to the database command-line client.

```bash
sqitch check --client /usr/local/pgsql/bin/psql
```

--------------------------------

### Create Test Database

Source: https://sqitch.org/docs/manual/sqitchtutorial-firebird

Creates a test database using the isql-fb client.

```bash
> sudo -u firebird mkdir /tmp/flipr_test
> echo "CREATE DATABASE 'localhost:/tmp/flipr_test/flipr.fdb'; exit;" \
  | isql-fb -q -u SYSDBA -p masterkey
```

--------------------------------

### Deploy changes

Source: https://sqitch.org/docs/manual/sqitchtutorial-firebird

Execute the deployment of the new change.

```bash
> sqitch deploy
Deploying changes to flipr_test
  + flips .. ok
```

--------------------------------

### Tag and Bundle Release

Source: https://sqitch.org/docs/manual/sqitchtutorial-mysql

Tag the database version and create a bundle for distribution.

```bash
> sqitch tag v1.0.0-dev2 -n 'Tag v1.0.0-dev2.'
Tagged "delete_flip" with @v1.0.0-dev2
> git commit -am 'Tag the database with v1.0.0-dev2.'
[main 76d6e15] Tag the database with v1.0.0-dev2.
 1 file changed, 1 insertion(+)
> git tag v1.0.0-dev2 -am 'Tag v1.0.0-dev2'
> sqitch bundle --dest-dir flipr-1.0.0-dev2
Bundling into flipr-1.0.0-dev2
Writing config
Writing plan
Writing scripts
  + appuser
  + users
  + insert_user
  + change_pass @v1.0.0-dev1
  + lists
  + insert_list
  + delete_list
  + flips
  + insert_flip
  + delete_flip @v1.0.0-dev2
```

--------------------------------

### Initialize with default target

Source: https://sqitch.org/docs/manual/sqitch-init

Sets the default target database name or URI.

```bash
sqitch init widgets --target db:pg:widgets
```

--------------------------------

### Commit and Deploy Changes

Source: https://sqitch.org/docs/manual/sqitchtutorial-vertica

Use Git to commit changes and Sqitch to deploy them to the target database.

```bash
> git add .
> git commit -am 'Add users table.'
[main c7c24c5] Add users table.
 4 files changed, 18 insertions(+), 0 deletions(-)
 create mode 100644 deploy/users.sql
 create mode 100644 revert/users.sql
 create mode 100644 verify/users.sql
Deploying changes to flipr_test
  + users .. ok
```

--------------------------------

### Configure User Settings

Source: https://sqitch.org/docs/manual/sqitchtutorial-exasol

Set the path to the Exasol client and user identity in the global Sqitch configuration.

```bash
> sqitch config --user engine.exasol.client /opt/EXAplus/exaplus
```

```bash
> sqitch config --user user.name 'Marge N. O’Vera'
> sqitch config --user user.email 'marge@example.com'
```

--------------------------------

### Deploy changes

Source: https://sqitch.org/docs/manual/sqitchtutorial-firebird

Apply the new changes to the database.

```bash
> sqitch deploy
Deploying changes to flipr_test
  + hashtags .. ok
```

--------------------------------

### Create target database in ClickHouse

Source: https://sqitch.org/docs/manual/sqitchtutorial-clickhouse

Initializes the target database using the ClickHouse client.

```bash
> clickhouse client --query 'CREATE DATABASE flipr_test'
```

--------------------------------

### Deploy and Verify Database State

Source: https://sqitch.org/docs/manual/sqitchtutorial-vertica

Execute the deployment and verify the existence of the new table and view using vsql.

```bash
> sqitch deploy
Deploying changes to flipr_test
  + flips ...... ok
  + userflips .. ok
```

```bash
> vsql -U dbadmin -c '\dt flipr.flips'
               List of tables
 Schema | Name  | Kind  |  Owner  | Comment 
--------+-------+-------+---------+---------
 flipr  | flips | table | dbadmin | 

> vsql -U dbadmin -c '\dv flipr.userflips'
                  List of View Fields
 Schema |   View    |   Column    |     Type     | Size 
--------+-----------+-------------+--------------+------
 flipr  | userflips | id          | int          |    8
 flipr  | userflips | nickname    | varchar(80)  |   80
 flipr  | userflips | fullname    | varchar(256) |  256
 flipr  | userflips | body        | varchar(180) |  180
 flipr  | userflips | "timestamp" | timestamptz  |    8
```

--------------------------------

### Show engine configuration details

Source: https://sqitch.org/docs/manual/sqitch-configuration

Display the fully-evaluated configuration for a specific engine.

```bash
> sqitch engine show pg
* pg
    Target:        db:pg:
    Registry:      sqitch
    Client:        psql
    Top Directory: pg
    Plan File:     pg/sqitch.plan
    Extension:     sql
    Script Directories:
      Deploy:      pg/deploy
      Revert:      pg/revert
      Verify:      pg/verify
    Reworked Script Directories:
      Reworked:    pg
      Deploy:      pg/deploy
      Revert:      pg/revert
      Verify:      pg/verify
    No Variables
```

--------------------------------

### Create test database

Source: https://sqitch.org/docs/manual/sqitchtutorial

Command to create a local PostgreSQL database for testing.

```bash
> createdb flipr_test
```

--------------------------------

### Display Version

Source: https://sqitch.org/docs/manual/sqitch

Outputs the current program version.

```bash
sqitch --version
```

--------------------------------

### Add a new view change

Source: https://sqitch.org/docs/manual/sqitchtutorial-sqlite

Use the sqitch add command to create the necessary SQL files for a new database view.

```bash
> sqitch add userflips --requires users --requires flips \
        -n 'Creates the userflips view.'
Created deploy/userflips.sql
Created revert/userflips.sql
Created verify/userflips.sql
Added "userflips [users flips]" to sqitch.plan
```

--------------------------------

### Implement verify scripts

Source: https://sqitch.org/docs/manual/sqitchtutorial-vertica

SQL scripts to verify that the deployment was successful.

```sql
CREATE TABLE flipr.verify__ (id int);
DROP   TABLE flipr.verify__;
```

```sql
SELECT 1/COUNT(*) FROM v_catalog.schemata WHERE schema_name = 'flipr';
```

--------------------------------

### Show Target Configuration

Source: https://sqitch.org/docs/manual/sqitch-configuration

Display the configuration details for specific named targets.

```bash
> sqitch target show prod-primary prod-standby
* prod-primary
    URI:           db:pg://sqitch@db1.example.com/widgets
    Registry:      sqitch
    Client:        psql
    Top Directory: pg
    Plan File:     sqitch.plan
    Extension:     sql
    Script Directories:
      Deploy:      pg/deploy
      Revert:      pg/revert
      Verify:      pg/verify
    Reworked Script Directories:
      Reworked:    pg
      Deploy:      pg/deploy
      Revert:      pg/revert
      Verify:      pg/verify
    No Variables
* prod-standby
    URI:           db:pg://sqitch@db2.example.com/widgets
    Registry:      sqitch
    Client:        psql
    Top Directory: pg
    Plan File:     sqitch.plan
    Extension:     sql
    Script Directories:
      Deploy:      pg/deploy
      Revert:      pg/revert
      Verify:      pg/verify
    Reworked Script Directories:
      Reworked:    pg
      Deploy:      pg/deploy
      Revert:      pg/revert
      Verify:      pg/verify
    No Variables
```

```bash
> sqitch target add dev-sqlite db:sqlite:/var/db/widgets_dev.db
> sqitch target show dev-sqlite
* dev-sqlite
    URI:           db:sqlite:/var/db/widgets_dev.db
    Registry:      sqitch
    Client:        sqlite3
    Top Directory: sqlite
    Plan File:     sqitch.plan
    Extension:     sql
    Script Directories:
      Deploy:      sqlite/deploy
      Revert:      sqlite/revert
      Verify:      sqlite/verify
    Reworked Script Directories:
      Reworked:    sqlite
      Deploy:      sqlite/deploy
      Revert:      sqlite/revert
      Verify:      sqlite/verify
    No Variables
```

--------------------------------

### Set deployment plan file

Source: https://sqitch.org/docs/manual/sqitch-engine

Specifies the path to the deployment plan file, overriding the default.

```bash
sqitch engine add pg --plan-file my.plan
```

--------------------------------

### Display Sqitch Synopsis

Source: https://sqitch.org/docs/manual/sqitchtutorial-firebird

Shows the basic usage pattern for the sqitch command.

```bash
sqitch *
```

--------------------------------

### Configure Top Directory

Source: https://sqitch.org/docs/manual/sqitch-configuration

Methods to specify the project root directory.

```bash
sqitch target add $target --top-dir $top_dir
sqitch target alter $target --top-dir $top_dir
```

```bash
sqitch engine add $engine --top-dir $top_dir
sqitch engine alter $engine --top-dir $top_dir
```

```bash
sqitch init $project --top-dir $top_dir
sqitch config core.top_dir $top_dir
```

--------------------------------

### Upgrade Registry Synopsis

Source: https://sqitch.org/docs/manual/sqitch-upgrade

Basic usage syntax for the sqitch upgrade command.

```bash
sqitch upgrade [options] [<database>]
```

--------------------------------

### Query configuration values

Source: https://sqitch.org/docs/manual/sqitch-config

Commands to retrieve current configuration settings.

```bash
% sqitch config --get core.engine
```

```bash
% sqitch config core.engine
```

```bash
% sqitch config --get core.fuzzle.clack ba
```

```bash
% sqitch config --get-all core.fuzzle.clack
```

--------------------------------

### Deploy changes with verification

Source: https://sqitch.org/docs/manual/sqitchtutorial-firebird

Deploys changes to the database and runs the verify script immediately after.

```bash
> sqitch deploy db:firebird://sysdba:masterkey@localhost//tmp/flipr_test/flipr.fdb --verify
Deploying changes to db:firebird://sysdba:@localhost//tmp/flipr_test/flipr.fdb
  + users .. ok
```

--------------------------------

### Deploying to an Oracle database

Source: https://sqitch.org/docs/manual/sqitchtutorial-oracle

Execute a deployment to a specific Oracle database instance using the connection URI.

```bash
> sqitch deploy db:oracle://scott:tiger@/flipr_dev
Adding registry tables to db:oracle://scott:@/flipr_dev
Deploying changes to db:oracle://scott:@/flipr_dev
  + appschema ................. ok
  + users ..................... ok
  + insert_user ............... No errors.
ok
  + change_pass @v1.0.0-dev1 .. No errors.
ok
```
Tokens:
Raw