.\" -*- 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::Redis 3pm"
.TH RDF::Trine::Store::Redis 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::Redis \- RDF Store for Redis
.SH VERSION
.IX Header "VERSION"
This document describes RDF::Trine::Store::Redis version 1.019
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use RDF::Trine::Store::Redis;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
RDF::Trine::Store::Redis provides a RDF::Trine::Store API to interact with a
Redis server.
.SH METHODS
.IX Header "METHODS"
Beyond the methods documented below, this class inherits methods from the
RDF::Trine::Store class.
.ie n .IP """new ( $server )""" 4
.el .IP "\f(CWnew ( $server )\fR" 4
.IX Item "new ( $server )"
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`Redis\*(C'\fR for this backend.
.Sp
The following key must also be used:
.RS 4
.IP foo 4
.IX Item "foo"
description
.RE
.RS 4
.RE
.ie n .IP """conn""" 4
.el .IP \f(CWconn\fR 4
.IX Item "conn"
Returns the Redis connection object.
.ie n .IP """cache""" 4
.el .IP \f(CWcache\fR 4
.IX Item "cache"
Returns the Cache::LRU object used to cache frequently used redis data.
.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.
.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 """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 """count_statements ( $subject, $predicate, $object, $context )""" 4
.el .IP "\f(CWcount_statements ( $subject, $predicate, $object, $context )\fR" 4
.IX Item "count_statements ( $subject, $predicate, $object, $context )"
Returns a count of all the statements matching the specified subject,
predicate, object, and context. 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 """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 """nuke""" 4
.el .IP \f(CWnuke\fR 4
.IX Item "nuke"
Permanently removes the store and its data.
.SH "REDIS DATA LAYOUT"
.IX Header "REDIS DATA LAYOUT"
\&...
.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.