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