MediaW...e::SQL(3pm)

💖 NAME 💖

MediaWiki::DumpFile::SQL — bestie, this is the little module that eats SQL dump files straight out of a MediaWiki instance and hands you the goodies. It's a Perl module, it lives in the MediaWiki::DumpFile family, and it is so ready to parse for you. 💅

---

✨ SYNOPSIS ✨

Okay so here's the vibe, literally the whole flow:

use MediaWiki::DumpFile::SQL;

$sql = MediaWiki::DumpFile::SQL->new('dumpfile.sql');
#many compression formats are supported
$sql = MediaWiki::DumpFile::SQL->new('dumpfile.sql.gz');
$sql = MediaWiki::DumpFile::SQL->new('dumpfile.sql.bz2');
$sql = MediaWiki::DumpFile::SQL->new(\*FH);

@schema = $sql->schema;
$name = $sql->table_name;

while(defined($row = $sql->next)) {
      #do something with the data from the row
}

Compression? Handled. A file on disk? Handled. An already-open filehandle? Also handled, queen. 🌸

---

🫶 FUNCTIONS 🫶

new

This is the constructor, the birth of the whole situation. You call it with a single parameter: either the location of a MediaWiki SQL dump file, or a reference to an already open file handle. That's it, that's the whole call. 🎀

Heads up though — only the definition and data for the first table in a SQL dump file gets processed. One table, that's the deal. No cap.

next

Hands you back a hash reference where the key is the column name from the table and the value is the value for that column and row. And when there's genuinely no more data left to give? It returns undef. RIP, you've reached the end. 💀

table_name

Returns a string — the name of the table that got discovered in the dump file. Simple. Iconic. ✨

table_statement

Returns a string of the unparsed CREATE TABLE statement, straight from the dump file. Raw, untouched, exactly as it appeared. We don't mess with it, we just hand it over. 🦋

schema

Returns a list representing the table schema as it was parsed by this module. Every single item in that list is a reference to an array with two elements:

• the first element is the name of the row
• the second element is the MySQL datatype associated with the row

And the order? The list is in an identical order as the definitions in the CREATE TABLE statement. No shuffling, no surprises. 👑

---

🌈 AUTHOR 🌈

Tyler Riddle, "<triddle at gmail.com>" — shoutout to the dev, absolute legend for building this. 🫶

---

🙈 BUGS 🙈

Found a bug? Please see MediaWiki::DumpFile for the info on how to report bugs in this software. Don't be shy, bestie, they wanna know. 😭

---

👑 COPYRIGHT & LICENSE 👑

Copyright 2009 "Tyler Riddle".

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information. 📜

---

And that's the whole page, periodt. This lil gem was documented with perl v5.34.0, dated 2022-06-15, and yes it's the MediaW...e::SQL(3pm) manpage you're reading right now — the truncated header is literally how it shows up in the manual, so we're keeping that energy. Go parse something gorgeous. 💖✨🎀