NAME

App::Kit::Obj::DB - database utility object

VERSION

This document describes App::Kit::Obj::DB version 0.2

SYNOPSIS

    my $db = App::Kit::Obj::DB->new(…);
    $db->dbh()->…

DESCRIPTION

database utility object

INTERFACE

new()

Returns the object.

Takes one required attribute: _app. It should be an App::Kit object for it to use internally.

Takes one optional and discouraged attribute: _dbh. Should be a DBI::db object.

dbh_is_still_good_check

Default is undef.

This attribute can be set to a coderef that takes a DBI object and returns true if it is still good or false otherwise.

If set this is used by dbh() instead of $dbh->ping() to determine if the handle is still good.

You could use this, for example, to still do $dbh->ping but only every so many calls to dbh() or only after so many seconds.

Can be unset by passing it undef.

dbh()

Returns the main database handle for our app. Reconnecting if necessary.

Lazy loads DBI the first time it is called.

The connection you want is defined via a hashref with the following keys:

'dbd_driver' (required)

e.g. SQLite, mysql

'database' (required)
'host' (defaults to 'localhost')
'dsn_attr'

hashref of additional DSN keys and values (built sorted by key)

    { port => 1234 }
'user' (defaults to '')
'pass' (defaults to '')
'connect_attr'

hashref that corresponds to the 4th argument to DBI->connect;

_force_new

When true, it will cause the current handle, if any, to be disconnected and removed and replaced by a fresh connection.

If it is the only key in the hash the config file is used.

The connections hashref can be given in two ways:

1. As the only argument to dbh
    $db->dbh({…})
2. In your app’s config/db.yaml
    $db->dbh() # uses $app->fs->file_lookup('config', 'db.yaml')

conn()

Shortcut to DBI->connect(…) or die ….

Takes the same arguments as DBI->connect.

For mysql based objects it additionally does some setup to ensure we’re speaking utf-8 and that datetime operations are normalized to UTC.

Lazy loads DBI the first time it is called.

disconn()

When given no arguments it disconnects and undefines the main database handle (i.e. the one via dbh()).

When given a database handle (e.g. one from conn()) it disconnects that.

DIAGNOSTICS

no db conf in arguments or app configuration

dbh() was given no data and there is no config file

no db conf in app configuration

dbh() was given no data and the config file does not contain a hash

missing required dbd_driver and database

the dbh() hash (from args or conf file) is missing both required params

missing required database

the dbh() hash (from args or conf file) is missing the required database param

missing required dbd_driver

the dbh() hash (from args or conf file) is missing the required dbd_driver param

Could not connect to database: %s

conn() throws this when its DBI->connect() fails

%s is DBI->errstr

CONFIGURATION AND ENVIRONMENT

Requires no configuration files or environment variables.

DEPENDENCIES

DBI

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-app-kit@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Daniel Muey <http://drmuey.com/cpan_contact.pl>

LICENCE AND COPYRIGHT

Copyright (c) 2013, Daniel Muey <http://drmuey.com/cpan_contact.pl>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.