.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "DBIx::Class::Schema::KiokuDB 3pm"
.TH DBIx::Class::Schema::KiokuDB 3pm "2014-03-31" "perl v5.18.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::Class::Schema::KiokuDB \- Hybrid KiokuDB/DBIx::Class::Schema schema support.
.SH "VERSION"
.IX Header "VERSION"
version 1.23
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Load this component into the schema:
.PP
.Vb 2
\&    package MyApp::DB;
\&    use base qw(DBIx::Class::Schema);
\&
\&    _\|_PACKAGE_\|_\->load_components(qw(Schema::KiokuDB));
\&
\&    _\|_PAKCAGE_\|_\->load_namespaces;
.Ve
.PP
Then load the DBIx::Class::KiokuDB component into every table that wants to
refer to arbitrary KiokuDB objects:
.PP
.Vb 2
\&    package MyApp::DB::Result::Album;
\&    use base qw(DBIx::Class::Core);
\&
\&    _\|_PACKAGE_\|_\->load_components(qw(KiokuDB));
\&
\&    _\|_PACKAGE_\|_\->table(\*(Aqalbum\*(Aq);
\&
\&    _\|_PACKAGE_\|_\->add_columns(
\&        id => { data_type => "integer" },
\&        title => { data_type => "varchar" },
\&
\&        # the foreign key for the KiokuDB object:
\&        metadata => { data_type => "varchar" },
\&    );
\&
\&    _\|_PACKAGE_\|_\->set_primary_key(\*(Aqid\*(Aq);
\&
\&    # enable a KiokuDB rel on the column:
\&    _\|_PACKAGE_\|_\->kiokudb_column(\*(Aqmetadata\*(Aq);
.Ve
.PP
Connect to the \s-1DSN:\s0
.PP
.Vb 5
\&    my $dir = KiokuDB\->connect(
\&        \*(Aqdbi:SQLite:dbname=:memory:\*(Aq,
\&        schema => "MyApp::DB",
\&        create => 1,
\&    );
\&
\&    # get the connect DBIC schema instance
\&    my $schema = $dir\->backend\->schema;
.Ve
.PP
Then you can freely refer to KiokuDB objects from your \f(CW\*(C`Album\*(C'\fR class:
.PP
.Vb 1
\&    $dir\->txn_do(scope => 1, body => sub {
\&
\&        $schema\->resultset("Album")\->create({
\&            title => "Blah blah",
\&            metadata => $any_object,
\&        });
\&    });
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class provides the schema definition support code required for integrating
an arbitrary DBIx::Class::Schema with KiokuDB::Backend::DBI.
.SS "\s-1REUSING AN EXISTING\s0 DBIx::Class \s-1SCHEMA\s0"
.IX Subsection "REUSING AN EXISTING DBIx::Class SCHEMA"
The example in the Synopis assumes that you want to first set up a
KiokuDB and than link that to some DBIx::Class classes. Another
use case is that you already have a configured DBIx::Class Schema
and want to tack KiokuDB onto it.
.PP
The trick here is to make sure to load the KiokuDB schema using
\&\f(CW\*(C`_\|_PACKAGE_\|_\->define_kiokudb_schema()\*(C'\fR in your Schema class:
.PP
.Vb 2
\&    package MyApp::DB;
\&    use base qw(DBIx::Class::Schema);
\&
\&    _\|_PACKAGE_\|_\->load_components(qw(Schema::KiokuDB));
\&    _\|_PACKAGE_\|_\->define_kiokudb_schema();
\&
\&    _\|_PAKCAGE_\|_\->load_namespaces;
.Ve
.PP
You can now get the KiokuDB directory handle like so:
.PP
.Vb 1
\&    my $dir = $schema\->kiokudb_handle;
.Ve
.PP
For a complete example take a look at \fIt/autovivify_handle.t\fR.
.SH "USAGE AND LIMITATIONS"
.IX Header "USAGE AND LIMITATIONS"
KiokuDB managed objects may hold references to row objects, resultsets
(treated as saved searches, or results or cursor state is saved), result source
handles, and the schema.
.PP
Foreign DBIx::Class objects, that is ones that originated from a schema that
isn't the underlying schema are currently not supported, but this limitation
may be lifted in the future.
.PP
All \s-1DBIC\s0 operations which may implicitly cause a lookup of a KIokuDB managed
object require live object scope management, just as normal.
.PP
It is reccomended to use \*(L"txn_do\*(R" in KiokuDB because that will invoke the
appropriate transaction hooks on both layers, as opposed to just in
DBIx::Class.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
DBIx::Class::KiokuDB, KiokuDB::Backend::DBI.
.SH "AUTHOR"
.IX Header "AUTHOR"
Yuval Kogman <nothingmuch@woobling.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2014 by Yuval Kogman, Infinity Interactive.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.