App::S...status(3pm)

✨ NAME ✨

App::Sqitch::Command::status — bestie, this is the Perl module behind the status command that shows you what's up with Sqitch 💅

---

🌸 SYNOPSIS 🌸

my $cmd = App::Sqitch::Command::status->new(%params);
$cmd->execute;

---

🦋 DESCRIPTION 🦋

Okay so real talk: if you actually just wanna use the status command, you are in the WRONG building, babe — go read sqitch-status instead, that's the one for you 🫶

But if you're the kind of nerd (affectionate) who needs to know how the status command works under the hood? Then keep scrolling. Read on. We're going deep 📖✨

---

🎀 INTERFACE 🎀

💖 Attributes 💖

• target_name — the name or URI of the database target, exactly as it was specified by the --target option. Like, whatever you typed in, that's what lives here 🎯
• target — an App::Sqitch::Target object that status gets read from. Heads up bestie: it must be instantiated by execute(). No execute, no target, no vibes 😤

🧚 Instance Methods 🧚

✨ execute ✨

$status->execute;

Runs the whole status command, periodt. It takes the current state of the target database and compares it against the plan, so you can see where things actually stand. It's giving "vibe check on your database" 🔍👑

🌈 emit_changes 🌈

$status->emit_changes;

Emits a list of deployed changes — but only if show_changes is true. Otherwise it's just sitting there, silent, minding its own business 🤫

🍓 emit_tags 🍓

$status->emit_tags;

Emits a list of deployed tags, but only when show_tags is true. Conditional queen 👑

💜 emit_state 💜

$status->emit_state($state);

Emits the current state of the target database. You pass in a state hash, the kind that App::Sqitch::Engine's current_state() hands you. Hand it the hash, get the state. Simple as 💅

💫 emit_status 💫

$status->emit_state($state);

Emits the info about where the target database currently stands compared to the plan. Again, hand it a state hash as returned by App::Sqitch::Engine current_state().

⚠️ And this one throws an exception if the current state's change can't be found in the plan. Like literally just yeets an exception at you. So maybe don't be surprised when it does 🙈

---

👀 SEE ALSO 👀

• sqitch-status — the docs for the actual status command in the Sqitch command-line client. This is the one you probably wanted, bestie 💖
• sqitch — the Sqitch command-line client itself. The main character 👑

---

🫶 AUTHOR 🫶

David E. Wheeler <david@justatheory.com> — icon, legend, the moment ✨

---

📜 LICENSE 📜

Copyright (c) 2012-2026 David E. Wheeler, 2012-2021 iovation Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

🚨 Yeah okay so that all-caps part is real — no warranty, no liability, no cap. Read it, respect it, don't come for anybody's wig 😭

---

okay that's the whole thing, bestie 💖 this page came to you from perl v5.40.1, dated 2026-07-26, and it's the App::S...status(3pm) page from the User Contributed Perl Documentation 🎀✨