1RDF::Query::Plan(3)   User Contributed Perl Documentation  RDF::Query::Plan(3)
2
3
4

NAME

6       RDF::Query::Plan - Executable query plan nodes.
7

VERSION

9       This document describes RDF::Query::Plan version 2.918.
10

METHODS

12       "new"
13       "execute ( $execution_context )"
14       "next"
15       "get_all"
16           Returns all remaining rows.
17
18       "close"
19       "state ( [ $state ] )"
20           Returns the current state of the plan (either READY, OPEN, or
21           CLOSED).  If $state is provided, updates the plan to a new state.
22
23       "logging_keys"
24       "explain"
25           Returns a string serialization of the query plan appropriate for
26           display on the command line.
27
28       "sse"
29       "serialize"
30           Return a serialization of the query plan.
31
32       "delegate"
33           Returns the delegate object if available.
34
35       "referenced_variables"
36           Returns a list of variable names that are referenced by this plan.
37
38       "as_iterator ( $context )"
39           Returns an RDF::Trine::Iterator object for the current (already
40           executed) plan.
41
42       "is_update"
43           Returns true if the plan represents an update operation.
44
45       "label ( $label => $value )"
46           Sets the named $label to $value for this plan object.  If no $value
47           is given, returns the current label value, or undef if none exists.
48
49       "graph_labels"
50       "generate_plans ( $algebra, $execution_context, %args )"
51           Returns a list of equivalent query plan objects for the given
52           algebra object.
53
54       "plan_node_name"
55           Returns the string name of this plan node, suitable for use in
56           serialization.
57
58       "plan_prototype"
59           Returns a list of scalar identifiers for the type of the content
60           (children) nodes of this plan node. These identifiers are
61           recognized:
62
63            * 'A' - An RDF::Query::Algebra object
64            * 'b' - A boolean integer value (0 or 1)
65            * 'E' - An expression (either an RDF::Query::Expression object or an RDF node)
66            * 'i' - An integer
67            * 'J' - A valid Project node (an RDF::Query::Expression object or an Variable node)
68            * 'N' - An RDF node
69            * 'P' - A RDF::Query::Plan object
70            * 'q' - A RDF::Query object
71            * 'Q' - An RDF::Trine::Statement::Quad object
72            * 's' - A string
73            * 'T' - An RDF::Trine::Statement object
74            * 'u' - A valid URI string
75            * 'V' - A variable binding set (an object of type RDF::Query::VariableBindings)
76            * 'w' - A bareword string
77            * 'W' - An RDF node or wildcard ('*')
78            * '*X' - A list of X nodes (where X is another identifier scalar)
79            * '\X' - An array reference of X nodes (where X is another identifier scalar)
80
81       "plan_node_data"
82           Returns the data for this plan node that corresponds to the values
83           described by the signature returned by "plan_prototype".
84
85       "subplans_of_type ( $type [, $block] )"
86           Returns a list of Plan objects matching $type (tested with "isa").
87           If $block is given, then matching stops descending a subtree if the
88           current node is of type $block, continuing matching on other
89           subtrees.  This list includes the current plan object if it matches
90           $type, and is generated in infix order.
91

AUTHOR

93        Gregory Todd Williams <gwilliams@cpan.org>
94
95
96
97perl v5.32.0                      2020-07-28               RDF::Query::Plan(3)