Moving towards instance-based schemas

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / DB.pm

diff --git a/lib/DBIx/Class/DB.pm b/lib/DBIx/Class/DB.pm
index 2134154..6aaab51 100644 (file)
--- a/lib/DBIx/Class/DB.pm
+++ b/lib/DBIx/Class/DB.pm
@@ -1,66 +1,121 @@
 package DBIx::Class::DB;
 
-use base qw/Class::Data::Inheritable/;
+use base qw/DBIx::Class/;
+use DBIx::Class::Storage::DBI;
+use DBIx::Class::ClassResolver::PassThrough;
 use DBI;
 
-__PACKAGE__->mk_classdata('_dbi_connect_info');
-__PACKAGE__->mk_classdata('_dbi_connect_package');
-__PACKAGE__->mk_classdata('_dbh');
+__PACKAGE__->load_components(qw/ResultSetInstance/);
+
+*dbi_commit = \&txn_commit;
+*dbi_rollback = \&txn_rollback;
+
+sub storage { shift->storage_instance(@_); }
+
+sub resultset_instance {
+  my $class = shift;
+  my $table = $class->table_instance->new($class->table_instance);
+  $table->schema($class);
+  $table->result_class($class);
+  return $table->resultset;
+}
+
+sub result_source {
+  my $class = shift;
+  my $table = $class->table_instance->new($class->table_instance);
+  $table->schema($class);
+  $table->result_class($class);
+  return $table;
+}
 
 =head1 NAME 
 
-DBIx::Class::DB - DBIx::Class Database connection
+DBIx::Class::DB - Simple DBIx::Class Database connection by class inheritance
 
 =head1 SYNOPSIS
 
+  package MyDB;
+
+  use base qw/DBIx::Class/;
+  __PACKAGE__->load_components('DB');
+
+  __PACKAGE__->connection('dbi:...', 'user', 'pass', \%attrs);
+
+  package MyDB::MyTable;
+
+  use base qw/MyDB/;
+  __PACKAGE__->load_components('Core'); # just load this in MyDB if it will always be there
+
+  ...
+
 =head1 DESCRIPTION
 
-This class represents the connection to the database
+This class provides a simple way of specifying a database connection.
 
 =head1 METHODS
 
-=over 4
+=head2 storage
+
+Sets or gets the storage backend. Defaults to L<DBIx::Class::Storage::DBI>.
+
+=head2 class_resolver
+
+Sets or gets the class to use for resolving a class. Defaults to 
+L<DBIx::Class::ClassResolver::Passthrough>, which returns whatever you give
+it. See resolve_class below.
 
 =cut
 
-sub _get_dbh {
-  my ($class) = @_;
-  my $dbh;
-  unless (($dbh = $class->_dbh) && $dbh->FETCH('Active') && $dbh->ping) {
-    $class->_populate_dbh;
-  }
-  return $class->_dbh;
-}
+__PACKAGE__->mk_classdata('class_resolver' =>
+                            'DBIx::Class::ClassResolver::PassThrough');
 
-sub _populate_dbh {
-  my ($class) = @_;
-  my @info = @{$class->_dbi_connect_info || []};
-  my $pkg = $class->_dbi_connect_package || $class;
-  $pkg->_dbh($class->_dbi_connect(@info));
-}
+=head2 connection
 
-sub _dbi_connect {
-  my ($class, @info) = @_;
-  return DBI->connect(@info);
-}
+  __PACKAGE__->connection($dsn, $user, $pass, $attrs);
+
+Specifies the arguments that will be passed to DBI->connect(...) to
+instantiate the class dbh when required.
+
+=cut
 
 sub connection {
   my ($class, @info) = @_;
-  $class->_dbi_connect_package($class);
-  $class->_dbi_connect_info(\@info);
+  my $storage = DBIx::Class::Storage::DBI->new;
+  $storage->connect_info(\@info);
+  $class->mk_classdata('storage_instance' => $storage);
 }
 
-sub dbi_commit { $_[0]->_get_dbh->commit; }
+=head2 txn_begin
 
-sub dbi_rollback { $_[0]->_get_dbh->rollback; }
+Begins a transaction (does nothing if AutoCommit is off).
 
-1;
+=cut
+
+sub txn_begin { $_[0]->storage->txn_begin }
+
+=head2 txn_commit
+
+Commits the current transaction.
+
+=cut
+
+sub txn_commit { $_[0]->storage->txn_commit }
+
+=head2 txn_rollback
 
-=back
+Rolls back the current transaction.
+
+=cut
+
+sub txn_rollback { $_[0]->storage->txn_rollback }
+
+sub resolve_class { return shift->class_resolver->class(@_); }
+
+1;
 
 =head1 AUTHORS
 
-Matt S. Trout <perl-stuff@trout.me.uk>
+Matt S. Trout <mst@shadowcatsystems.co.uk>
 
 =head1 LICENSE