Chucked out some unrequired column case stuff in CDBICompat
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / DB.pm
CommitLineData
ea2e61bf 1package DBIx::Class::DB;
2
1edd1722 3use base qw/DBIx::Class/;
7fb16f1a 4use DBIx::Class::Schema;
8b445e33 5use DBIx::Class::Storage::DBI;
11b78bd6 6use DBIx::Class::ClassResolver::PassThrough;
604d9f38 7use DBI;
ea2e61bf 8
2d679367 9__PACKAGE__->load_components(qw/ResultSetInstance/);
10
8091aa91 11*dbi_commit = \&txn_commit;
12*dbi_rollback = \&txn_rollback;
13
7fb16f1a 14sub storage { shift->schema_instance(@_)->storage; }
2d679367 15
f6858c33 16sub resultset_instance {
17 my $class = shift;
7fb16f1a 18 my $source = $class->result_source;
19 if ($source->result_class ne $class) {
20 $source = $source->new($source);
21 $source->result_class($class);
22 }
23 return $source->resultset;
88cb6a1d 24}
25
34d52be2 26=head1 NAME
27
8b445e33 28DBIx::Class::DB - Simple DBIx::Class Database connection by class inheritance
34d52be2 29
30=head1 SYNOPSIS
31
8b445e33 32 package MyDB;
33
34 use base qw/DBIx::Class/;
503536d5 35 __PACKAGE__->load_components('DB');
8b445e33 36
37 __PACKAGE__->connection('dbi:...', 'user', 'pass', \%attrs);
38
39 package MyDB::MyTable;
40
41 use base qw/MyDB/;
8091aa91 42 __PACKAGE__->load_components('Core'); # just load this in MyDB if it will always be there
4a9d7cae 43
44 ...
8b445e33 45
34d52be2 46=head1 DESCRIPTION
47
8b445e33 48This class provides a simple way of specifying a database connection.
34d52be2 49
50=head1 METHODS
51
8091aa91 52=head2 storage
076652e8 53
8091aa91 54Sets or gets the storage backend. Defaults to L<DBIx::Class::Storage::DBI>.
076652e8 55
7fb16f1a 56=head2 class_resolver ****DEPRECATED****
076652e8 57
8091aa91 58Sets or gets the class to use for resolving a class. Defaults to
59L<DBIx::Class::ClassResolver::Passthrough>, which returns whatever you give
60it. See resolve_class below.
076652e8 61
34d52be2 62=cut
63
11b78bd6 64__PACKAGE__->mk_classdata('class_resolver' =>
65 'DBIx::Class::ClassResolver::PassThrough');
8fe001e1 66
8091aa91 67=head2 connection
39fe0e65 68
69 __PACKAGE__->connection($dsn, $user, $pass, $attrs);
70
71Specifies the arguments that will be passed to DBI->connect(...) to
72instantiate the class dbh when required.
73
74=cut
75
8fe001e1 76sub connection {
77 my ($class, @info) = @_;
8b445e33 78 my $storage = DBIx::Class::Storage::DBI->new;
79 $storage->connect_info(\@info);
7fb16f1a 80 my $schema = bless({ storage => $storage }, 'DBIx::Class::Schema');
81 $class->mk_classdata('schema_instance' => $schema);
ea2e61bf 82}
83
8091aa91 84=head2 txn_begin
39fe0e65 85
8091aa91 86Begins a transaction (does nothing if AutoCommit is off).
39fe0e65 87
88=cut
89
8091aa91 90sub txn_begin { $_[0]->storage->txn_begin }
a29644e1 91
8091aa91 92=head2 txn_commit
39fe0e65 93
8091aa91 94Commits the current transaction.
39fe0e65 95
8091aa91 96=cut
97
98sub txn_commit { $_[0]->storage->txn_commit }
99
100=head2 txn_rollback
101
102Rolls back the current transaction.
39fe0e65 103
104=cut
105
8091aa91 106sub txn_rollback { $_[0]->storage->txn_rollback }
8b445e33 107
7fb16f1a 108sub resolve_class {
109 warn "resolve_class deprecated as of 0.04999_02";
110 return shift->class_resolver->class(@_);
111}
11b78bd6 112
ea2e61bf 1131;
34d52be2 114
34d52be2 115=head1 AUTHORS
116
daec44b8 117Matt S. Trout <mst@shadowcatsystems.co.uk>
34d52be2 118
119=head1 LICENSE
120
121You may distribute this code under the same terms as Perl itself.
122
123=cut
124