DBIx::POS(3)

💖 DBIx::POS 💖

okay bestie, welcome to the DBIx::POS(3) manual page 🫶 this is the whole vibe, and yes we're doing it together, no cap.

---

✨ NAME ✨

DBIx::POS — define a dictionary of SQL statements in a POD dialect (POS) 🌸

---

🦋 SYNOPSIS 🦋

So first things first: to define your dictionary, you literally just... write POD. That's the whole trick. 💅

package OurSQL;

use strict;
use warnings;
use base qw{DBIx::POS};
__PACKAGE__->instance (__FILE__);

=name testing

=desc test the DBI::POS module

=param

Some arbitrary parameter

=sql

There is really no syntax checking done on the content of the =sql section.

=cut

And to use your dictionary? Also chill. 👑

package main;

use strict;
use warnings;
use OurSQL;

my $sql = OurSQL->instance;

$dbh->do ($sql->{testing});

---

🌈 DESCRIPTION 🌈

DBIx-POS subclasses Pod::Parser to define a POD dialect for writing a SQL dictionary for an application, and it uses code from Class::Singleton to make the resulting structure easily accessible. So it's giving POD but make it SQL, and it's giving singleton but make it ✨accessible✨.

By encouraging the centralization of SQL code, it guards against SQL statement duplication (and the update problems that can generate). Like, imagine editing the same query in nine places. Nightmare. We don't do that here. 🙈

By separating the SQL code from its normal context of execution, it encourages you to do other things with it — for instance, it is easy to create a script that can do performance testing of certain SQL statements in isolation, or to create generic command-line wrapper around your SQL statements. Your queries get to have a life outside the function they were born in. main character energy fr fr. 💜

By giving a framework for documenting the SQL, it encourages documentation of the intent and/or implementation of the SQL code. It also provides all of that information in a format from which other documentation could be generated — say, a chunk of DocBook for incorporation into a guide to programming the application. Documentation that generates documentation?? iconic behavior honestly. 🎀

---

🧚 EXPORT 🧚

Nothing is exported. Aren't singletons cool? 😭

---

⭐ SEE ALSO ⭐

• DBI
• Pod::Parser
• Class::Singleton

---

👑 AUTHOR 👑

Michael Alan Dorman, <mdorman@debian.org> 💌

The instance routine is from Class::Singleton

Andy Wardley, "<abw@cre.canon.co.uk>" 🌸

Web Technology Group, Canon Research Centre Europe Ltd.

Thanks to Andreas Koenig "<andreas.koenig@anima.de>" for providing some significant speedup patches and other ideas. 🫶

---

💅 COPYRIGHT AND LICENSE 💅

Copyright (C) 2004 by Michael Alan Dorman

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The instance routine is from Class::Singleton

Copyright (C) 1998 Canon Research Centre Europe Ltd. All Rights Reserved.

This module is free software; you can redistribute it and/or modify it under the term of the Perl Artistic License.

---

ok that's the whole page bestie, every last option-free, export-free, singleton-flavored crumb of it. go forth and centralize ur SQL. 🦋✨

mwah 💋 this was perl v5.42.0, dated 2025-07-25, and it's the DBIx::POS(3) page — slay, bye!! 🎀💖