.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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 "CHI::Driver::Redis 3pm"
.TH CHI::Driver::Redis 3pm "2022-11-19" "perl v5.36.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"
CHI::Driver::Redis \- Redis driver for CHI
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use CHI;
\&
\&    my $foo = CHI\->new(
\&        driver => \*(AqRedis\*(Aq,
\&        namespace => \*(Aqfoo\*(Aq,
\&        server => \*(Aq127.0.0.1:6379\*(Aq,
\&        debug => 0
\&    );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A \s-1CHI\s0 driver that uses \f(CW\*(C`Redis\*(C'\fR to store the data.  Care has been taken to
not have this module fail in fiery ways if the cache is unavailable.  It is my
hope that if it is failing and the cache is not required for your work, you
can ignore its warnings.
.SH "TECHNICAL DETAILS"
.IX Header "TECHNICAL DETAILS"
.SS "Namespaces."
.IX Subsection "Namespaces."
Redis does not have namespaces.  Therefore, we have to do some hoop-jumping.
.PP
Namespaces are tracked in a set named \f(CW\*(C`chinamespaces\*(C'\fR.  This is a list of all
the namespaces the driver has seen.
.PP
Keys in a namespace are stored in a set that shares the name of the namespace.
The actual value is stored as \*(L"$namespace||key\*(R".
.SS "Encoding"
.IX Subsection "Encoding"
This \s-1CHI\s0 driver uses Redis.pm.  Redis.pm by default automatically
encodes values to \s-1UTF\-8.\s0  This driver sets the Redis encoding option
to undef to disable automatic encoding.
.SH "CONSTRUCTOR OPTIONS"
.IX Header "CONSTRUCTOR OPTIONS"
.ie n .IP """redis""" 4
.el .IP "\f(CWredis\fR" 4
.IX Item "redis"
option for the constructed \f(CW\*(C`Redis\*(C'\fR object
.ie n .IP """redis_options""" 4
.el .IP "\f(CWredis_options\fR" 4
.IX Item "redis_options"
for hash of options to the \f(CW\*(C`Redis\*(C'\fR constructor
.PP
Other options, including \f(CW\*(C`server\*(C'\fR, \f(CW\*(C`debug\*(C'\fR, and \f(CW\*(C`password\*(C'\fR are passed to
the \f(CW\*(C`Redis\*(C'\fR constructor.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "redis"
.IX Subsection "redis"
Contains the underlying \f(CW\*(C`Redis\*(C'\fR object.
.SH "AUTHOR"
.IX Header "AUTHOR"
Cory G Watson, \f(CW\*(C`<gphat at cpan.org>\*(C'\fR
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
Ian Burrell, \f(CW\*(C`<iburrell@cpan.org>\*(C'\fR
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2009 Cold Hard Code, \s-1LLC.\s0
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of either: the \s-1GNU\s0 General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See http://dev.perl.org/licenses/ for more information.