X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDB.pm;h=007c82adbfa10219e694abc2e4c7e83ab0458fab;hb=096f421241;hp=c39ec03f82722075a04f8bfa81a724f464ca2e60;hpb=39fe0e65163d92789ef01b7ce4530ff2e7b79eb2;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/DB.pm b/lib/DBIx/Class/DB.pm index c39ec03..007c82a 100644 --- a/lib/DBIx/Class/DB.pm +++ b/lib/DBIx/Class/DB.pm @@ -1,50 +1,72 @@ package DBIx::Class::DB; -use base qw/Class::Data::Inheritable/; +use strict; +use warnings; + +use base qw/DBIx::Class/; +use DBIx::Class::Schema; +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/ResultSetProxy/); + +{ + no warnings 'once'; + *dbi_commit = \&txn_commit; + *dbi_rollback = \&txn_rollback; +} + +sub storage { shift->schema_instance(@_)->storage; } -=head1 NAME +=head1 NAME -DBIx::Class::DB - DBIx::Class Database connection +DBIx::Class::DB - (DEPRECATED) classdata schema component =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 is designed to support the Class::DBI connection-as-classdata style +for DBIx::Class. You are *strongly* recommended to use a DBIx::Class::Schema +instead; DBIx::Class::DB will not undergo new development and will be moved +to being a CDBICompat-only component before 1.0. =head1 METHODS -=over 4 +=head2 storage -=cut +Sets or gets the storage backend. Defaults to L. -sub _get_dbh { - my ($class) = @_; - my $dbh; - unless (($dbh = $class->_dbh) && $dbh->FETCH('Active') && $dbh->ping) { - $class->_populate_dbh; - } - return $class->_dbh; -} +=head2 class_resolver -sub _populate_dbh { - my ($class) = @_; - my @info = @{$class->_dbi_connect_info || []}; - my $pkg = $class->_dbi_connect_package || $class; - $pkg->_dbh($class->_dbi_connect(@info)); -} +****DEPRECATED**** -sub _dbi_connect { - my ($class, @info) = @_; - return DBI->connect(@info); -} +Sets or gets the class to use for resolving a class. Defaults to +L, which returns whatever you give +it. See resolve_class below. + +=cut -=item connection +__PACKAGE__->mk_classdata('class_resolver' => + 'DBIx::Class::ClassResolver::PassThrough'); + +=head2 connection __PACKAGE__->connection($dsn, $user, $pass, $attrs); @@ -55,37 +77,109 @@ instantiate the class dbh when required. sub connection { my ($class, @info) = @_; - $class->_dbi_connect_package($class); - $class->_dbi_connect_info(\@info); + $class->setup_schema_instance unless $class->can('schema_instance'); + $class->schema_instance->connection(@info); } -=item dbi_commit +=head2 setup_schema_instance - $class->dbi_commit; +Creates a class method ->schema_instance which contains a DBIx::Class::Schema; +all class-method operations are proxies through to this object. If you don't +call ->connection in your DBIx::Class::DB subclass at load time you *must* +call ->setup_schema_instance in order for subclasses to find the schema and +register themselves with it. -Issues a commit again the current dbh +=cut + +sub setup_schema_instance { + my $class = shift; + my $schema = {}; + bless $schema, 'DBIx::Class::Schema'; + $class->mk_classdata('schema_instance' => $schema); +} + +=head2 txn_begin + +Begins a transaction (does nothing if AutoCommit is off). =cut -sub dbi_commit { $_[0]->_get_dbh->commit; } +sub txn_begin { shift->schema_instance->txn_begin(@_); } -=item dbi_rollback +=head2 txn_commit + +Commits the current transaction. + +=cut - $class->dbi_rollback; +sub txn_commit { shift->schema_instance->txn_commit(@_); } -Issues a rollback again the current dbh +=head2 txn_rollback + +Rolls back the current transaction. =cut -sub dbi_rollback { $_[0]->_get_dbh->rollback; } +sub txn_rollback { shift->schema_instance->txn_rollback(@_); } -1; +=head2 txn_do + +Executes a block of code transactionally. If this code reference +throws an exception, the transaction is rolled back and the exception +is rethrown. See L for more details. + +=cut + +sub txn_do { shift->schema_instance->txn_do(@_); } + +{ + my $warn; + + sub resolve_class { + warn "resolve_class deprecated as of 0.04999_02" unless $warn++; + return shift->class_resolver->class(@_); + } +} + +=head2 resultset_instance + +Returns an instance of a resultset for this class - effectively +mapping the L connection-as-classdata paradigm into the +native L system. + +=cut + +sub resultset_instance { + my $class = ref $_[0] || $_[0]; + my $source = $class->result_source_instance; + if ($source->result_class ne $class) { + $source = $source->new($source); + $source->result_class($class); + } + return $source->resultset; +} + +=head2 resolve_class + +****DEPRECATED**** + +See L -=back +=head2 dbi_commit + +****DEPRECATED**** + +Alias for L + +=head2 dbi_rollback + +****DEPRECATED**** + +Alias for L =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE @@ -93,3 +187,4 @@ You may distribute this code under the same terms as Perl itself. =cut +1;