.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "MediaWiki::DumpFile::SQL 3pm"
.TH MediaWiki::DumpFile::SQL 3pm "2022-06-15" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
MediaWiki::DumpFile::SQL \- Process SQL dump files from a MediaWiki instance
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use MediaWiki::DumpFile::SQL;
\&  
\&  $sql = MediaWiki::DumpFile::SQL\->new(\*(Aqdumpfile.sql\*(Aq);
\&  #many compression formats are supported
\&  $sql = MediaWiki::DumpFile::SQL\->new(\*(Aqdumpfile.sql.gz\*(Aq);
\&  $sql = MediaWiki::DumpFile::SQL\->new(\*(Aqdumpfile.sql.bz2\*(Aq);
\&  $sql = MediaWiki::DumpFile::SQL\->new(\e*FH);
\&  
\&  @schema = $sql\->schema;
\&  $name = $sql\->table_name;
\&  
\&  while(defined($row = $sql\->next)) {
\&        #do something with the data from the row
\&  }
.Ve
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.SS "new"
.IX Subsection "new"
This is the constructor for this package. It is called with a single parameter: the location of
a MediaWiki \s-1SQL\s0 dump file or a reference to an already open file handle.
.PP
Only the definition and data for the \fBfirst\fR table in a \s-1SQL\s0 dump file is processed.
.SS "next"
.IX Subsection "next"
Returns a hash reference where the key is the column name from the table and the value of the hash is
the value for that column and row. Returns undef when there is no more data available.
.SS "table_name"
.IX Subsection "table_name"
Returns a string of the table name that was discovered in the dump file.
.SS "table_statement"
.IX Subsection "table_statement"
Returns a string of the unparsed \s-1CREATE TABLE\s0 statement straight from the
dump file.
.SS "schema"
.IX Subsection "schema"
Returns a list that represents the table schema as it was parsed by this module. Each item in the list
is a reference to an array with two elements. The first element is the name of the row and the second
element is the MySQL datatype associated with the row. The list is in an identical order as the definitions
in the \s-1CREATE TABLE\s0 statement.
.SH "AUTHOR"
.IX Header "AUTHOR"
Tyler Riddle, \f(CW\*(C`<triddle at gmail.com>\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Please see MediaWiki::DumpFile for information on how to report bugs in 
this software.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2009 \*(L"Tyler Riddle\*(R".
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of either: the \s-1GNU\s0 General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See http://dev.perl.org/licenses/ for more information.