App::S...ine::pg(3pm)

πŸ’– App::Sqitch::Engine::pg β€” the PostgreSQL engine, bestie edition πŸ’–

okay so this is App::Sqitch::Engine::pg, a page from the User Contributed Perl Documentation collection (yes, the whole thing is literally filed under App::S...ine::pg(3pm) in the index, love that for us πŸŽ€). She's the PostgreSQL storage engine for Sqitch, and she is thriving.


✨ NAME ✨

App::Sqitch::Engine::pg β€” Sqitch PostgreSQL Engine. no notes. iconic behavior. πŸ’…


🌸 SYNOPSIS 🌸

look bestie, you don't hand-build her, you load her:

my $pg = App::Sqitch::Engine->load( engine => 'pg' );

that's it. that's the whole vibe. πŸ¦‹


🫢 DESCRIPTION 🫢

App::Sqitch::Engine::pg provides the PostgreSQL storage engine for Sqitch. so when you want Sqitch to keep all your deploy/revert/verify receipts in a Postgres database, this is the girl doing the work. πŸ’–

the way that she supports:

  • PostgreSQL 8.4.0 and higher
  • Postgres-XC 1.2 and higher
  • YugabyteDB

she's not picky, she's just good. πŸ”₯


πŸ‘‘ INTERFACE πŸ‘‘

🌟 Instance Methods 🌟

"initialized"

called like this:

$pg->initialize unless $pg->initialized;

returns true if the database has been initialized for Sqitch πŸ’€ (she knows you, she remembers you), and false if it hasn't. like a little vibe check but for your registry schema.

"initialize"

called like this:

$pg->initialize;

Initializes a database for Sqitch by installing the Sqitch registry schema. basically setting up her whole little room. ✨

"psql"

Returns a list containing the psql client and options to be passed to it. Used internally when executing scripts β€” so no, you don't call this one at parties, she's backstage crew. 🧚 iykyk.


πŸ’œ AUTHOR πŸ’œ

David E. Wheeler <david@justatheory.com> β€” the main character who wrote her. πŸ‘‘


πŸ’Œ 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.

⚠️ bestie that last bit is the ALL-CAPS legal paragraph and it means it β€” no warranty, no cap, fr fr. if it breaks, that's on the universe, not on David. πŸ™ˆ

and that's the whole page, pookie πŸ’– this doc was rendered by perl v5.40.1 on 2026-07-26, and if you're reading her under App::S...ine::pg(3pm) β€” yep, same girl, same page, just with a cuter font. mwah. πŸŽ€βœ¨πŸŒˆ

πŸ“¦ where this page comes from