X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDB.pm;h=9f12a981a310157b64cb202f72953ad52c3d51e7;hb=fcf32d045;hp=804ff67a752b7e20c4a90bd85d0cc8e440fe6465;hpb=8273e845426f0187b4ad6c4a1b42286fa09a648f;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/DB.pm b/lib/DBIx/Class/DB.pm index 804ff67..9f12a98 100644 --- a/lib/DBIx/Class/DB.pm +++ b/lib/DBIx/Class/DB.pm @@ -33,14 +33,22 @@ 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 -=begin HIDE_BECAUSE_THIS_CLASS_IS_DEPRECATED - =head1 METHODS +Hidden. + +=begin hidden + =head2 storage Sets or gets the storage backend. Defaults to L. +=end hidden + +=cut + +=begin hidden + =head2 class_resolver ****DEPRECATED**** @@ -49,11 +57,15 @@ Sets or gets the class to use for resolving a class. Defaults to L, which returns whatever you give it. See resolve_class below. +=end hidden + =cut __PACKAGE__->mk_classdata('class_resolver' => 'DBIx::Class::ClassResolver::PassThrough'); +=begin hidden + =head2 connection __PACKAGE__->connection($dsn, $user, $pass, $attrs); @@ -61,6 +73,8 @@ __PACKAGE__->mk_classdata('class_resolver' => Specifies the arguments that will be passed to DBI->connect(...) to instantiate the class dbh when required. +=end hidden + =cut sub connection { @@ -69,6 +83,8 @@ sub connection { $class->schema_instance->connection(@info); } +=begin hidden + =head2 setup_schema_instance Creates a class method ->schema_instance which contains a DBIx::Class::Schema; @@ -77,6 +93,8 @@ 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. +=end hidden + =cut sub setup_schema_instance { @@ -86,36 +104,52 @@ sub setup_schema_instance { $class->mk_classdata('schema_instance' => $schema); } +=begin hidden + =head2 txn_begin Begins a transaction (does nothing if AutoCommit is off). +=end hidden + =cut sub txn_begin { shift->schema_instance->txn_begin(@_); } +=begin hidden + =head2 txn_commit Commits the current transaction. +=end hidden + =cut sub txn_commit { shift->schema_instance->txn_commit(@_); } +=begin hidden + =head2 txn_rollback Rolls back the current transaction. +=end hidden + =cut sub txn_rollback { shift->schema_instance->txn_rollback(@_); } +=begin hidden + =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. +=end hidden + =cut sub txn_do { shift->schema_instance->txn_do(@_); } @@ -129,22 +163,30 @@ sub txn_do { shift->schema_instance->txn_do(@_); } } } +=begin hidden + =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. +=end hidden + =cut sub resultset_instance { $_[0]->result_source_instance->resultset } +=begin hidden + =head2 result_source_instance Returns an instance of the result source for this class +=end hidden + =cut __PACKAGE__->mk_classdata('_result_source_instance' => []); @@ -195,33 +237,43 @@ sub result_source_instance { return $source; } +=begin hidden + =head2 resolve_class ****DEPRECATED**** See L +=end hidden + +=begin hidden + =head2 dbi_commit ****DEPRECATED**** Alias for L +=end hidden + +=begin hidden + =head2 dbi_rollback ****DEPRECATED**** Alias for L -=end HIDE_BECAUSE_THIS_CLASS_IS_DEPRECATED +=end hidden -=head1 AUTHORS +=head1 AUTHOR AND CONTRIBUTORS -Matt S. Trout +See L and L in DBIx::Class =head1 LICENSE -You may distribute this code under the same terms as Perl itself. +You may distribute this code under the same terms as Perl itself =cut