.\" -*- 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::Service 3pm"
.TH RDF::Query::Plan::Service 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::Service \- Executable query plan for remote SPARQL queries.
.SH VERSION
.IX Header "VERSION"
This document describes RDF::Query::Plan::Service version 2.918.
.SH METHODS
.IX Header "METHODS"
Beyond the methods documented below, this class inherits methods from the
RDF::Query::Plan class.
.ie n .IP """new ( $endpoint, $plan, $silent, $sparql, [ \e%logging_keys ] )""" 4
.el .IP "\f(CWnew ( $endpoint, $plan, $silent, $sparql, [ \e%logging_keys ] )\fR" 4
.IX Item "new ( $endpoint, $plan, $silent, $sparql, [ %logging_keys ] )"
Returns a new SERVICE (remote endpoint call) query plan object. \f(CW\*(C`<$endpoint\*(C'\fR>
is the URL of the endpoint (as a node object). \f(CW\*(C`<$plan\*(C'\fR> is the query plan
representing the query to be sent to the remote endpoint (needed for cost
estimates). \f(CW\*(C`<$sparql\*(C'\fR> is the serialized SPARQL query to be sent to the remote
endpoint. Finally, if present, \f(CW\*(C`<%logging_keys\*(C'\fR> is a HASH containing the keys
to use in logging the execution of this plan. Valid HASH keys are:
.Sp
.Vb 1
\& * bf \- The bound/free string representing C<<$plan>>
.Ve
.ie n .IP """new_from_plan ( $endpoint, $plan, $context )""" 4
.el .IP "\f(CWnew_from_plan ( $endpoint, $plan, $context )\fR" 4
.IX Item "new_from_plan ( $endpoint, $plan, $context )"
Returns a new SERVICE query plan object. \f(CW\*(C`<$endpoint\*(C'\fR> is the URL of the endpoint
(as a string). \f(CW\*(C`<$plan\*(C'\fR> is the query plan representing the query to be sent to
the remote endpoint. The exact SPARQL serialization that will be used is obtained
by getting the originating RDF::Query::Algebra object from \f(CW\*(C`<$plan\*(C'\fR>, and serializing
it (with the aid of the RDF::Query::ExecutionContext object \f(CW\*(C`<$context\*(C'\fR>).
.ie n .IP """execute ( $execution_context )""" 4
.el .IP "\f(CWexecute ( $execution_context )\fR" 4
.IX Item "execute ( $execution_context )"
.PD 0
.ie n .IP """next""" 4
.el .IP \f(CWnext\fR 4
.IX Item "next"
.ie n .IP """close""" 4
.el .IP \f(CWclose\fR 4
.IX Item "close"
.ie n .IP """endpoint""" 4
.el .IP \f(CWendpoint\fR 4
.IX Item "endpoint"
.ie n .IP """sparql""" 4
.el .IP \f(CWsparql\fR 4
.IX Item "sparql"
.PD
Returns the SPARQL query (as a string) that will be sent to the remote endpoint.
.ie n .IP """lhs""" 4
.el .IP \f(CWlhs\fR 4
.IX Item "lhs"
.PD 0
.ie n .IP """silent""" 4
.el .IP \f(CWsilent\fR 4
.IX Item "silent"
.PD
Returns a boolean value indicating whether the service plan will ignore errors.
.ie n .IP """pattern""" 4
.el .IP \f(CWpattern\fR 4
.IX Item "pattern"
Returns the query plan that will be used in the remote service call.
.ie n .IP """distinct""" 4
.el .IP \f(CWdistinct\fR 4
.IX Item "distinct"
Returns true if the pattern is guaranteed to return distinct results.
.ie n .IP """ordered""" 4
.el .IP \f(CWordered\fR 4
.IX Item "ordered"
Returns true if the pattern is guaranteed to return ordered results.
.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. See RDF::Query::Plan for a list of the allowable
identifiers.
.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 """graph ( $g )""" 4
.el .IP "\f(CWgraph ( $g )\fR" 4
.IX Item "graph ( $g )"
.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.
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\& Gregory Todd Williams <gwilliams@cpan.org>
.Ve