---
name: "sqitch-status"
section: "3pm"
platform: "linux"
package: "sqitch"
version: "1.5.2-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/sqitch-status"
---

# sqitch-status(3pm)

Show the current deployment status of a database

## Name

sqitch-status - Show the current deployment status of a database

## Synopsis

```
  sqitch status [options] [<database>]
```

## Description

Displays information about the current deployment status of a database. The most recently deployed change information is displayed, as well as any related tags. If there are undeployed changes in the plan, they will be listed. Otherwise, a message will indicate that the database is up-to-date.

The `"<database>"` parameter specifies the database to which to connect, and may also be specified as the `"--target"` option. It can be target name, a URI, an engine name, or plan file path.

## Options

- "-t"

  - "--target"

  The target database to which to connect. This option can be either a URI or the name of a target in the configuration.

- "--project"

  Project for which to retrieve the status. Defaults to the status of the current project, if a plan can be found.

- "--show-changes"

  Also display a list of deployed changes.

- "--show-tags"

  Also display a list of applied tags.

- "--date-format"

  - "--date"

  Format to use for timestamps. Defaults to `"iso"`. Allowed values:

  - "iso"

    - "iso8601"

    Shows timestamps in ISO-8601 format.

  - "rfc"

    - "rfc2822"

    Show timestamps in RFC-2822 format.

  - "full"

    - "long"

    - "medium"

    - "short"

    Show timestamps in the specified format length, using the system locale's `"LC_TIME"` category.

  - "raw"

    Show timestamps in raw format, which is strict ISO-8601 in the UTC time zone.

  - "strftime:$string"

    Show timestamps using an arbitrary `"strftime"` pattern. See "strftime Paterns" in DateTime for comprehensive documentation of supported patterns.

  - "cldr:$string"

    Show timestamps using an arbitrary `"cldr"` pattern. See "CLDR Paterns" in DateTime for comprehensive documentation of supported patterns.

- "--registry"

  ```
    sqitch status --registry registry
  ```

  The name of the Sqitch registry schema or database in which sqitch stores its own data.

- "--db-client"

  - "--client"

  ```
    sqitch status --client /usr/local/pgsql/bin/psql
  ```

  Path to the command-line client for the database engine. Defaults to a client in the current path named appropriately for the database engine.

- "-d"

  - "--db-name"

  ```
    sqitch status --db-name widgets
    sqitch status -d bricolage
  ```

  Name of the database. In general, targets and URIs are preferred, but this option can be used to override the database name in a target.

- "-u"

  - "--db-user"

  - "--db-username"

  ```
    sqitch status --db-username root
    sqitch status --db-user postgres
    sqitch status -u Mom
  ```

  User name to use when connecting to the database. Does not apply to all engines. In general, targets and URIs are preferred, but this option can be used to override the user name in a target.

- "-h"

  - "--db-host"

  ```
    sqitch status --db-host db.example.com
    sqitch status -h appdb.example.net
  ```

  Host name to use when connecting to the database. Does not apply to all engines. In general, targets and URIs are preferred, but this option can be used to override the host name in a target.

- "-p"

  - "--db-port"

  ```
    sqitch status --db-port 7654
    sqitch status -p 5431
  ```

  Port number to connect to. Does not apply to all engines. In general, targets and URIs are preferred, but this option can be used to override the port in a target.

- "--plan-file"

  - "-f"

  ```
    sqitch status --plan-file my.plan
  ```

  Path to the deployment plan file. Overrides target, engine, and core configuration values. Defaults to *$top\_dir/sqitch.plan*.

## Configuration Variables

- "status.show\_changes"

  Boolean value indicates whether or not to display changes in the output. Defaults to false.

- "status.show\_tags"

  Boolean value indicates whether or not to display tags in the output. Defaults to false.

- "status.date\_format"

  Format to use for timestamps. Supports the same values as the `"--date-format"` option.

## Sqitch

Part of the sqitch suite.