.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "RDF::Query::Plan 3pm"
.TH RDF::Query::Plan 3pm 2024-04-12 "perl v5.38.2" "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
RDF::Query::Plan \- Executable query plan nodes.
.SH VERSION
.IX Header "VERSION"
This document describes RDF::Query::Plan version 2.918.
.SH METHODS
.IX Header "METHODS"
.ie n .IP """new""" 4
.el .IP \f(CWnew\fR 4
.IX Item "new"
.PD 0
.ie n .IP """execute ( $execution_context )""" 4
.el .IP "\f(CWexecute ( $execution_context )\fR" 4
.IX Item "execute ( $execution_context )"
.ie n .IP """next""" 4
.el .IP \f(CWnext\fR 4
.IX Item "next"
.ie n .IP """get_all""" 4
.el .IP \f(CWget_all\fR 4
.IX Item "get_all"
.PD
Returns all remaining rows.
.ie n .IP """close""" 4
.el .IP \f(CWclose\fR 4
.IX Item "close"
.PD 0
.ie n .IP """state ( [ $state ] )""" 4
.el .IP "\f(CWstate ( [ $state ] )\fR" 4
.IX Item "state ( [ $state ] )"
.PD
Returns the current state of the plan (either READY, OPEN, or CLOSED).
If \f(CW$state\fR is provided, updates the plan to a new state.
.ie n .IP """logging_keys""" 4
.el .IP \f(CWlogging_keys\fR 4
.IX Item "logging_keys"
.PD 0
.ie n .IP """explain""" 4
.el .IP \f(CWexplain\fR 4
.IX Item "explain"
.PD
Returns a string serialization of the query plan appropriate for display
on the command line.
.ie n .IP """sse""" 4
.el .IP \f(CWsse\fR 4
.IX Item "sse"
.PD 0
.ie n .IP """serialize""" 4
.el .IP \f(CWserialize\fR 4
.IX Item "serialize"
.PD
Return a serialization of the query plan.
.ie n .IP """delegate""" 4
.el .IP \f(CWdelegate\fR 4
.IX Item "delegate"
Returns the delegate object if available.
.ie n .IP """referenced_variables""" 4
.el .IP \f(CWreferenced_variables\fR 4
.IX Item "referenced_variables"
Returns a list of variable names that are referenced by this plan.
.ie n .IP """as_iterator ( $context )""" 4
.el .IP "\f(CWas_iterator ( $context )\fR" 4
.IX Item "as_iterator ( $context )"
Returns an RDF::Trine::Iterator object for the current (already executed) plan.
.ie n .IP """is_update""" 4
.el .IP \f(CWis_update\fR 4
.IX Item "is_update"
Returns true if the plan represents an update operation.
.ie n .IP """label ( $label => $value )""" 4
.el .IP "\f(CWlabel ( $label => $value )\fR" 4
.IX Item "label ( $label => $value )"
Sets the named \f(CW$label\fR to \f(CW$value\fR for this plan object.
If no \f(CW$value\fR is given, returns the current label value, or undef if none
exists.
.ie n .IP """graph_labels""" 4
.el .IP \f(CWgraph_labels\fR 4
.IX Item "graph_labels"
.PD 0
.ie n .IP """generate_plans ( $algebra, $execution_context, %args )""" 4
.el .IP "\f(CWgenerate_plans ( $algebra, $execution_context, %args )\fR" 4
.IX Item "generate_plans ( $algebra, $execution_context, %args )"
.PD
Returns a list of equivalent query plan objects for the given algebra object.
.ie n .IP """plan_node_name""" 4
.el .IP \f(CWplan_node_name\fR 4
.IX Item "plan_node_name"
Returns the string name of this plan node, suitable for use in serialization.
.ie n .IP """plan_prototype""" 4
.el .IP \f(CWplan_prototype\fR 4
.IX Item "plan_prototype"
Returns a list of scalar identifiers for the type of the content (children)
nodes of this plan node. These identifiers are recognized:
.Sp
.Vb 10
\& * \*(AqA\*(Aq \- An RDF::Query::Algebra object
\& * \*(Aqb\*(Aq \- A boolean integer value (0 or 1)
\& * \*(AqE\*(Aq \- An expression (either an RDF::Query::Expression object or an RDF node)
\& * \*(Aqi\*(Aq \- An integer
\& * \*(AqJ\*(Aq \- A valid Project node (an RDF::Query::Expression object or an Variable node)
\& * \*(AqN\*(Aq \- An RDF node
\& * \*(AqP\*(Aq \- A RDF::Query::Plan object
\& * \*(Aqq\*(Aq \- A RDF::Query object
\& * \*(AqQ\*(Aq \- An RDF::Trine::Statement::Quad object
\& * \*(Aqs\*(Aq \- A string
\& * \*(AqT\*(Aq \- An RDF::Trine::Statement object
\& * \*(Aqu\*(Aq \- A valid URI string
\& * \*(AqV\*(Aq \- A variable binding set (an object of type RDF::Query::VariableBindings)
\& * \*(Aqw\*(Aq \- A bareword string
\& * \*(AqW\*(Aq \- An RDF node or wildcard (\*(Aq*\*(Aq)
\& * \*(Aq*X\*(Aq \- A list of X nodes (where X is another identifier scalar)
\& * \*(Aq\eX\*(Aq \- An array reference of X nodes (where X is another identifier scalar)
.Ve
.ie n .IP """plan_node_data""" 4
.el .IP \f(CWplan_node_data\fR 4
.IX Item "plan_node_data"
Returns the data for this plan node that corresponds to the values described by
the signature returned by \f(CW\*(C`plan_prototype\*(C'\fR.
.ie n .IP """subplans_of_type ( $type [, $block] )""" 4
.el .IP "\f(CWsubplans_of_type ( $type [, $block] )\fR" 4
.IX Item "subplans_of_type ( $type [, $block] )"
Returns a list of Plan objects matching \f(CW$type\fR (tested with \f(CW\*(C`isa\*(C'\fR).
If \f(CW$block\fR is given, then matching stops descending a subtree if the current
node is of type \f(CW$block\fR, continuing matching on other subtrees.
This list includes the current plan object if it matches \f(CW$type\fR, and is
generated in infix order.
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\& Gregory Todd Williams <gwilliams@cpan.org>
.Ve