added Config::General examples

[catagits/Catalyst-Model-DBIC-Schema.git] / lib / Catalyst / Model / DBIC / Schema.pm

diff --git a/lib/Catalyst/Model/DBIC/Schema.pm b/lib/Catalyst/Model/DBIC/Schema.pm
index 19d9c54..9c7d840 100644 (file)
--- a/lib/Catalyst/Model/DBIC/Schema.pm
+++ b/lib/Catalyst/Model/DBIC/Schema.pm
@@ -1,14 +1,17 @@
 package Catalyst::Model::DBIC::Schema;
 
 use strict;
+use warnings;
+
+our $VERSION = '0.20';
+
 use base qw/Catalyst::Model Class::Accessor::Fast Class::Data::Accessor/;
 use NEXT;
 use UNIVERSAL::require;
 use Carp;
+use Data::Dumper;
 require DBIx::Class;
 
-our $VERSION = '0.14';
-
 __PACKAGE__->mk_classaccessor('composed_schema');
 __PACKAGE__->mk_accessors('schema');
 
@@ -44,7 +47,7 @@ Actor in MyApp/Schema/FilmDB/Actor.pm:
 
   ...
 
-and a Role in MyApp/Schema/Role.pm:
+and a Role in MyApp/Schema/FilmDB/Role.pm:
 
   package MyApp::Schema::FilmDB::Role;
   use base qw/DBIx::Class/
@@ -153,7 +156,9 @@ C<Catalyst::Model::> namespace.  This parameter is required.
 =item connect_info
 
 This is an arrayref of connection parameters, which are specific to your
-C<storage_type> (see your storage type documentation for more details).
+C<storage_type> (see your storage type documentation for more details). 
+If you only need one parameter (e.g. the DSN), you can just pass a string 
+instead of an arrayref.
 
 This is not required if C<schema_class> already has connection information
 defined inside itself (which isn't highly recommended, but can be done)
@@ -162,11 +167,8 @@ For L<DBIx::Class::Storage::DBI>, which is the only supported
 C<storage_type> in L<DBIx::Class> at the time of this writing, the
 parameters are your dsn, username, password, and connect options hashref.
 
-If you need to specify the L<DBIx::Class::Storage::DBI> specific parameter
-C<on_connect_do>, or the related C<sql_maker> options C<limit_dialect>,
-C<quote_char>, or C<name_sep>, you can place these options into a hashref
-as the final element of the C<connect_info> arrayref.  If in doubt, don't
-specify these options.  You would know it if you needed them.
+See L<DBIx::Class::Storage::DBI/connect_info> for a detailed explanation
+of the arguments supported.
 
 Examples:
 
@@ -194,6 +196,28 @@ Examples:
                     }
                   ],
 
+Or using L<Config::General>:
+
+    <Model::FilmDB>
+        schema_class   MyApp::Schema::FilmDB
+        connect_info   dbi:Pg:dbname=mypgdb
+        connect_info   postgres
+        connect_info
+        <connect_info>
+            AutoCommit   0
+            on_connect_do   some SQL statement
+            on_connect_do   another SQL statement
+        </connect_info>
+    </Model::FilmDB>
+
+or
+
+    <Model::FilmDB>
+        schema_class   MyApp::Schema::FilmDB
+        connect_info   dbi:SQLite:dbname=foo.db
+    </Model::FilmDB>
+
+
 =item storage_type
 
 Allows the use of a different C<storage_type> than what is set in your
@@ -277,7 +301,9 @@ sub new {
         }
         else {
             croak "Either ->config->{connect_info} must be defined for $class"
-                  . " or $schema_class must have connect info defined on it";
+                  . " or $schema_class must have connect info defined on it"
+                 . "Here's what we got:\n"
+                 . Dumper($self);
         }
     }
 
@@ -287,46 +313,12 @@ sub new {
     $self->schema->storage_type($self->{storage_type})
         if $self->{storage_type};
 
-    # 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
-    #  -current branch post-0.06.
-    # At that time, this whole block can revert back to just being:
-    #  $self->schema->connection(@{$self->{connect_info}});
+    $self->schema->connection( 
+        ref $self->{connect_info} eq 'ARRAY' ? 
+        @{$self->{connect_info}} : 
+        $self->{connect_info}
+    );
     
-    my $connect_info = [ @{$self->{connect_info}} ];
-    my ($on_connect_do, %sql_maker_opts);
-    if($DBIx::Class::VERSION < 0.069) {
-        my $used;
-        my $last_info = $self->{connect_info}->[-1];
-        if(ref $last_info eq 'HASH') {
-            if($on_connect_do = $last_info->{on_connect_do}) {
-              $used = 1;
-            }
-            for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
-              if(my $opt_val = $last_info->{$sql_maker_opt}) {
-                $used = 1;
-                $sql_maker_opts{$sql_maker_opt} = $opt_val;
-              }
-            }
-            pop(@$connect_info) if $used;
-        }
-    }
-
-    $self->schema->connection(@$connect_info);
-
-    if($DBIx::Class::VERSION < 0.069) {
-        $self->schema->storage->on_connect_do($on_connect_do)
-            if $on_connect_do;
-        foreach my $sql_maker_opt (keys %sql_maker_opts) {
-            $self->schema->storage->sql_maker->$sql_maker_opt(
-                $sql_maker_opts{$sql_maker_opt}
-            );
-        }
-    }
-
-    # XXX end of compatibility block referenced above
-
     no strict 'refs';
     foreach my $moniker ($self->schema->sources) {
         my $classname = "${class}::$moniker";