rdf::query::plan::service(3pm) [debian man page]

RDF::Query::Plan::Service(3pm)				User Contributed Perl Documentation			    RDF::Query::Plan::Service(3pm)

NAME

       RDF::Query::Plan::Service - Executable query plan for remote SPARQL queries.

VERSION

       This document describes RDF::Query::Plan::Service version 2.908.

METHODS

       Beyond the methods documented below, this class inherits methods from the RDF::Query::Plan class.

       "new ( $endpoint, $plan, $silent, $sparql, [ \%logging_keys ] )"
	   Returns a new SERVICE (remote endpoint call) query plan object. "<$endpoint"> is the URL of the endpoint (as a node object). "<$plan">
	   is the query plan representing the query to be sent to the remote endpoint (needed for cost estimates). "<$sparql"> is the serialized
	   SPARQL query to be sent to the remote endpoint. Finally, if present, "<%logging_keys"> is a HASH containing the keys to use in logging
	   the execution of this plan. Valid HASH keys are:

	    * bf - The bound/free string representing C<<$plan>>

       "new_from_plan ( $endpoint, $plan, $context )"
	   Returns a new SERVICE query plan object. "<$endpoint"> is the URL of the endpoint (as a string). "<$plan"> 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 "<$plan">, and serializing it (with the aid of the RDF::Query::ExecutionContext object
	   "<$context">).

       "execute ( $execution_context )"
       "next"
       "close"
       "endpoint"
       "sparql"
	   Returns the SPARQL query (as a string) that will be sent to the remote endpoint.

       "lhs"
       "silent"
	   Returns a boolean value indicating whether the service plan will ignore errors.

       "pattern"
	   Returns the query plan that will be used in the remote service call.

       "distinct"
	   Returns true if the pattern is guaranteed to return distinct results.

       "ordered"
	   Returns true if the pattern is guaranteed to return ordered results.

       "plan_node_name"
	   Returns the string name of this plan node, suitable for use in serialization.

       "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.

       "plan_node_data"
	   Returns the data for this plan node that corresponds to the values described by the signature returned by "plan_prototype".

       "graph ( $g )"
       "explain"
	   Returns a string serialization of the query plan appropriate for display on the command line.

AUTHOR

	Gregory Todd Williams <gwilliams@cpan.org>

perl v5.14.2							    2012-01-31					    RDF::Query::Plan::Service(3pm)

RDF::Query::Util(3pm)					User Contributed Perl Documentation				     RDF::Query::Util(3pm)

NAME

       RDF::Query::Util - Miscellaneous utility functions to support work with RDF::Query.

VERSION

       This document describes RDF::Query::Util version 2.908.

SYNOPSIS

	use RDF::Query::Util;
	my $query = &RDF::Query::Util::cli_make_query;
	my $model = &RDF::Query::Util::cli_make_model;
	$query->execute( $model );
	...

FUNCTIONS

       "cli_make_query_and_model"
	   Returns a query object, model, and args HASHref based on the arguments in @ARGV.  These arguments are parsed using "cli_make_query" and
	   "make_model".

       "cli_make_query"
	   Returns a RDF::Query object based on the arguments in @ARGV. These arguments are parsed using &cli_parse_args. If the -e flag is not
	   present, the query will be loaded from a file named by the argument in @ARGV immediately following the final argument parsed by
	   &cli_parse_args.

       "cli_make_model"
	   Calls "make_model" with arguments from @ARGV, returning the constructed model object.

	   "cli_make_model" will usually be called after cli_make_query, allowing a typical CLI invocation to look like `prog.pl [flags] [query
	   file] [data files]`.

       "make_model ( @files )"
	   Returns a model object suitable for use in a call to "$query->execute", loaded with RDF from files and/or URLs listed in @files. This
	   model may be any of the supported models, but as currently implemented will be a RDF::Trine::Model object.

       "cli_parse_args"
	   Parses CLI arguments from @ARGV and returns a HASH with the recognized key/values.  The allowable arguments are listed below.

       "start_endpoint ( $model, $port )"
	   Starts an SPARQL endpoint HTTP server on port $port.

	   If called in list context, returns the PID and the actual port the server bound to. If called in scalar context, returns only the port.

COMMAND LINE ARGUMENTS

       -e str
	   Specifies the query string str.

       -l lang
	   Specifies the query language lang used. This should be one of: sparql, sparql11, or rdql.

       -O  Turns on optimization.

       -o  Turns off optimization.

       -c class
	   Specifies the perl class used to construct the query object. Defaults to "RDF::Query".

       -f  Implies -c RDF::Query::Federate.

       -F loc
	   Specifies the URL or path to a file loc which contains an RDF service description. The described service is used as an underlying
	   triplestore for query answering. Implies -f.

       -E url
	   Specifies the URL of a remove SPARQL endpoint to be used as a data source. The endpoint is used as an underlying triplestore for query
	   answering. Implies -f.

       -s database-type
	   Specifies the database type to use for the underlying data model.

       -u user
       -p password
       -m model

AUTHOR

	Gregory Todd Williams <gwilliams@cpan.org>

perl v5.14.2							    2012-01-31						     RDF::Query::Util(3pm)