.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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" ''
.    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 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.
.\"
.\" 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
.\"
.\" 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 "RDF::Query::Util 3pm"
.TH RDF::Query::Util 3pm "2014-10-24" "perl v5.20.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"
RDF::Query::Util \- Miscellaneous utility functions to support work with RDF::Query.
.SH "VERSION"
.IX Header "VERSION"
This document describes RDF::Query::Util version 2.912.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\& use RDF::Query::Util;
\& my $query = &RDF::Query::Util::cli_make_query;
\& my $model = &RDF::Query::Util::cli_make_model;
\& $query\->execute( $model );
\& ...
.Ve
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.ie n .IP """cli_make_query_and_model""" 4
.el .IP "\f(CWcli_make_query_and_model\fR" 4
.IX Item "cli_make_query_and_model"
Returns a query object, model, and args HASHref based on the arguments in \f(CW@ARGV\fR.
These arguments are parsed using \f(CW\*(C`cli_make_query\*(C'\fR and \f(CW\*(C`make_model\*(C'\fR.
.ie n .IP """cli_make_query""" 4
.el .IP "\f(CWcli_make_query\fR" 4
.IX Item "cli_make_query"
Returns a RDF::Query object based on the arguments in \f(CW@ARGV\fR. These arguments
are parsed using \f(CW&cli_parse_args\fR. If the \-e flag is not present, the
query will be loaded from a file named by the argument in \f(CW@ARGV\fR immediately
following the final argument parsed by \f(CW&cli_parse_args\fR.
.ie n .IP """cli_make_model""" 4
.el .IP "\f(CWcli_make_model\fR" 4
.IX Item "cli_make_model"
Calls \f(CW\*(C`make_model\*(C'\fR with arguments from \f(CW@ARGV\fR, returning the
constructed model object.
.Sp
\&\f(CW\*(C`cli_make_model\*(C'\fR will usually be called after cli_make_query, allowing a
typical \s-1CLI\s0 invocation to look like `prog.pl [flags] [query file] [data files]`.
.ie n .IP """make_model ( @files )""" 4
.el .IP "\f(CWmake_model ( @files )\fR" 4
.IX Item "make_model ( @files )"
Returns a model object suitable for use in a call to \f(CW\*(C`$query\->execute\*(C'\fR,
loaded with \s-1RDF\s0 from files and/or URLs listed in \f(CW@files\fR. This model may be any
of the supported models, but as currently implemented will be a
RDF::Trine::Model object.
.ie n .IP """cli_parse_args""" 4
.el .IP "\f(CWcli_parse_args\fR" 4
.IX Item "cli_parse_args"
Parses \s-1CLI\s0 arguments from \f(CW@ARGV\fR and returns a \s-1HASH\s0 with the recognized key/values.
The allowable arguments are listed below.
.ie n .IP """start_endpoint ( $model, $port )""" 4
.el .IP "\f(CWstart_endpoint ( $model, $port )\fR" 4
.IX Item "start_endpoint ( $model, $port )"
Starts an \s-1SPARQL\s0 endpoint \s-1HTTP\s0 server on port \f(CW$port\fR.
.Sp
If called in list context, returns the \s-1PID\s0 and the actual port the server bound
to. If called in scalar context, returns only the port.
.SH "COMMAND LINE ARGUMENTS"
.IX Header "COMMAND LINE ARGUMENTS"
.IP "\-e \fIstr\fR" 4
.IX Item "-e str"
Specifies the query string \fIstr\fR.
.IP "\-l \fIlang\fR" 4
.IX Item "-l lang"
Specifies the query language \fIlang\fR used. This should be one of: \fBsparql\fR,
\&\fBsparql11\fR, or \fBrdql\fR.
.IP "\-O" 4
.IX Item "-O"
Turns on optimization.
.IP "\-o" 4
.IX Item "-o"
Turns off optimization.
.IP "\-c \fIclass\fR" 4
.IX Item "-c class"
Specifies the perl \fIclass\fR used to construct the query object. Defaults to
\&\f(CW\*(C`RDF::Query\*(C'\fR.
.IP "\-f" 4
.IX Item "-f"
Implies \-c \fBRDF::Query::Federate\fR.
.IP "\-F \fIloc\fR" 4
.IX Item "-F loc"
Specifies the \s-1URL\s0 or path to a file \fIloc\fR which contains an \s-1RDF\s0 service
description. The described service is used as an underlying triplestore for
query answering. Implies \-f.
.IP "\-E \fIurl\fR" 4
.IX Item "-E url"
Specifies the \s-1URL\s0 of a remove \s-1SPARQL\s0 endpoint to be used as a data source. The
endpoint is used as an underlying triplestore for query answering. Implies \-f.
.IP "\-s \fIdatabase-type\fR" 4
.IX Item "-s database-type"
Specifies the database type to use for the underlying data model.
.IP "\-u \fIuser\fR" 4
.IX Item "-u user"
.PD 0
.IP "\-p \fIpassword\fR" 4
.IX Item "-p password"
.IP "\-m \fImodel\fR" 4
.IX Item "-m model"
.PD
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 1
\& Gregory Todd Williams <gwilliams@cpan.org>
.Ve