.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "sqitch-status 3pm"
.TH sqitch-status 3pm 2024-02-08 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH Name
.IX Header "Name"
sqitch-status \- Show the current deployment status of a database
.SH Synopsis
.IX Header "Synopsis"
.Vb 1
\&  sqitch status [options] [<database>]
.Ve
.SH Description
.IX Header "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.
.PP
The \f(CW\*(C`<database>\*(C'\fR parameter specifies the database to which to connect,
and may also be specified as the \f(CW\*(C`\-\-target\*(C'\fR option. It can be target name,
a URI, an engine name, or plan file path.
.SH Options
.IX Header "Options"
.ie n .IP """\-t""" 4
.el .IP \f(CW\-t\fR 4
.IX Item "-t"
.PD 0
.ie n .IP """\-\-target""" 4
.el .IP \f(CW\-\-target\fR 4
.IX Item "--target"
.PD
The target database to which to connect. This option can be either a URI or
the name of a target in the configuration.
.ie n .IP """\-\-project""" 4
.el .IP \f(CW\-\-project\fR 4
.IX Item "--project"
Project for which to retrieve the status. Defaults to the status of the
current project, if a plan can be found.
.ie n .IP """\-\-show\-changes""" 4
.el .IP \f(CW\-\-show\-changes\fR 4
.IX Item "--show-changes"
Also display a list of deployed changes.
.ie n .IP """\-\-show\-tags""" 4
.el .IP \f(CW\-\-show\-tags\fR 4
.IX Item "--show-tags"
Also display a list of applied tags.
.ie n .IP """\-\-date\-format""" 4
.el .IP \f(CW\-\-date\-format\fR 4
.IX Item "--date-format"
.PD 0
.ie n .IP """\-\-date""" 4
.el .IP \f(CW\-\-date\fR 4
.IX Item "--date"
.PD
Format to use for timestamps. Defaults to \f(CW\*(C`iso\*(C'\fR. Allowed values:
.RS 4
.ie n .IP """iso""" 4
.el .IP \f(CWiso\fR 4
.IX Item "iso"
.PD 0
.ie n .IP """iso8601""" 4
.el .IP \f(CWiso8601\fR 4
.IX Item "iso8601"
.PD
Shows timestamps in ISO\-8601 format.
.ie n .IP """rfc""" 4
.el .IP \f(CWrfc\fR 4
.IX Item "rfc"
.PD 0
.ie n .IP """rfc2822""" 4
.el .IP \f(CWrfc2822\fR 4
.IX Item "rfc2822"
.PD
Show timestamps in RFC\-2822 format.
.ie n .IP """full""" 4
.el .IP \f(CWfull\fR 4
.IX Item "full"
.PD 0
.ie n .IP """long""" 4
.el .IP \f(CWlong\fR 4
.IX Item "long"
.ie n .IP """medium""" 4
.el .IP \f(CWmedium\fR 4
.IX Item "medium"
.ie n .IP """short""" 4
.el .IP \f(CWshort\fR 4
.IX Item "short"
.PD
Show timestamps in the specified format length, using the system locale's
\&\f(CW\*(C`LC_TIME\*(C'\fR category.
.ie n .IP """raw""" 4
.el .IP \f(CWraw\fR 4
.IX Item "raw"
Show timestamps in raw format, which is strict ISO\-8601 in the UTC time zone.
.ie n .IP """strftime:$string""" 4
.el .IP \f(CWstrftime:$string\fR 4
.IX Item "strftime:$string"
Show timestamps using an arbitrary \f(CW\*(C`strftime\*(C'\fR pattern. See
"strftime Paterns" in DateTime for comprehensive documentation of supported
patterns.
.ie n .IP """cldr:$string""" 4
.el .IP \f(CWcldr:$string\fR 4
.IX Item "cldr:$string"
Show timestamps using an arbitrary \f(CW\*(C`cldr\*(C'\fR pattern. See "CLDR
Paterns" in DateTime for comprehensive documentation of supported patterns.
.RE
.RS 4
.RE
.ie n .IP """\-\-registry""" 4
.el .IP \f(CW\-\-registry\fR 4
.IX Item "--registry"
.Vb 1
\&  sqitch status \-\-registry registry
.Ve
.Sp
The name of the Sqitch registry schema or database in which sqitch stores its
own data.
.ie n .IP """\-\-db\-client""" 4
.el .IP \f(CW\-\-db\-client\fR 4
.IX Item "--db-client"
.PD 0
.ie n .IP """\-\-client""" 4
.el .IP \f(CW\-\-client\fR 4
.IX Item "--client"
.PD
.Vb 1
\&  sqitch status \-\-client /usr/local/pgsql/bin/psql
.Ve
.Sp
Path to the command-line client for the database engine. Defaults to a client
in the current path named appropriately for the database engine.
.ie n .IP """\-d""" 4
.el .IP \f(CW\-d\fR 4
.IX Item "-d"
.PD 0
.ie n .IP """\-\-db\-name""" 4
.el .IP \f(CW\-\-db\-name\fR 4
.IX Item "--db-name"
.PD
.Vb 2
\&  sqitch status \-\-db\-name widgets
\&  sqitch status \-d bricolage
.Ve
.Sp
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.
.ie n .IP """\-u""" 4
.el .IP \f(CW\-u\fR 4
.IX Item "-u"
.PD 0
.ie n .IP """\-\-db\-user""" 4
.el .IP \f(CW\-\-db\-user\fR 4
.IX Item "--db-user"
.ie n .IP """\-\-db\-username""" 4
.el .IP \f(CW\-\-db\-username\fR 4
.IX Item "--db-username"
.PD
.Vb 3
\&  sqitch status \-\-db\-username root
\&  sqitch status \-\-db\-user postgres
\&  sqitch status \-u Mom
.Ve
.Sp
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.
.ie n .IP """\-h""" 4
.el .IP \f(CW\-h\fR 4
.IX Item "-h"
.PD 0
.ie n .IP """\-\-db\-host""" 4
.el .IP \f(CW\-\-db\-host\fR 4
.IX Item "--db-host"
.PD
.Vb 2
\&  sqitch status \-\-db\-host db.example.com
\&  sqitch status \-h appdb.example.net
.Ve
.Sp
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.
.ie n .IP """\-p""" 4
.el .IP \f(CW\-p\fR 4
.IX Item "-p"
.PD 0
.ie n .IP """\-\-db\-port""" 4
.el .IP \f(CW\-\-db\-port\fR 4
.IX Item "--db-port"
.PD
.Vb 2
\&  sqitch status \-\-db\-port 7654
\&  sqitch status \-p 5431
.Ve
.Sp
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.
.ie n .IP """\-\-plan\-file""" 4
.el .IP \f(CW\-\-plan\-file\fR 4
.IX Item "--plan-file"
.PD 0
.ie n .IP """\-f""" 4
.el .IP \f(CW\-f\fR 4
.IX Item "-f"
.PD
.Vb 1
\&  sqitch status \-\-plan\-file my.plan
.Ve
.Sp
Path to the deployment plan file. Overrides target, engine, and core
configuration values. Defaults to \fR\f(CI$top_dir\fR\fI/sqitch.plan\fR.
.SH "Configuration Variables"
.IX Header "Configuration Variables"
.ie n .IP """status.show_changes""" 4
.el .IP \f(CWstatus.show_changes\fR 4
.IX Item "status.show_changes"
Boolean value indicates whether or not to display changes in the output.
Defaults to false.
.ie n .IP """status.show_tags""" 4
.el .IP \f(CWstatus.show_tags\fR 4
.IX Item "status.show_tags"
Boolean value indicates whether or not to display tags in the output. Defaults
to false.
.ie n .IP """status.date_format""" 4
.el .IP \f(CWstatus.date_format\fR 4
.IX Item "status.date_format"
Format to use for timestamps. Supports the same values as the \f(CW\*(C`\-\-date\-format\*(C'\fR
option.
.SH Sqitch
.IX Header "Sqitch"
Part of the sqitch suite.