X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDB.pm;h=e00237774152e789b3bad9b24568b5d2faa4cceb;hb=c216324aa4b0f79ba056fbe74adbd735421e378a;hp=7d1b5ca5817f7cb1abb5057b1fd21278b32f10de;hpb=076652e8bd5edaaf4c6c6a65f631bf529bbff41c;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/DB.pm b/lib/DBIx/Class/DB.pm index 7d1b5ca..e002377 100644 --- a/lib/DBIx/Class/DB.pm +++ b/lib/DBIx/Class/DB.pm @@ -1,56 +1,62 @@ 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; -=head1 NAME - -DBIx::Class::DB - Simple DBIx::Class Database connection by class inheritance - -=head1 SYNOPSIS - - package MyDB; +unless ($INC{"DBIx/Class/CDBICompat.pm"}) { + warn "IMPORTANT: DBIx::Class::DB is DEPRECATED AND *WILL* BE REMOVED. DO NOT USE.\n"; +} - use base qw/DBIx::Class/; - __PACKAGE__->load_components('DB'); +__PACKAGE__->load_components(qw/ResultSetProxy/); - __PACKAGE__->connection('dbi:...', 'user', 'pass', \%attrs); +{ + no warnings 'once'; + *dbi_commit = \&txn_commit; + *dbi_rollback = \&txn_rollback; +} - package MyDB::MyTable; +sub storage { shift->schema_instance(@_)->storage; } - use base qw/MyDB/; - __PACKAGE__->load_components('Core'); +=head1 NAME - ... +DBIx::Class::DB - (DEPRECATED) classdata schema component =head1 DESCRIPTION -This class provides a simple way of specifying a database connection. +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. In order to discourage further +use, documentation has been removed as of 0.08000 -=head1 METHODS +=begin HIDE_BECAUSE_THIS_CLASS_IS_DEPRECATED -=over 4 +=head1 METHODS +=head2 storage -=item storage +Sets or gets the storage backend. Defaults to L. -Which storage backend to be used. Defaults to L +=head2 class_resolver -=item class_resolver +****DEPRECATED**** -Which class to use for resolving a class. Defaults to -L, which returns whatever you throw -at it. See resolve_class below. +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 -__PACKAGE__->mk_classdata('storage'); __PACKAGE__->mk_classdata('class_resolver' => - 'DBIx::Class::ClassResolver::PassThrough'); + 'DBIx::Class::ClassResolver::PassThrough'); -=item connection +=head2 connection __PACKAGE__->connection($dsn, $user, $pass, $attrs); @@ -61,36 +67,107 @@ instantiate the class dbh when required. sub connection { my ($class, @info) = @_; - my $storage = DBIx::Class::Storage::DBI->new; - $storage->connect_info(\@info); - $class->storage($storage); + $class->setup_schema_instance unless $class->can('schema_instance'); + $class->schema_instance->connection(@info); } -=item dbi_commit +=head2 setup_schema_instance + +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. + +=cut + +sub setup_schema_instance { + my $class = shift; + my $schema = {}; + bless $schema, 'DBIx::Class::Schema'; + $class->mk_classdata('schema_instance' => $schema); +} - $class->dbi_commit; +=head2 txn_begin -Issues a commit again the current dbh +Begins a transaction (does nothing if AutoCommit is off). =cut -sub dbi_commit { $_[0]->storage->commit; } +sub txn_begin { shift->schema_instance->txn_begin(@_); } + +=head2 txn_commit + +Commits the current transaction. -=item dbi_rollback +=cut + +sub txn_commit { shift->schema_instance->txn_commit(@_); } - $class->dbi_rollback; +=head2 txn_rollback -Issues a rollback again the current dbh +Rolls back the current transaction. =cut -sub dbi_rollback { $_[0]->storage->rollback; } +sub txn_rollback { shift->schema_instance->txn_rollback(@_); } -sub resolve_class { return shift->class_resolver->class(@_); } +=head2 txn_do -1; +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 -=back +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 + +=head2 dbi_commit + +****DEPRECATED**** + +Alias for L + +=head2 dbi_rollback + +****DEPRECATED**** + +Alias for L + +=end HIDE_BECAUSE_THIS_CLASS_IS_DEPRECATED =head1 AUTHORS @@ -102,3 +179,4 @@ You may distribute this code under the same terms as Perl itself. =cut +1;