.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13) .\" .\" 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" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" ======================================================================== .\" .IX Title "DBIx::MyParsePP::Query 3" .TH DBIx::MyParsePP::Query 3 "2018-04-15" "perl v5.10.1" "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" DBIx::MyParsePP::Query \- Query produced by DBIx::MyParsePP .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use DBIx::MyParsePP; \& \& my $parser = DBIx::MyParsePP\->new(); \& \& my $query = $parser\->parse("SELECT 1"); \& \& if (not defined $query\->root()) { \& print "Error at pos ".$query\->pos()", line ".$pos\->line()."\en"; \& } else { \& print "Query was ".$query\->toString(); \& } .Ve .SH "METHODS" .IX Header "METHODS" \&\f(CW\*(C`getLexer()\*(C'\fR returns the DBIx::MyParsePP::Lexer object for the string .PP \&\f(CW\*(C`getRoot()\*(C'\fR returns a DBIx::MYParsePP::Rule object representing the root of the parse tree .PP \&\f(CW\*(C`toString()\*(C'\fR walks the parse tree reconstructs the query using the individual tokens. .PP \&\f(CW\*(C`tokens()\*(C'\fR and \f(CW\*(C`getTokens()\*(C'\fR returns a reference to an array containing all tokens parsed as DBIx::MyParsePP::Token objects. If the parsing failed, the list contains all tokens up to the failure point. .SH "ERROR HANDLING" .IX Header "ERROR HANDLING" On error, \f(CW\*(C`getRoot()\*(C'\fR will return \f(CW\*(C`undef\*(C'\fR. You can call the following methods to determine the error: .PP \&\f(CW\*(C`getExpected()\*(C'\fR returns a list of tokens the parser expected to find, whereas \f(CW\*(C`getActual()\*(C'\fR returns the actual token name that was encountered which caused the error. Please note that \f(CW\*(C`getActual()\*(C'\fR returns a DBIx::MyParsePP::Token object, whereas \f(CW\*(C`getExpected()\*(C'\fR returns a list of strings, containing just the token types. .PP \&\f(CW\*(C`getLine()\*(C'\fR returns the line number where the error occured. \f(CW\*(C`getPos()\*(C'\fR returns the character position where the error occured, counting from the beginning of the string, not the begining of the line. .PP \&\f(CW\*(C`getTokens()\*(C'\fR can be used to reconstruct the query as it was up to the failure point. .SH "UTILITY FUNCTIONS" .IX Header "UTILITY FUNCTIONS" \&\f(CW\*(C`getSelectItems()\*(C'\fR, \f(CW\*(C`getFrom()\*(C'\fR, \f(CW\*(C`getWhere()\*(C'\fR, \f(CW\*(C`getGroupBy()\*(C'\fR, \f(CW\*(C`getOrderBy()\*(C'\fR, \f(CW\*(C`getHaving()\*(C'\fR return the respective parts of the parse tree as a DBIx::MyParsePP::Rule object. Depending on the query, the part of the tree that is being returned may look differently, e.g. \f(CW\*(C`getFrom()\*(C'\fR will return widely different things depending on how many tables are in the \f(CW\*(C`FROM\*(C'\fR clause, whether there are joins or subqueries. You can then use \f(CW\*(C`shrink()\*(C'\fR and \&\f(CW\*(C`extract()\*(C'\fR on the return value to further narrow down on the part of the query you are interested in.