sqitch-status(3pm)

πŸ’– sqitch-status β€” the vibe check for ur database πŸ’–

okay bestie, so this is sqitch-status, part of the User Contributed Perl Documentation squad 🫢. It's the little command that tells u what ur database is actually doing right now. Let's go ✨


✨ NAME ✨

sqitch-status β€” show the current deployment status of a database πŸ’…


🌸 SYNOPSIS 🌸

sqitch status [options] [<database>]

πŸ¦‹ DESCRIPTION πŸ¦‹

So basically, this command pulls up the receipts πŸ“œ on the current deployment status of a database. It shows u the info about the most recently deployed change, plus any related tags that came along with it. Iconic.

If there are undeployed changes sitting in the plan? Bestie, they will be listed. πŸ‘€ Otherwise u just get a message saying the database is up-to-date β€” which is the moment we all live for, fr fr. πŸ’…βœ¨

The <database> parameter tells Sqitch which database to connect to, and ngl u can also just pass it as the --target option instead. Either way works. It can be a target name, a URI, an engine name, or a plan file path. Slay, so many options. πŸ’–


πŸŽ€ OPTIONS πŸŽ€

  • -t, --target β€” the target database u wanna connect to. Can be either a URI or the name of a target in the configuration. 🎯
  • --project β€” the project u want the status for. Defaults to the status of the current project, assuming a plan can be found. No plan, no vibe check. πŸ’€
  • --show-changes β€” also show a list of the deployed changes. Like a little hall of fame πŸ†
  • --show-tags β€” also show a list of applied tags. Gotta give credit where credit is due 🏷️
  • --date-format, --date β€” the format to use for timestamps. Defaults to iso. Here's the menu of allowed values, bestie:
    • iso, iso8601 β€” shows timestamps in ISO-8601 format. The classic. πŸ’…
    • 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. Pick ur fighter 🌈
    • raw β€” show timestamps in raw format, which is strict ISO-8601 in the UTC time zone. No thoughts, just UTC 🧊
    • strftime:$string β€” show timestamps using an arbitrary strftime pattern. See "strftime Paterns" in DateTime for comprehensive documentation of supported patterns. Customize ur heart out ✨
    • cldr:$string β€” show timestamps using an arbitrary cldr pattern. See "CLDR Paterns" in DateTime for comprehensive documentation of supported patterns.
  • --registry β€” the name of the Sqitch registry schema or database in which sqitch stores its own data. Like:
sqitch status --registry registry
  • --db-client, --client β€” path to the command-line client for the database engine. Defaults to a client in the current path named appropriately for the database engine. Like:
sqitch status --client /usr/local/pgsql/bin/psql
  • -d, --db-name β€” 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. For example:
sqitch status --db-name widgets
sqitch status -d bricolage
  • -u, --db-user, --db-username β€” user name to use when connecting to the database. Does not apply to all engines, just fyi. In general, targets and URIs are preferred, but this option can be used to override the user name in a target. Like:
sqitch status --db-username root
sqitch status --db-user postgres
sqitch status -u Mom
  • -h, --db-host β€” 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. Like:
sqitch status --db-host db.example.com
sqitch status -h appdb.example.net
  • -p, --db-port β€” 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. Like:
sqitch status --db-port 7654
sqitch status -p 5431
  • --plan-file, -f β€” path to the deployment plan file. Overrides target, engine, and core configuration values. Defaults to $top_dir/sqitch.plan. Like:
sqitch status --plan-file my.plan
ok quick heads up bestie: that $top_dir/sqitch.plan default is literally what the manpage says, so don't come for me πŸ’–

πŸ’œ CONFIGURATION VARIABLES πŸ’œ

  • status.show_changes β€” a boolean value that says whether or not to display changes in the output. Defaults to false. (so like, off unless u ask 🫢)
  • status.show_tags β€” a boolean value that says whether or not to display tags in the output. Defaults to false.
  • status.date_format β€” the format to use for timestamps. Supports the same values as the --date-format option. Same menu, different door πŸ’…

πŸ‘‘ Sqitch πŸ‘‘

Part of the sqitch suite. You already knew that tho. iykyk ✨


and that's the whole page, bestie!! πŸ¦‹πŸŒΈ this one's from perl v5.40.1, dated 2026-07-26, and it lives at sqitch-status(3pm) β€” go forth and status-check ur databases, u gorgeous genius πŸŽ€πŸ’–πŸ’…

πŸ“¦ where this page comes from