.\" -*- 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::Trine::Store 3pm"
.TH RDF::Trine::Store 3pm 2024-01-13 "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::Trine::Store \- RDF triplestore base class
.SH VERSION
.IX Header "VERSION"
This document describes RDF::Trine::Store version 1.019
.SH DESCRIPTION
.IX Header "DESCRIPTION"
RDF::Trine::Store provides a base class and common API for implementations of
triple/quadstores for use with the RDF::Trine framework. In general, it should
be used only be people implementing new stores. For interacting with stores
(e.g. to read, insert, and delete triples) the RDF::Trine::Model interface
should be used (using the model as an intermediary between the client/user and
the underlying store).
.PP
To be used by the RDF::Trine framework, store implementations must implement a
set of required functionality:
.IP \(bu 4
\&\f(CW\*(C`new\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`get_statements\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`get_contexts\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`add_statement\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`remove_statement\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`count_statements\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`supports\*(C'\fR
.PP
Implementations may also provide the following methods if a native
implementation would be more efficient than the default provided by
RDF::Trine::Store:
.IP \(bu 4
\&\f(CW\*(C`get_pattern\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`get_sparql\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`remove_statements\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`size\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`nuke\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`_begin_bulk_ops\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`_end_bulk_ops\*(C'\fR
.SH METHODS
.IX Header "METHODS"
.ie n .IP """new ( $data )""" 4
.el .IP "\f(CWnew ( $data )\fR" 4
.IX Item "new ( $data )"
Returns a new RDF::Trine::Store object based on the supplied data value.
This constructor delegates to one of the following methods depending on the
value of \f(CW$data\fR:
.Sp
* \f(CW\*(C`new_with_string\*(C'\fR if \f(CW$data\fR is not a reference
.Sp
* \f(CW\*(C`new_with_config\*(C'\fR if \f(CW$data\fR is a HASH reference
.Sp
* \f(CW\*(C`new_with_object\*(C'\fR if \f(CW$data\fR is a blessed object
.ie n .IP """new_with_string ( $config )""" 4
.el .IP "\f(CWnew_with_string ( $config )\fR" 4
.IX Item "new_with_string ( $config )"
Returns a new RDF::Trine::Store object based on the supplied configuration
string. The format of the string specifies the Store subclass to be
instantiated as well as any required constructor arguments. These are separated
by a semicolon. An example configuration string for the DBI store would be:
.Sp
.Vb 1
\& DBI;mymodel;DBI:mysql:database=rdf;user;password
.Ve
.Sp
The format of the constructor arguments (everything after the first ';') is
specific to the Store subclass.
.ie n .IP """new_with_config ( \e%config )""" 4
.el .IP "\f(CWnew_with_config ( \e%config )\fR" 4
.IX Item "new_with_config ( %config )"
Returns a new RDF::Trine::Store object based on the supplied
configuration hashref. This requires the the Store subclass to be
supplied with a \f(CW\*(C`storetype\*(C'\fR key, while other keys are required by the
Store subclasses, please refer to each subclass for specific
documentation.
.Sp
An example invocation for the DBI store may be:
.Sp
.Vb 7
\&  my $store = RDF::Trine::Store\->new_with_config({
\&                storetype => \*(AqDBI\*(Aq,
\&                name      => \*(Aqmymodel\*(Aq,
\&                dsn       => \*(AqDBI:mysql:database=rdf\*(Aq,
\&                username  => \*(Aqdahut\*(Aq,
\&                password  => \*(AqStr0ngPa55w0RD\*(Aq
\&              });
.Ve
.ie n .IP """new_with_object ( $object )""" 4
.el .IP "\f(CWnew_with_object ( $object )\fR" 4
.IX Item "new_with_object ( $object )"
Returns a new RDF::Trine::Store object based on the supplied opaque \f(CW$object\fR.
If the \f(CW$object\fR is recognized by an available backend as being sufficient
to construct a store object, the store object will be returned. Otherwise undef
will be returned.
.ie n .IP """nuke""" 4
.el .IP \f(CWnuke\fR 4
.IX Item "nuke"
Permanently removes the store and its data.
.ie n .IP """class_by_name ( $name )""" 4
.el .IP "\f(CWclass_by_name ( $name )\fR" 4
.IX Item "class_by_name ( $name )"
Returns the class of the storage implementation with the given name.
For example, \f(CW\*(AqMemory\*(Aq\fR would return \f(CW\*(AqRDF::Trine::Store::Memory\*(Aq\fR.
.ie n .IP """temporary_store""" 4
.el .IP \f(CWtemporary_store\fR 4
.IX Item "temporary_store"
Returns a new temporary triplestore (using appropriate default values).
.ie n .IP """get_statements ($subject, $predicate, $object [, $context] )""" 4
.el .IP "\f(CWget_statements ($subject, $predicate, $object [, $context] )\fR" 4
.IX Item "get_statements ($subject, $predicate, $object [, $context] )"
Returns a stream object of all statements matching the specified subject,
predicate and objects. Any of the arguments may be undef to match any value.
.ie n .IP """get_contexts""" 4
.el .IP \f(CWget_contexts\fR 4
.IX Item "get_contexts"
Returns an RDF::Trine::Iterator over the RDF::Trine::Node objects comprising
the set of contexts of the stored quads.
.ie n .IP """add_statement ( $statement [, $context] )""" 4
.el .IP "\f(CWadd_statement ( $statement [, $context] )\fR" 4
.IX Item "add_statement ( $statement [, $context] )"
Adds the specified \f(CW$statement\fR to the underlying model.
.ie n .IP """remove_statement ( $statement [, $context])""" 4
.el .IP "\f(CWremove_statement ( $statement [, $context])\fR" 4
.IX Item "remove_statement ( $statement [, $context])"
Removes the specified \f(CW$statement\fR from the underlying model.
.ie n .IP """remove_statements ( $subject, $predicate, $object [, $context])""" 4
.el .IP "\f(CWremove_statements ( $subject, $predicate, $object [, $context])\fR" 4
.IX Item "remove_statements ( $subject, $predicate, $object [, $context])"
Removes the specified \f(CW$statement\fR from the underlying model.
.ie n .IP """count_statements ($subject, $predicate, $object)""" 4
.el .IP "\f(CWcount_statements ($subject, $predicate, $object)\fR" 4
.IX Item "count_statements ($subject, $predicate, $object)"
Returns a count of all the statements matching the specified subject,
predicate and objects. Any of the arguments may be undef to match any value.
.ie n .IP """size""" 4
.el .IP \f(CWsize\fR 4
.IX Item "size"
Returns the number of statements in the store.
.ie n .IP """etag""" 4
.el .IP \f(CWetag\fR 4
.IX Item "etag"
If the store has the capability and knowledge to support caching, returns a
persistent token that will remain consistent as long as the store's data doesn't
change. This token is acceptable for use as an HTTP ETag.
.ie n .IP """supports ( [ $feature ] )""" 4
.el .IP "\f(CWsupports ( [ $feature ] )\fR" 4
.IX Item "supports ( [ $feature ] )"
If \f(CW$feature\fR is specified, returns true if the feature is supported by the
store, false otherwise. If \f(CW$feature\fR is not specified, returns a list of
supported features.
.SH BUGS
.IX Header "BUGS"
Please report any bugs or feature requests to through the GitHub web interface
at <https://github.com/kasei/perlrdf/issues>.
.SH AUTHOR
.IX Header "AUTHOR"
Gregory Todd Williams  \f(CW\*(C`<gwilliams@cpan.org>\*(C'\fR
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2006\-2012 Gregory Todd Williams. This
program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.