lib/DBIx/Class/DB.pm

   1 package DBIx::Class::DB;
   2
   3 use strict;
   4 use warnings;
   5
   6 use base qw/DBIx::Class/;
   7 use DBIx::Class::Schema;
   8 use DBIx::Class::Storage::DBI;
   9 use DBIx::Class::ClassResolver::PassThrough;
  10 use DBI;
  11
  12 __PACKAGE__->load_components(qw/ResultSetProxy/);
  13
  14 {
  15     no warnings 'once';
  16     *dbi_commit = \&txn_commit;
  17     *dbi_rollback = \&txn_rollback;
  18 }
  19
  20 sub storage { shift->schema_instance(@_)->storage; }
  21
  22 =head1 NAME
  23
  24 DBIx::Class::DB - (DEPRECATED) classdata schema component
  25
  26 =head1 SYNOPSIS
  27
  28   package MyDB;
  29
  30   use base qw/DBIx::Class/;
  31   __PACKAGE__->load_components('DB');
  32
  33   __PACKAGE__->connection('dbi:...', 'user', 'pass', \%attrs);
  34
  35   package MyDB::MyTable;
  36
  37   use base qw/MyDB/;
  38   __PACKAGE__->load_components('Core'); # just load this in MyDB if it will
  39                                         # always be there
  40
  41   ...
  42
  43 =head1 DESCRIPTION
  44
  45 This class is designed to support the Class::DBI connection-as-classdata style
  46 for DBIx::Class. You are *strongly* recommended to use a DBIx::Class::Schema
  47 instead; DBIx::Class::DB will not undergo new development and will be moved
  48 to being a CDBICompat-only component before 1.0.
  49
  50 =head1 METHODS
  51
  52 =head2 storage
  53
  54 Sets or gets the storage backend. Defaults to L<DBIx::Class::Storage::DBI>.
  55
  56 =head2 class_resolver
  57
  58 ****DEPRECATED****
  59
  60 Sets or gets the class to use for resolving a class. Defaults to
  61 L<DBIx::Class::ClassResolver::Passthrough>, which returns whatever you give
  62 it. See resolve_class below.
  63
  64 =cut
  65
  66 __PACKAGE__->mk_classdata('class_resolver' =>
  67                           'DBIx::Class::ClassResolver::PassThrough');
  68
  69 =head2 connection
  70
  71   __PACKAGE__->connection($dsn, $user, $pass, $attrs);
  72
  73 Specifies the arguments that will be passed to DBI->connect(...) to
  74 instantiate the class dbh when required.
  75
  76 =cut
  77
  78 sub connection {
  79   my ($class, @info) = @_;
  80   $class->setup_schema_instance unless $class->can('schema_instance');
  81   $class->schema_instance->connection(@info);
  82 }
  83
  84 =head2 setup_schema_instance
  85
  86 Creates a class method ->schema_instance which contains a DBIx::Class::Schema;
  87 all class-method operations are proxies through to this object. If you don't
  88 call ->connection in your DBIx::Class::DB subclass at load time you *must*
  89 call ->setup_schema_instance in order for subclasses to find the schema and
  90 register themselves with it.
  91
  92 =cut
  93
  94 sub setup_schema_instance {
  95   my $class = shift;
  96   my $schema = bless({}, 'DBIx::Class::Schema');
  97   $class->mk_classdata('schema_instance' => $schema);
  98 }
  99
 100 =head2 txn_begin
 101
 102 Begins a transaction (does nothing if AutoCommit is off).
 103
 104 =cut
 105
 106 sub txn_begin { shift->schema_instance->txn_begin(@_); }
 107
 108 =head2 txn_commit
 109
 110 Commits the current transaction.
 111
 112 =cut
 113
 114 sub txn_commit { shift->schema_instance->txn_commit(@_); }
 115
 116 =head2 txn_rollback
 117
 118 Rolls back the current transaction.
 119
 120 =cut
 121
 122 sub txn_rollback { shift->schema_instance->txn_rollback(@_); }
 123
 124 =head2 txn_do
 125
 126 Executes a block of code transactionally. If this code reference
 127 throws an exception, the transaction is rolled back and the exception
 128 is rethrown. See L<DBIx::Class::Schema/"txn_do"> for more details.
 129
 130 =cut
 131
 132 sub txn_do { shift->schema_instance->txn_do(@_); }
 133
 134 {
 135   my $warn;
 136
 137   sub resolve_class {
 138     warn "resolve_class deprecated as of 0.04999_02" unless $warn++;
 139     return shift->class_resolver->class(@_);
 140   }
 141 }
 142
 143 =head2 resultset_instance
 144
 145 Returns an instance of a resultset for this class - effectively
 146 mapping the L<Class::DBI> connection-as-classdata paradigm into the
 147 native L<DBIx::Class::ResultSet> system.
 148
 149 =cut
 150
 151 sub resultset_instance {
 152   my $class = ref $_[0] || $_[0];
 153   my $source = $class->result_source_instance;
 154   if ($source->result_class ne $class) {
 155     $source = $source->new($source);
 156     $source->result_class($class);
 157   }
 158   return $source->resultset;
 159 }
 160
 161 =head2 resolve_class
 162
 163 ****DEPRECATED****
 164
 165 See L<class_resolver>
 166
 167 =head2 dbi_commit
 168
 169 ****DEPRECATED****
 170
 171 Alias for L<txn_commit>
 172
 173 =head2 dbi_rollback
 174
 175 ****DEPRECATED****
 176
 177 Alias for L<txn_rollback>
 178
 179 =head1 AUTHORS
 180
 181 Matt S. Trout <mst@shadowcatsystems.co.uk>
 182
 183 =head1 LICENSE
 184
 185 You may distribute this code under the same terms as Perl itself.
 186
 187 =cut
 188
 189 1;