| 1 | package DBIx::Class::DB; | ||||||||||||||||||||
| 2 | |||||||||||||||||||||
| 3 | 43 | ▶ | use strict; | ||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||
| 4 | 43 | ▶ | use warnings; | ||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||
| 5 | |||||||||||||||||||||
| 6 | 43 | ▶ | use base qw/DBIx::Class/; | ||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||
| 7 | 43 | ▶ | use DBIx::Class::Schema; | ||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||
| 8 | 43 | ▶ | use DBIx::Class::Storage::DBI; | ||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||
| 9 | 43 | ▶ | use DBIx::Class::ClassResolver::PassThrough; | ||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||
| 10 | 43 | ▶ | use DBI; | ||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||
| 11 | 43 | ▶ | use Scalar::Util 'blessed'; | ||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||
| 12 | 43 | ▶ | use namespace::clean; | ||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||
| 13 | |||||||||||||||||||||
| 14 | 43 | ▶ | unless ($INC{"DBIx/Class/CDBICompat.pm"}) { | ||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||
| 15 | 0 | warn "IMPORTANT: DBIx::Class::DB is DEPRECATED AND *WILL* BE REMOVED. DO NOT USE.\n"; | |||||||||||||||||||
| 16 | } | ||||||||||||||||||||
| 17 | |||||||||||||||||||||
| 18 | 43 | __PACKAGE__->load_components(qw/ResultSetProxy/); | |||||||||||||||||||
| 19 | |||||||||||||||||||||
| 20 | 0 | ▶ | sub storage { shift->schema_instance(@_)->storage; } | ||||||||||||||||||
|
Subroutine
storage: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||
| 21 | 0 | ▶ | sub dbi_commit { shift->txn_commit(@_) } | ||||||||||||||||||
|
Subroutine
dbi_commit: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||
| 22 | 0 | ▶ | sub dbi_rollback { shift->txn_rollback(@_) } | ||||||||||||||||||
|
Subroutine
dbi_rollback: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||
| 23 | |||||||||||||||||||||
| 24 | =head1 NAME | ||||||||||||||||||||
| 25 | |||||||||||||||||||||
| 26 | DBIx::Class::DB - (DEPRECATED) classdata schema component | ||||||||||||||||||||
| 27 | |||||||||||||||||||||
| 28 | =head1 DESCRIPTION | ||||||||||||||||||||
| 29 | |||||||||||||||||||||
| 30 | This class is designed to support the Class::DBI connection-as-classdata style | ||||||||||||||||||||
| 31 | for DBIx::Class. You are *strongly* recommended to use a DBIx::Class::Schema | ||||||||||||||||||||
| 32 | instead; DBIx::Class::DB will not undergo new development and will be moved | ||||||||||||||||||||
| 33 | to being a CDBICompat-only component before 1.0. In order to discourage further | ||||||||||||||||||||
| 34 | use, documentation has been removed as of 0.08000 | ||||||||||||||||||||
| 35 | |||||||||||||||||||||
| 36 | =head1 METHODS | ||||||||||||||||||||
| 37 | |||||||||||||||||||||
| 38 | Hidden. | ||||||||||||||||||||
| 39 | |||||||||||||||||||||
| 40 | =begin hidden | ||||||||||||||||||||
| 41 | |||||||||||||||||||||
| 42 | =head2 storage | ||||||||||||||||||||
| 43 | |||||||||||||||||||||
| 44 | Sets or gets the storage backend. Defaults to L<DBIx::Class::Storage::DBI>. | ||||||||||||||||||||
| 45 | |||||||||||||||||||||
| 46 | =end hidden | ||||||||||||||||||||
| 47 | |||||||||||||||||||||
| 48 | =cut | ||||||||||||||||||||
| 49 | |||||||||||||||||||||
| 50 | =begin hidden | ||||||||||||||||||||
| 51 | |||||||||||||||||||||
| 52 | =head2 class_resolver | ||||||||||||||||||||
| 53 | |||||||||||||||||||||
| 54 | ****DEPRECATED**** | ||||||||||||||||||||
| 55 | |||||||||||||||||||||
| 56 | Sets or gets the class to use for resolving a class. Defaults to | ||||||||||||||||||||
| 57 | L<DBIx::Class::ClassResolver::Passthrough>, which returns whatever you give | ||||||||||||||||||||
| 58 | it. See resolve_class below. | ||||||||||||||||||||
| 59 | |||||||||||||||||||||
| 60 | =end hidden | ||||||||||||||||||||
| 61 | |||||||||||||||||||||
| 62 | =cut | ||||||||||||||||||||
| 63 | |||||||||||||||||||||
| 64 | 43 | __PACKAGE__->mk_classdata('class_resolver' => | |||||||||||||||||||
| 65 | 'DBIx::Class::ClassResolver::PassThrough'); | ||||||||||||||||||||
| 66 | |||||||||||||||||||||
| 67 | =begin hidden | ||||||||||||||||||||
| 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 | =end hidden | ||||||||||||||||||||
| 77 | |||||||||||||||||||||
| 78 | =cut | ||||||||||||||||||||
| 79 | |||||||||||||||||||||
| 80 | 0 | ▶ | sub connection { | ||||||||||||||||||
|
Subroutine
connection: not called CC=2 SCAR=17.9
Pod
documented
| |||||||||||||||||||||
| 81 | 0 | my ($class, @info) = @_; | |||||||||||||||||||
| 82 | 0 | ▶ | $class->setup_schema_instance unless $class->can('schema_instance'); | ||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||
| 83 | 0 | $class->schema_instance->connection(@info); | |||||||||||||||||||
| 84 | } | ||||||||||||||||||||
| 85 | |||||||||||||||||||||
| 86 | =begin hidden | ||||||||||||||||||||
| 87 | |||||||||||||||||||||
| 88 | =head2 setup_schema_instance | ||||||||||||||||||||
| 89 | |||||||||||||||||||||
| 90 | Creates a class method ->schema_instance which contains a DBIx::Class::Schema; | ||||||||||||||||||||
| 91 | all class-method operations are proxies through to this object. If you don't | ||||||||||||||||||||
| 92 | call ->connection in your DBIx::Class::DB subclass at load time you *must* | ||||||||||||||||||||
| 93 | call ->setup_schema_instance in order for subclasses to find the schema and | ||||||||||||||||||||
| 94 | register themselves with it. | ||||||||||||||||||||
| 95 | |||||||||||||||||||||
| 96 | =end hidden | ||||||||||||||||||||
| 97 | |||||||||||||||||||||
| 98 | =cut | ||||||||||||||||||||
| 99 | |||||||||||||||||||||
| 100 | 0 | ▶ | sub setup_schema_instance { | ||||||||||||||||||
|
Subroutine
setup_schema_instance: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||
| 101 | 0 | my $class = shift; | |||||||||||||||||||
| 102 | 0 | my $schema = {}; | |||||||||||||||||||
| 103 | 0 | bless $schema, 'DBIx::Class::Schema'; | |||||||||||||||||||
| 104 | 0 | $class->mk_classdata('schema_instance' => $schema); | |||||||||||||||||||
| 105 | } | ||||||||||||||||||||
| 106 | |||||||||||||||||||||
| 107 | =begin hidden | ||||||||||||||||||||
| 108 | |||||||||||||||||||||
| 109 | =head2 txn_begin | ||||||||||||||||||||
| 110 | |||||||||||||||||||||
| 111 | Begins a transaction (does nothing if AutoCommit is off). | ||||||||||||||||||||
| 112 | |||||||||||||||||||||
| 113 | =end hidden | ||||||||||||||||||||
| 114 | |||||||||||||||||||||
| 115 | =cut | ||||||||||||||||||||
| 116 | |||||||||||||||||||||
| 117 | 0 | ▶ | sub txn_begin { shift->schema_instance->txn_begin(@_); } | ||||||||||||||||||
|
Subroutine
txn_begin: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||
| 118 | |||||||||||||||||||||
| 119 | =begin hidden | ||||||||||||||||||||
| 120 | |||||||||||||||||||||
| 121 | =head2 txn_commit | ||||||||||||||||||||
| 122 | |||||||||||||||||||||
| 123 | Commits the current transaction. | ||||||||||||||||||||
| 124 | |||||||||||||||||||||
| 125 | =end hidden | ||||||||||||||||||||
| 126 | |||||||||||||||||||||
| 127 | =cut | ||||||||||||||||||||
| 128 | |||||||||||||||||||||
| 129 | 0 | ▶ | sub txn_commit { shift->schema_instance->txn_commit(@_); } | ||||||||||||||||||
|
Subroutine
txn_commit: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||
| 130 | |||||||||||||||||||||
| 131 | =begin hidden | ||||||||||||||||||||
| 132 | |||||||||||||||||||||
| 133 | =head2 txn_rollback | ||||||||||||||||||||
| 134 | |||||||||||||||||||||
| 135 | Rolls back the current transaction. | ||||||||||||||||||||
| 136 | |||||||||||||||||||||
| 137 | =end hidden | ||||||||||||||||||||
| 138 | |||||||||||||||||||||
| 139 | =cut | ||||||||||||||||||||
| 140 | |||||||||||||||||||||
| 141 | 0 | ▶ | sub txn_rollback { shift->schema_instance->txn_rollback(@_); } | ||||||||||||||||||
|
Subroutine
txn_rollback: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||
| 142 | |||||||||||||||||||||
| 143 | =begin hidden | ||||||||||||||||||||
| 144 | |||||||||||||||||||||
| 145 | =head2 txn_do | ||||||||||||||||||||
| 146 | |||||||||||||||||||||
| 147 | Executes a block of code transactionally. If this code reference | ||||||||||||||||||||
| 148 | throws an exception, the transaction is rolled back and the exception | ||||||||||||||||||||
| 149 | is rethrown. See L<DBIx::Class::Schema/"txn_do"> for more details. | ||||||||||||||||||||
| 150 | |||||||||||||||||||||
| 151 | =end hidden | ||||||||||||||||||||
| 152 | |||||||||||||||||||||
| 153 | =cut | ||||||||||||||||||||
| 154 | |||||||||||||||||||||
| 155 | 0 | ▶ | sub txn_do { shift->schema_instance->txn_do(@_); } | ||||||||||||||||||
|
Subroutine
txn_do: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||
| 156 | |||||||||||||||||||||
| 157 | { | ||||||||||||||||||||
| 158 | 43 | my $warn; | |||||||||||||||||||
| 159 | |||||||||||||||||||||
| 160 | 0 | ▶ | sub resolve_class { | ||||||||||||||||||
|
Subroutine
resolve_class: not called CC=2 SCAR=17.9
Pod
documented
| |||||||||||||||||||||
| 161 | 0 | ▶ | warn "resolve_class deprecated as of 0.04999_02" unless $warn++; | ||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||
| 162 | 0 | return shift->class_resolver->class(@_); | |||||||||||||||||||
| 163 | } | ||||||||||||||||||||
| 164 | } | ||||||||||||||||||||
| 165 | |||||||||||||||||||||
| 166 | =begin hidden | ||||||||||||||||||||
| 167 | |||||||||||||||||||||
| 168 | =head2 resultset_instance | ||||||||||||||||||||
| 169 | |||||||||||||||||||||
| 170 | Returns an instance of a resultset for this class - effectively | ||||||||||||||||||||
| 171 | mapping the L<Class::DBI> connection-as-classdata paradigm into the | ||||||||||||||||||||
| 172 | native L<DBIx::Class::ResultSet> system. | ||||||||||||||||||||
| 173 | |||||||||||||||||||||
| 174 | =end hidden | ||||||||||||||||||||
| 175 | |||||||||||||||||||||
| 176 | =cut | ||||||||||||||||||||
| 177 | |||||||||||||||||||||
| 178 | 43 | ▶ | sub resultset_instance { | ||||||||||||||||||
|
Subroutine
resultset_instance: not called CC=1 SCAR=1.2
Pod
documented
| |||||||||||||||||||||
| 179 | 0 | $_[0]->result_source_instance->resultset | |||||||||||||||||||
| 180 | } | ||||||||||||||||||||
| 181 | |||||||||||||||||||||
| 182 | =begin hidden | ||||||||||||||||||||
| 183 | |||||||||||||||||||||
| 184 | =head2 result_source_instance | ||||||||||||||||||||
| 185 | |||||||||||||||||||||
| 186 | Returns an instance of the result source for this class | ||||||||||||||||||||
| 187 | |||||||||||||||||||||
| 188 | =end hidden | ||||||||||||||||||||
| 189 | |||||||||||||||||||||
| 190 | =cut | ||||||||||||||||||||
| 191 | |||||||||||||||||||||
| 192 | 43 | __PACKAGE__->mk_classdata('_result_source_instance' => []); | |||||||||||||||||||
| 193 | |||||||||||||||||||||
| 194 | # Yep. this is horrific. Basically what's happening here is that | ||||||||||||||||||||
| 195 | # (with good reason) DBIx::Class::Schema copies the result source for | ||||||||||||||||||||
| 196 | # registration. Because we have a retarded setup order forced on us we need | ||||||||||||||||||||
| 197 | # to actually make our ->result_source_instance -be- the source used, and we | ||||||||||||||||||||
| 198 | # need to get the source name and schema into ourselves. So this makes it | ||||||||||||||||||||
| 199 | # happen. | ||||||||||||||||||||
| 200 | |||||||||||||||||||||
| 201 | 0 | ▶ | sub _maybe_attach_source_to_schema { | ||||||||||||||||||
|
Subroutine
_maybe_attach_source_to_schema: not called CC=3 SCAR=24.8
| |||||||||||||||||||||
| 202 | 0 | my ($class, $source) = @_; | |||||||||||||||||||
| 203 | 0 | ▶ | if (my $meth = $class->can('schema_instance')) { | ||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||
| 204 | 0 | ▶ | if (my $schema = $class->$meth) { | ||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||
| 205 | 0 | $schema->register_class($class, $class); | |||||||||||||||||||
| 206 | 0 | my $new_source = $schema->source($class); | |||||||||||||||||||
| 207 | 0 | %$source = %$new_source; | |||||||||||||||||||
| 208 | 0 | $schema->source_registrations->{$class} = $source; | |||||||||||||||||||
| 209 | } | ||||||||||||||||||||
| 210 | } | ||||||||||||||||||||
| 211 | } | ||||||||||||||||||||
| 212 | |||||||||||||||||||||
| 213 | 0 | ▶ | sub result_source_instance { | ||||||||||||||||||
|
Subroutine
result_source_instance: not called CC=5 SCAR=34.0
Pod
documented
| |||||||||||||||||||||
| 214 | 0 | my $class = shift; | |||||||||||||||||||
| 215 | 0 | ▶ | $class = ref $class || $class; | ||||||||||||||||||
|
Condition0%0/3
ref $class || $class
MC/DC0%0/2
ref $class || $class
ref $class
$class
Truth table0%0/3
A || B
A= ref $classB= $class
| |||||||||||||||||||||
| 216 | |||||||||||||||||||||
| 217 | 0 | ▶ | if (@_) { | ||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||
| 218 | 0 | my $source = $_[0]; | |||||||||||||||||||
| 219 | 0 | $class->_result_source_instance([$source, $class]); | |||||||||||||||||||
| 220 | 0 | $class->_maybe_attach_source_to_schema($source); | |||||||||||||||||||
| 221 | 0 | return $source; | |||||||||||||||||||
| 222 | } | ||||||||||||||||||||
| 223 | |||||||||||||||||||||
| 224 | 0 | my($source, $result_class) = @{$class->_result_source_instance}; | |||||||||||||||||||
| 225 | 0 | ▶ | return unless blessed $source; | ||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||
| 226 | |||||||||||||||||||||
| 227 | 0 | ▶ | if ($result_class ne $class) { # new class | ||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||
| 228 | # Give this new class its own source and register it. | ||||||||||||||||||||
| 229 | 0 | $source = $source->new({ | |||||||||||||||||||
| 230 | %$source, | ||||||||||||||||||||
| 231 | source_name => $class, | ||||||||||||||||||||
| 232 | result_class => $class | ||||||||||||||||||||
| 233 | } ); | ||||||||||||||||||||
| 234 | 0 | $class->_result_source_instance([$source, $class]); | |||||||||||||||||||
| 235 | 0 | $class->_maybe_attach_source_to_schema($source); | |||||||||||||||||||
| 236 | } | ||||||||||||||||||||
| 237 | 0 | return $source; | |||||||||||||||||||
| 238 | } | ||||||||||||||||||||
| 239 | |||||||||||||||||||||
| 240 | =begin hidden | ||||||||||||||||||||
| 241 | |||||||||||||||||||||
| 242 | =head2 resolve_class | ||||||||||||||||||||
| 243 | |||||||||||||||||||||
| 244 | ****DEPRECATED**** | ||||||||||||||||||||
| 245 | |||||||||||||||||||||
| 246 | See L</class_resolver> | ||||||||||||||||||||
| 247 | |||||||||||||||||||||
| 248 | =end hidden | ||||||||||||||||||||
| 249 | |||||||||||||||||||||
| 250 | =begin hidden | ||||||||||||||||||||
| 251 | |||||||||||||||||||||
| 252 | =head2 dbi_commit | ||||||||||||||||||||
| 253 | |||||||||||||||||||||
| 254 | ****DEPRECATED**** | ||||||||||||||||||||
| 255 | |||||||||||||||||||||
| 256 | Alias for L</txn_commit> | ||||||||||||||||||||
| 257 | |||||||||||||||||||||
| 258 | =end hidden | ||||||||||||||||||||
| 259 | |||||||||||||||||||||
| 260 | =begin hidden | ||||||||||||||||||||
| 261 | |||||||||||||||||||||
| 262 | =head2 dbi_rollback | ||||||||||||||||||||
| 263 | |||||||||||||||||||||
| 264 | ****DEPRECATED**** | ||||||||||||||||||||
| 265 | |||||||||||||||||||||
| 266 | Alias for L</txn_rollback> | ||||||||||||||||||||
| 267 | |||||||||||||||||||||
| 268 | =end hidden | ||||||||||||||||||||
| 269 | |||||||||||||||||||||
| 270 | =head1 FURTHER QUESTIONS? | ||||||||||||||||||||
| 271 | |||||||||||||||||||||
| 272 | Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>. | ||||||||||||||||||||
| 273 | |||||||||||||||||||||
| 274 | =head1 COPYRIGHT AND LICENSE | ||||||||||||||||||||
| 275 | |||||||||||||||||||||
| 276 | This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE> | ||||||||||||||||||||
| 277 | by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can | ||||||||||||||||||||
| 278 | redistribute it and/or modify it under the same terms as the | ||||||||||||||||||||
| 279 | L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>. | ||||||||||||||||||||
| 280 | |||||||||||||||||||||
| 281 | =cut | ||||||||||||||||||||
| 282 | |||||||||||||||||||||
| 283 | 43 | 1; | |||||||||||||||||||