.\" 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 "RDF::Trine::Store::Hexastore 3pm"
.TH RDF::Trine::Store::Hexastore 3pm "2018-11-03" "perl v5.28.0" "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::Hexastore \- RDF store implemented with the hexastore index
.SH "VERSION"
.IX Header "VERSION"
This document describes RDF::Trine::Store::Hexastore version 1.019
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use RDF::Trine::Store::Hexastore;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
RDF::Trine::Store::Hexastore provides an in-memory triple-store based on
six-way indexing as popularized by Hexastore.
.SH "METHODS"
.IX Header "METHODS"
Beyond the methods documented below, this class inherits methods from the
RDF::Trine::Store class.
.ie n .IP """new ()""" 4
.el .IP "\f(CWnew ()\fR" 4
.IX Item "new ()"
Returns a new storage object.
.ie n .IP """new_with_config ( $hashref )""" 4
.el .IP "\f(CWnew_with_config ( $hashref )\fR" 4
.IX Item "new_with_config ( $hashref )"
Returns a new storage object configured with a hashref with certain
keys as arguments.
.Sp
The \f(CW\*(C`storetype\*(C'\fR key must be \f(CW\*(C`Hexastore\*(C'\fR for this backend.
.Sp
This module also supports initializing the store from a file or \s-1URL,\s0
in which case, a \f(CW\*(C`sources\*(C'\fR key may be used. This holds an arrayref of
hashrefs.  To load a file, you may give the file name with a \f(CW\*(C`file\*(C'\fR
key in the hashref, and to load a \s-1URL,\s0 use \f(CW\*(C`url\*(C'\fR. See example
below. Furthermore, the following keys may be used:
.RS 4
.ie n .IP """syntax""" 4
.el .IP "\f(CWsyntax\fR" 4
.IX Item "syntax"
The syntax of the parsed file or \s-1URL.\s0
.ie n .IP """base_uri""" 4
.el .IP "\f(CWbase_uri\fR" 4
.IX Item "base_uri"
The base \s-1URI\s0 to be used for a parsed file.
.RE
.RS 4
.Sp
The following example initializes a Hexastore store based on a local file and a remote \s-1URL:\s0
.Sp
.Vb 12
\&  my $store = RDF::Trine::Store\->new_with_config( {
\&      storetype => \*(AqHexastore\*(Aq,
\&      sources => [
\&          {
\&              file => \*(Aqtest\-23.ttl\*(Aq,
\&              syntax => \*(Aqturtle\*(Aq,
\&          },
\&          {
\&              url => \*(Aqhttp://www.kjetil.kjernsmo.net/foaf\*(Aq,
\&              syntax => \*(Aqrdfxml\*(Aq,
\&          }
\&  ]});
.Ve
.RE
.ie n .IP """store ( $filename )""" 4
.el .IP "\f(CWstore ( $filename )\fR" 4
.IX Item "store ( $filename )"
Write the triples data to a file specified by \f(CW$filename\fR.
This data may be read back in with the \f(CW\*(C`load\*(C'\fR method.
.ie n .IP """load ( $filename )""" 4
.el .IP "\f(CWload ( $filename )\fR" 4
.IX Item "load ( $filename )"
Returns a new Hexastore object with triples data from the specified file.
.ie n .IP """temporary_store""" 4
.el .IP "\f(CWtemporary_store\fR" 4
.IX Item "temporary_store"
Returns a temporary (empty) triple store.
.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_pattern ( $bgp [, $context] )""" 4
.el .IP "\f(CWget_pattern ( $bgp [, $context] )\fR" 4
.IX Item "get_pattern ( $bgp [, $context] )"
Returns a stream object of all bindings matching the specified graph pattern.
.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.
.ie n .IP """get_contexts""" 4
.el .IP "\f(CWget_contexts\fR" 4
.IX Item "get_contexts"
.PD 0
.ie n .IP """add_statement ( $statement [, $context] )""" 4
.el .IP "\f(CWadd_statement ( $statement [, $context] )\fR" 4
.IX Item "add_statement ( $statement [, $context] )"
.PD
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 """etag""" 4
.el .IP "\f(CWetag\fR" 4
.IX Item "etag"
Returns an Etag suitable for use in an \s-1HTTP\s0 Header.
.ie n .IP """nuke""" 4
.el .IP "\f(CWnuke\fR" 4
.IX Item "nuke"
Permanently removes all the data in the store.
.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.
.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.