NAME

Dancer::Plugin::DBIC - DBIx::Class interface for Dancer applications

VERSION

version 0.11

SYNOPSIS

# Dancer Configuration File
plugins:
  DBIC:
    foo:
      pckg: "Foo::Bar"
      dsn:  "dbi:mysql:db_foo"
      user: "root"
      pass: "****"
      options:
        RaiseError: 1
        PrintError: 1

# Note! If your app already has a DBIC schema you may turn off auto generation like so..
plugins:
  DBIC:
    foo:
      skip_automake: 1

# Dancer Code File
use Dancer;
use Dancer::Plugin::DBIC;

# Calling the `foo` dsn keyword will return a L<DBIx::Class> instance using
# the database connection specifications associated with the dsn keyword
# within the Dancer configuration file.

get '/profile/:id' => sub {
    my $users_rs = foo->resultset('Users')->search({
        user_id => params->{id}
    });
    
    template 'user_profile', { user_data => $user_rs->next };
};

dance;

Database connection details are read from your Dancer application config - see below.

DESCRIPTION

Provides an easy way to obtain a DBIx::Class instance by simply calling a dsn keyword you define within your Dancer configuration file, this allows your Dancer application to connect to one or many databases with ease and consistency.

CONFIGURATION

Connection details will be taken from your Dancer application config file, and should be specified as stated above, for example:

plugins:
  DBIC:
    foo:
      pckg: "Foo"
      dsn:  "dbi:mysql:db_foo"
      user: "root"
      pass: "****"
      options:
        RaiseError: 1
        PrintError: 1
    bar:
      pckg: "Bar"
      dsn:  "dbi:SQLite:dbname=./foo.db"

Please use dsn keywords that will not clash with existing Dancer and Dancer::Plugin::*** reserved keywords.

Each database configuration *must* have a dsn and pckg option. The dsn option should be the DBI driver connection string less the optional user/pass and arguments options. The pckg option should be a proper Perl package name that Dancer::Plugin::DBIC will use as a DBIx::Class schema class. Optionally a database configuation may have user, pass and options paramters which are appended to the dsn in list form, i.e. dbi:SQLite:dbname=./foo.db, $user, $pass, $options.

AUTHOR

Al Newkirk <awncorp@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by awncorp.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.