.\" -*- 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 "DBIx::SearchBuilder::Record::Cachable 3pm"
.TH DBIx::SearchBuilder::Record::Cachable 3pm 2024-01-27 "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
DBIx::SearchBuilder::Record::Cachable \- Records with caching behavior
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  package MyRecord;
\&  use base qw/DBIx::SearchBuilder::Record::Cachable/;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module subclasses the main DBIx::SearchBuilder::Record package
to add a caching layer.
.PP
The public interface remains the same, except that records which have
been loaded in the last few seconds may be reused by subsequent fetch
or load methods without retrieving them from the database.
.SH METHODS
.IX Header "METHODS"
.SS FlushCache
.IX Subsection "FlushCache"
This class method flushes the _global_ DBIx::SearchBuilder::Record::Cachable
cache. All caches are immediately expired.
.SS _FlushKeyCache
.IX Subsection "_FlushKeyCache"
Blow away this record type's key cache
.SS _CacheConfig
.IX Subsection "_CacheConfig"
You can override this method to change the duration of the caching from the default of 5 seconds.
.PP
For example, to cache records for up to 30 seconds, add the following method to your class:
.PP
.Vb 3
\&  sub _CacheConfig {
\&      { \*(Aqcache_for_sec\*(Aq => 30 }
\&  }
.Ve