Current File : //proc/self/root/usr/local/share/man/man3/DBIx::MyParsePP::Query.3pm
.\" 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
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "DBIx::MyParsePP::Query 3"
.TH DBIx::MyParsePP::Query 3 "2007-08-17" "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.
Mini Shell