.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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 >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 "AtteanX::Store::SPARQL 3pm"
.TH AtteanX::Store::SPARQL 3pm "2019-02-07" "perl v5.28.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"
AtteanX::Store::SPARQL \- Attean SPARQL store
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  my $store = Attean\->get_store(\*(AqSPARQL\*(Aq)\->new(endpoint_url => $url);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This implements a simple immutable triple store, which simply allows
programmers to use Attean facilities to query remote \s-1SPARQL\s0
endpoints.
.PP
This distribution also brings a corresponding
AtteanX::Model::SPARQL, which allows query plans to be made, and a
AtteanX::Plan::SPARQLBGP plan class, which contains a
rudimentary cost estimate that attempts to avoid sending Cartesian
joins to remote endpoints if possible.
.SS "Attributes and methods"
.IX Subsection "Attributes and methods"
.ie n .IP """endpoint_url""" 4
.el .IP "\f(CWendpoint_url\fR" 4
.IX Item "endpoint_url"
The \s-1URL\s0 of a remote \s-1SPARQL\s0 endpoint. Will be coerced into a \s-1URI\s0
object, so it may be set as a string or whatever. Required attribute.
.ie n .IP """ua""" 4
.el .IP "\f(CWua\fR" 4
.IX Item "ua"
An LWP::UserAgent object to use for remote queries. Will be set to
a reasonable default if not supplied.
.ie n .IP """get_triples""" 4
.el .IP "\f(CWget_triples\fR" 4
.IX Item "get_triples"
Method to query the remote endpoint, as required by Attean::API::TripleStore.
.ie n .IP """count_triples""" 4
.el .IP "\f(CWcount_triples\fR" 4
.IX Item "count_triples"
Reimplemented using an aggregate query for greater efficiency.
.ie n .IP """get_sparql($sparql, [ $ua ])""" 4
.el .IP "\f(CWget_sparql($sparql, [ $ua ])\fR" 4
.IX Item "get_sparql($sparql, [ $ua ])"
Will submit the given \f(CW$sparql\fR query to the above \f(CW\*(C`endpoint_url\*(C'\fR
attribute. Optionally, you may pass an LWP::UserAgent, if not it
will use the user agent set using the \f(CW\*(C`ua\*(C'\fR method. Will return an
iterator with the results if the request is successful.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs to
<https://github.com/kjetilk/p5\-atteanx\-store\-sparql/issues>.
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
This module is heavily influenced by RDF::Trine::Store::SPARQL.
.SH "AUTHOR"
.IX Header "AUTHOR"
Kjetil Kjernsmo <kjetilk@cpan.org>.
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2015, 2016 by Kjetil Kjernsmo and Gregory
Todd Williams.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
.SH "DISCLAIMER OF WARRANTIES"
.IX Header "DISCLAIMER OF WARRANTIES"
\&\s-1THIS PACKAGE IS PROVIDED \*(L"AS IS\*(R" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.\s0