Alzabo(3pm)

Alzabo 💅

okay bestie, welcome to Alzabo — it's a Perl module, it lives in the User Contributed Perl Documentation section of your man pages (so yeah, it's Alzabo(3pm)), and it does two (2) absolutely iconic things: it's a data modelling tool AND an RDBMS-OO mapper. A data modelling tool and RDBMS-OO mapper. That's the whole name. Chef's kiss. 🎀

---

✨ SYNOPSIS ✨

Cannot be summarized here.

like... okay. it said what it said. no notes. 😭

---

🌸 DESCRIPTION 🌸

💖 What is Alzabo?

so Alzabo is a whole suite of modules and it has two core functions, and honestly both of them eat.

Function one: it's a data modelling tool. Through either a schema creation GUI, a perl program, or reverse engineering, you can create a set of objects to represent a schema. Yes, a whole set of objects. Little schema babies. 🦋

Function two: it's an RDBMS to object mapping system. Once you've created a schema, you can use the Alzabo::Runtime::Table and Alzabo::Runtime::Row classes to access its data. And these classes? They offer a high level interface to the common stuff — SQL SELECT, INSERT, DELETE, and UPDATE commands. the classics.

And here's the part that's giving main character energy: because you can construct queries through object-oriented Perl, building complex queries on the fly is much easier than it would be if you had to dynamically construct strings of SQL. no more string spaghetti, we don't do that here. ✨

Then there's an even higher level interface, and you get it through the Alzabo::MethodMaker module. What it does: it takes a schema object and auto-generates useful methods based on the tables, columns, and relationships it finds in the module. And the code it generates can be integrated with your own code quite easily. plug and play fr fr.

And to take it a step further? You could then aggregate a set of rows from different tables into a larger container object which could understand the logical relationship between these tables. nesting doll vibes. 🪆

---

📚 What to Read?

okay so Alzabo has A LOT of documentation. Like. A lot. But listen — if you are primarily interested in using Alzabo as an RDBMS-OO wrapper, you can skip much of it. This assumes you'll create your schema via a schema creation GUI or via reverse engineering. You're welcome. 💅

Here is the suggested reading order:

1. Introduction to Alzabo 🍼
2. The RDBMS-specific documentation:
   • Alzabo and MySQL
   • Alzabo and PostgreSQL
3. The Alzabo::Runtime::Schema docs — the most important parts here are the ones about loading a schema and connecting to a database. Also be sure to read about the join() method. 👑
4. The Alzabo::Runtime::Table docs — this contains most of the methods used to fetch rows from the database, plus the insert() method.
5. The Alzabo::Runtime::Row docs — the row objects carry the methods used to update, delete, and retrieve data from the database.
6. The Alzabo::Runtime::RowCursor docs — a cursor object that returns only a single row.
7. The Alzabo::Runtime::JoinCursor docs — a cursor object that returns multiple rows at once.
8. The Alzabo::MethodMaker docs — one of the most useful parts of Alzabo. This module can be used to auto-generate methods based on the structure of your schema.
9. The Alzabo::Runtime::UniqueRowCache docs — this describes the simple caching system included with Alzabo.
10. The Alzabo::Debug docs — how to turn on various kinds of debugging output.
11. The Alzabo::Exceptions docs — describes the nature of all the exceptions used in Alzabo.
12. The FAQ.
13. The quick reference — a quick reference for the various methods of the Alzabo objects.

read them in order, bestie. or don't. I'm not your mom, I'm just the manpage. 🫶

---

🎀 SCRIPTS 🎀

Alzabo comes with a few handy scripts in the eg/ directory of the distribution. These are:

• alzabo_grep — given a regex and a schema name, this script will print out the table and column name for all columns which match the regex. 🔍
• alzabo_to_ascii — given a schema name, this script will generate a set of simple ASCII tables for the schema. ASCII art but make it database. 🌈

---

💜 SUPPORT 💜

The Alzabo docs are conveniently located online at http://www.alzabo.org/docs/. obsessed.

There is also a mailing list. You can sign up at http://lists.sourceforge.net/lists/listinfo/alzabo-general. 🫶

Please don't email me directly. Use the list instead so others can see your questions. sharing is caring, bestie, and also everyone else deserves to see the answer. 🙈

---

⭐ COPYRIGHT ⭐

Copyright (c) 2000-2003 David Rolsky. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

---

👑 AUTHOR 👑

Dave Rolsky, <autarch@urth.org>

---

and that's the whole page, bestie — this was Alzabo, documented for perl v5.34.0, dated 2022-06-14. now go build a schema and slay. 💖✨