SQL::Tr...QLFairy(3)

🌸 NAME 🌸

okay bestie, welcome to the SQL::Tr...QLFairy(3) page from the User Contributed Perl Documentation manual ✨ this one is all about SQL::Translator::Parser::XML::SQLFairy — the parser for SQL::Translator's XML. Literally the parser for SQL::Translator's XML, no cap 💅

---

✨ SYNOPSIS ✨

here's the whole vibe, exactly as written:

use SQL::Translator;

my $translator = SQL::Translator->new( show_warnings  => 1 );

my $out = $obj->translate(
    from     => 'XML-SQLFairy',
    to       => 'MySQL',
    filename => 'schema.xml',
) or die $translator->error;

print $out;

---

💖 DESCRIPTION 💖

This parser handles the flavor of XML used natively by the SQLFairy project (SQL::Translator). The XML must be in the XML namespace http://sqlfairy.sourceforge.net/sqlfairy.xml. Go peek at SQL::Translator::Producer::XML::SQLFairy for the details of this format 🦋

You do not need to specify every attribute of the Schema objects, because any missing from the XML will be set to their default values. e.g. a field could be written using only this:

<sqlf:field name="email" data_type="varchar" size="255" />

Instead of the full thing:

<sqlf:field name="email" data_type="varchar" size="255" is_nullable="1"
  is_auto_increment="0" is_primary_key="0" is_foreign_key="0" order="4">
  <sqlf:comments></sqlf:comments>
</sqlf:field>

If you do not explicitly set the order of items using order attributes on the tags, then the order the tags appear in the XML will be used 🔥

🎀 default_value 🎀

Leave the attribute out all together to use the default in SQL::Translator::Schema::Field. Use empty quotes or 'EMPTY_STRING' for a zero length string. 'NULL' for an explicit null (currently sets default_value to undef in the field object) 👑

<sqlf:field default_value="" />                <!-- Empty string -->
<sqlf:field default_value="EMPTY_STRING" />    <!-- Empty string -->
<sqlf:field default_value="NULL" />            <!-- NULL -->

🦋 ARGS 🦋

Doesn't take any extra parser args at the moment. That's it, that's the whole tea 🍵

---

💅 LEGACY FORMAT 💅

The previous version of the SQLFairy XML allowed the attributes of the schema objects to be written as either xml attributes or as data elements, in any combination. While this allows for lots of flexibility in writing the XML, the result is a great many possible XML formats — not so good for DTD writing, XPathing etc! So we have moved to a fixed version described in SQL::Translator::Producer::XML::SQLFairy.

This version of the parser will still parse the old formats and emit warnings when it sees them being used, but they should be considered heavily depreciated (yes, that's the spelling on the page 😭).

To convert your old format files simply pass them through the translator :)

$ sqlt -f XML-SQLFairy -t XML-SQLFairy schema-old.xml > schema-new.xml

---

💀 BUGS 💀

Ignores the order attribute for Constraints, Views, Indices, Views, Triggers and Procedures, using the tag order instead. (This is the order output by the SQLFairy XML producer). yeah, Views really is listed twice — we keep the facts exactly as they are 🫶

---

🔥 SEE ALSO 🔥

• perl
• SQL::Translator
• SQL::Translator::Producer::XML::SQLFairy
• SQL::Translator::Schema

---

🍓 TODO 🍓

• Support options attribute.
• Test foreign keys are parsed ok.
• Control over defaulting.

---

👑 AUTHOR 👑

Mark D. Addison <mark.addison@itn.co.uk>, Jonathan Yu <frequency@cpan.org> — iconic behavior, honestly 🌈

---

💖 cute sign-off time: this page came from perl v5.42.0, dated 2024-12-12, and it's the SQL::Tr...QLFairy(3) page. mwah 💋