X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FModel%2FDBIC%2FSchema.pm;h=320cb2911f56d03472e81a6a4efd4cedf4caded2;hb=202d09c88f8feb276bef178f8f35bb543a2ff65c;hp=eebe0c0c7567f14fb85ee3e1a9eb49ce22e68fd2;hpb=150c864cf7ee1de4240e690d87edfe34a3757e2a;p=catagits%2FCatalyst-Model-DBIC-Schema.git diff --git a/lib/Catalyst/Model/DBIC/Schema.pm b/lib/Catalyst/Model/DBIC/Schema.pm index eebe0c0..320cb29 100644 --- a/lib/Catalyst/Model/DBIC/Schema.pm +++ b/lib/Catalyst/Model/DBIC/Schema.pm @@ -7,7 +7,7 @@ use UNIVERSAL::require; use Carp; require DBIx::Class; -our $VERSION = '0.12'; +our $VERSION = '0.15'; __PACKAGE__->mk_classaccessor('composed_schema'); __PACKAGE__->mk_accessors('schema'); @@ -38,20 +38,20 @@ Actor in MyApp/Schema/FilmDB/Actor.pm: package MyApp::Schema::FilmDB::Actor; use base qw/DBIx::Class/ - + __PACKAGE__->load_components(qw/Core/); __PACKAGE__->table('actor'); - + ... and a Role in MyApp/Schema/Role.pm: package MyApp::Schema::FilmDB::Role; use base qw/DBIx::Class/ - + __PACKAGE__->load_components(qw/Core/); - __PACKAGE__->table('actor'); - + __PACKAGE__->table('role'); + ... Notice that the schema is in MyApp::Schema, not in MyApp::Model. This way it's @@ -64,7 +64,7 @@ MyApp/Model/FilmDB.pm: package MyApp::Model::FilmDB; use base qw/Catalyst::Model::DBIC::Schema/; - + __PACKAGE__->config( schema_class => 'MyApp::Schema::FilmDB', connect_info => [ @@ -88,11 +88,11 @@ You can also use it to set up DBIC authentication with Authentication::Store::DBIC in MyApp.pm: package MyApp; - + use Catalyst qw/... Authentication::Store::DBIC/; - + ... - + __PACKAGE__->config->{authentication}{dbic} = { user_class => 'FilmDB::Actor', user_field => 'name', @@ -106,42 +106,39 @@ documentation in the L distribution. Some examples are given below: - # to access schema methods directly: - $c->model('FilmDB')->schema->source(...); + # to access schema methods directly: + $c->model('FilmDB')->schema->source(...); - # to access the source object, resultset, and class: - $c->model('FilmDB')->source(...); - $c->model('FilmDB')->resultset(...); - $c->model('FilmDB')->class(...); + # to access the source object, resultset, and class: + $c->model('FilmDB')->source(...); + $c->model('FilmDB')->resultset(...); + $c->model('FilmDB')->class(...); - # For resultsets, there's an even quicker shortcut: - $c->model('FilmDB::Actor') - # is the same as $c->model('FilmDB')->resultset('Actor') + # For resultsets, there's an even quicker shortcut: + $c->model('FilmDB::Actor') + # is the same as $c->model('FilmDB')->resultset('Actor') - # To get the composed schema for making new connections: - my $newconn = $c->model('FilmDB')->composed_schema->connect(...); + # To get the composed schema for making new connections: + my $newconn = $c->model('FilmDB')->composed_schema->connect(...); - # Or the same thing via a convenience shortcut: - my $newconn = $c->model('FilmDB')->connect(...); + # Or the same thing via a convenience shortcut: + my $newconn = $c->model('FilmDB')->connect(...); - # or, if your schema works on different storage drivers: - my $newconn = $c->model('FilmDB')->composed_schema->clone(); - $newconn->storage_type('::LDAP'); - $newconn->connection(...); + # or, if your schema works on different storage drivers: + my $newconn = $c->model('FilmDB')->composed_schema->clone(); + $newconn->storage_type('::LDAP'); + $newconn->connection(...); - # and again, a convenience shortcut - my $newconn = $c->model('FilmDB')->clone(); - $newconn->storage_type('::LDAP'); - $newconn->connection(...); + # and again, a convenience shortcut + my $newconn = $c->model('FilmDB')->clone(); + $newconn->storage_type('::LDAP'); + $newconn->connection(...); =head1 DESCRIPTION This is a Catalyst Model for L-based Models. See -the documentation for L and -L for information -on generating these Models via Helper scripts. The latter of the two -will also generated a L-based Schema class -for you. +the documentation for L for +information on generating these Models via Helper scripts. =head1 CONFIG PARAMETERS @@ -159,8 +156,7 @@ This is an arrayref of connection parameters, which are specific to your C (see your storage type documentation for more details). This is not required if C already has connection information -defined in itself (which would be the case for a Schema defined by -L, for instance). +defined inside itself (which isn't highly recommended, but can be done) For L, which is the only supported C in L at the time of this writing, the @@ -174,29 +170,29 @@ specify these options. You would know it if you needed them. Examples: - connect_info => [ 'dbi:Pg:dbname=mypgdb', 'postgres', '' ], - - connect_info => [ - 'dbi:SQLite:dbname=foo.db', - { - on_connect_do => [ - 'PRAGMA synchronous = OFF', - ], - } - ], - - connect_info => [ - 'dbi:Pg:dbname=mypgdb', - 'postgres', - '', - { AutoCommit => 0 }, - { - on_connect_do => [ - 'some SQL statement', - 'another SQL statement', - ], - } - ], + connect_info => [ 'dbi:Pg:dbname=mypgdb', 'postgres', '' ], + + connect_info => [ + 'dbi:SQLite:dbname=foo.db', + { + on_connect_do => [ + 'PRAGMA synchronous = OFF', + ], + } + ], + + connect_info => [ + 'dbi:Pg:dbname=mypgdb', + 'postgres', + '', + { AutoCommit => 0 }, + { + on_connect_do => [ + 'some SQL statement', + 'another SQL statement', + ], + } + ], =item storage_type @@ -294,7 +290,7 @@ sub new { # XXX This is temporary, until DBIx::Class::Storage::DBI supports the # same syntax and we switch our requisite to that version somewhere # down the line. This syntax is already committed into DBIx::Class - # dev branch post-0.06. + # -current branch post-0.06. # At that time, this whole block can revert back to just being: # $self->schema->connection(@{$self->{connect_info}}); @@ -359,8 +355,7 @@ L, L, L, Stuff related to DBIC and this Model style: L, L, -L, L, -L +L, L =head1 AUTHOR