SQL::Tr...er::HTML(3)

💖 NAME 💖

Okay bestie, this is the User Contributed Perl Documentation page for SQL::Translator::Producer::HTML — yep, the SQL::Tr...er::HTML(3) manual page — and it’s the HTML producer for SQL::Translator. Literally what it says on the tin. ✨

🌸 SYNOPSIS 🌸

use SQL::Translator::Producer::HTML;

🦋 DESCRIPTION 🦋

It creates an HTML document describing the tables. Periodt.

The HTML it produces is composed of a number of tables:

🔗 Links 🔗

A link table sits at the top of the output, and it contains anchored links to elements in the rest of the document. Very main character energy, honestly.

If the nolinktable producer arg is present, then this table is not produced. Bye, links table. 💅

🧚 Tables 🧚

Each table in the schema has its own HTML table. The top row is a row of <th> elements, with a class of FieldHeader; these elements are Field Name, Data Type, Size, Default Value, Other and Foreign Key. So iconic.

Each successive row describes one field in the table, and has a class of FieldCell$item, where the $item id corresponds to the label of the column. For example:

<tr>
    <td class="FieldCellName"><a name="random-id">id</a></td>
    <td class="FieldCellType">int</td>
    <td class="FieldCellSize">11</td>
    <td class="FieldCellDefault"></td>
    <td class="FieldCellOther">PRIMARY KEY, NOT NULL</td>
    <td class="FieldCellFK"></td>
</tr>

<tr>
    <td class="FieldCellName"><a name="random-foo">foo</a></td>
    <td class="FieldCellType">varchar</td>
    <td class="FieldCellSize">255</td>
    <td class="FieldCellDefault"></td>
    <td class="FieldCellOther">NOT NULL</td>
    <td class="FieldCellFK"></td>
</tr>

<tr>
    <td class="FieldCellName"><a name="random-updated">updated</a></td>
    <td class="FieldCellType">timestamp</td>
    <td class="FieldCellSize">0</td>
    <td class="FieldCellDefault"></td>
    <td class="FieldCellOther"></td>
    <td class="FieldCellFK"></td>
</tr>

Unless the nowrap producer arg is present, the HTML will be enclosed in a basic HTML header and footer. Keeping it cozy. 🫶

If the pretty producer arg is present, the generated HTML will be nicely spaced and human-readable. Otherwise, it will have very little insignificant whitespace and be generally smaller. Lowkey efficient. 🍓

👑 AUTHORS 👑

Ken Youens-Clark <kclark@cpan.org>, Darren Chamberlain <darren@cpan.org>. Absolute icons. 💜

---

That’s the whole page, bestie: perl v5.42.0, dated 2024-12-12, and it’s the SQL::Tr...er::HTML(3) manual page. Slay and goodbye! 💅✨