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

πŸ’– App::S...::check β€” the manual page for App::Sqitch::Command::check πŸ’–

okay so bestie, we're in the land of User Contributed Perl Documentation πŸŽ€ and this is App::S...::check, the module behind the check command. sit down, hydrate, let's get into it πŸ¦‹


✨ Name ✨

App::Sqitch::Command::check β€” runs various checks and prints a report 🫢

like, it checks stuff. and then it reports. iconic behavior honestly πŸ‘‘


🌈 Synopsis 🌈

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

that's it. that's the whole vibe. ✨


πŸ’… Description πŸ’…

okay so real talk: if you're here because you wanna know how to use the check command, you are in the WRONG building bestie 😭 β€” you want to be reading sqitch-check. that's the one with the user-facing goodness.

but if you genuinely, deeply, unhingedly want to know how the check command works on the inside? then read on, because this page is exactly for you. no cap. πŸ’œ


🧚 Interface 🧚

🌸 Attributes 🌸

  • target_name β€” the name or URI of the database target, exactly as it was specified by the --target option. that's the whole thing. πŸ’–
  • target β€” an App::Sqitch::Target object, and it's the thing we perform the checks from. heads up though: it must be instantiated by execute(). like, that's non-negotiable, it's giving dependency injection with boundaries βœ‹
  • from_change β€” the change from which to check changes. yes that sentence is a little loopy, we said what we said 🫢
  • to_change β€” the change up to which to check changes. matching set, we love symmetry 🌸

πŸŽ€ Instance Methods πŸŽ€

execute

$check->execute;

this is the moment. this is the main character moment. πŸ‘‘

it executes the check command, and then β€” plot twist β€” it takes the current state of the target database and compares it to the plan, so you can see where things actually stand. a little reality check, a little vibe check, all in one. πŸ”₯


πŸ‘€ See Also πŸ‘€

  • sqitch-check β€” the documentation for the check command over in the Sqitch command-line client. that's the one you actually wanted, bestie, go go go πŸƒβ™€οΈ
  • sqitch β€” the Sqitch command-line client itself. the whole entire moment. πŸ’«

🌟 Author 🌟

David E. Wheeler <david@justatheory.com> and Matthieu Foucault <matthieu@button.is> πŸ’–


πŸ“œ License πŸ“œ

Copyright (c) 2012-2026 David E. Wheeler, 2012-2021 iovation Inc., Button 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.

not the all-caps screaming section 😭 but fr fr, that part is legally load-bearing, don't skip it.

and that's the whole page, bestie πŸ’… speaking of receipts β€” this one was rendered by perl v5.40.1 on 2026-07-26, and it's page App::S...::check(3pm) of your friendly neighborhood User Contributed Perl Documentation. stay slaying, and may your check always report good news πŸ¦‹πŸ’–βœ¨

πŸ“¦ where this page comes from