/ 
DBIx-Class-Schema-Loader-0.01002
River stage three • 35 direct dependents • 102 total dependents
/ DBIx::Class::Schema::Loader

NAME

DBIx::Class::Schema::Loader - Dynamic definition of a DBIx::Class::Schema

SYNOPSIS

package My::Schema;
use base qw/DBIx::Class::Schema::Loader/;

__PACKAGE__->load_from_connection(
  dsn                     => "dbi:mysql:dbname",
  user                    => "root",
  password                => "",
  additional_classes      => [qw/DBIx::Class::Foo/],
  additional_base_classes => [qw/My::Stuff/],
  left_base_classes       => [qw/DBIx::Class::Bar/],
  constraint              => '^foo.*',
  relationships           => 1,
  options                 => { AutoCommit => 1 }, 
  inflect                 => { child => 'children' },
  debug                   => 1,
);

# in seperate application code ...

use My::Schema;

my $schema1 = My::Schema->connect( $dsn, $user, $password, $attrs);
# -or-
my $schema1 = "My::Schema";
# ^^ defaults to dsn/user/pass from load_from_connection()

# Get a list of the original (database) names of the tables that
#  were loaded
my @tables = $schema1->loader->tables;

# Get a hashref of table_name => 'TableName' table-to-moniker
#   mappings.
my $monikers = $schema1->loader->monikers;

# Get a hashref of table_name => 'My::Schema::TableName'
#   table-to-classname mappings.
my $classes = $schema1->loader->classes;

# Use the schema as per normal for DBIx::Class::Schema
my $rs = $schema1->resultset($monikers->{table_table})->search(...);

DESCRIPTION

THIS IS A DEVELOPMENT RELEASE. This is 0.01xxx, the first public releases. Expect things to be broken in various ways. Expect the entire design to be fatally flawed. Expect the interfaces to change if it becomes neccessary. It's mostly here for people to poke at it and find the flaws in it. 0.02 will hopefully have some sanity when we get there.

DBIx::Class::Schema::Loader automates the definition of a DBIx::Class::Schema by scanning table schemas and setting up columns and primary keys.

DBIx::Class::Schema::Loader supports MySQL, Postgres, SQLite and DB2. See DBIx::Class::Schema::Loader::Generic for more, and DBIx::Class::Schema::Loader::Writing for notes on writing your own db-specific subclass for an unsupported db.

This module requires DBIx::Class 0.05 or later, and obsoletes DBIx::Class::Loader for DBIx::Class version 0.05 and later.

METHODS

load_from_connection

Example in Synopsis above demonstrates the available arguments. For detailed information on the arguments, see the DBIx::Class::Schema::Loader::Generic documentation.

loader

This is an accessor in the generated Schema class for accessing the DBIx::Class::Schema::Loader::Generic -based loader object that was used during construction. See the DBIx::Class::Schema::Loader::Generic docs for more information on the available loader methods there.

AUTHOR

Brandon Black, blblack@gmail.com

Based on DBIx::Class::Loader by Sebastian Riedel

Based upon the work of IKEBE Tomohiro

THANK YOU

Adam Anderson, Andy Grundman, Autrijus Tang, Dan Kubb, David Naughton, Randal Schwartz, Simon Flack and all the others who've helped.

LICENSE

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

SEE ALSO

DBIx::Class