1 package DBIx::Class::Schema;
6 use Carp::Clan qw/^DBIx::Class/;
7 use Scalar::Util qw/weaken/;
9 use base qw/DBIx::Class/;
11 __PACKAGE__->mk_classdata('class_mappings' => {});
12 __PACKAGE__->mk_classdata('source_registrations' => {});
13 __PACKAGE__->mk_classdata('storage_type' => '::DBI');
14 __PACKAGE__->mk_classdata('storage');
18 DBIx::Class::Schema - composable schemas
22 package Library::Schema;
23 use base qw/DBIx::Class::Schema/;
25 # load Library::Schema::CD, Library::Schema::Book, Library::Schema::DVD
26 __PACKAGE__->load_classes(qw/CD Book DVD/);
28 package Library::Schema::CD;
29 use base qw/DBIx::Class/;
30 __PACKAGE__->load_components(qw/PK::Auto Core/); # for example
31 __PACKAGE__->table('cd');
33 # Elsewhere in your code:
34 my $schema1 = Library::Schema->connect(
41 my $schema2 = Library::Schema->connect($coderef_returning_dbh);
43 # fetch objects using Library::Schema::DVD
44 my $resultset = $schema1->resultset('DVD')->search( ... );
45 my @dvd_objects = $schema2->resultset('DVD')->search( ... );
49 Creates database classes based on a schema. This is the recommended way to
50 use L<DBIx::Class> and allows you to use more than one concurrent connection
53 NB: If you're used to L<Class::DBI> it's worth reading the L</SYNOPSIS>
54 carefully, as DBIx::Class does things a little differently. Note in
55 particular which module inherits off which.
63 =item Arguments: $moniker, $component_class
67 Registers a class which isa DBIx::Class::ResultSourceProxy. Equivalent to
70 $schema->register_source($moniker, $component_class->result_source_instance);
75 my ($self, $moniker, $to_register) = @_;
76 $self->register_source($moniker => $to_register->result_source_instance);
79 =head2 register_source
83 =item Arguments: $moniker, $result_source
87 Registers the L<DBIx::Class::ResultSource> in the schema with the given
93 my ($self, $moniker, $source) = @_;
94 my %reg = %{$self->source_registrations};
95 $reg{$moniker} = $source;
96 $self->source_registrations(\%reg);
97 $source->schema($self);
98 weaken($source->{schema}) if ref($self);
99 if ($source->result_class) {
100 my %map = %{$self->class_mappings};
101 $map{$source->result_class} = $moniker;
102 $self->class_mappings(\%map);
110 =item Arguments: $moniker
112 =item Return Value: $classname
116 Retrieves the result class name for the given moniker. For example:
118 my $class = $schema->class('CD');
123 my ($self, $moniker) = @_;
124 return $self->source($moniker)->result_class;
131 =item Arguments: $moniker
133 =item Return Value: $result_source
137 my $source = $schema->source('Book');
139 Returns the L<DBIx::Class::ResultSource> object for the registered moniker.
144 my ($self, $moniker) = @_;
145 my $sreg = $self->source_registrations;
146 return $sreg->{$moniker} if exists $sreg->{$moniker};
148 # if we got here, they probably passed a full class name
149 my $mapped = $self->class_mappings->{$moniker};
150 $self->throw_exception("Can't find source for ${moniker}")
151 unless $mapped && exists $sreg->{$mapped};
152 return $sreg->{$mapped};
159 =item Return Value: @source_monikers
163 Returns the source monikers of all source registrations on this schema.
166 my @source_monikers = $schema->sources;
170 sub sources { return keys %{shift->source_registrations}; }
174 my $storage = $schema->storage;
176 Returns the L<DBIx::Class::Storage> object for this Schema.
182 =item Arguments: $moniker
184 =item Return Value: $result_set
188 my $rs = $schema->resultset('DVD');
190 Returns the L<DBIx::Class::ResultSet> object for the registered moniker.
195 my ($self, $moniker) = @_;
196 return $self->source($moniker)->resultset;
203 =item Arguments: @classes?, { $namespace => [ @classes ] }+
207 With no arguments, this method uses L<Module::Find> to find all classes under
208 the schema's namespace. Otherwise, this method loads the classes you specify
209 (using L<use>), and registers them (using L</"register_class">).
211 It is possible to comment out classes with a leading C<#>, but note that perl
212 will think it's a mistake (trying to use a comment in a qw list), so you'll
213 need to add C<no warnings 'qw';> before your load_classes call.
217 My::Schema->load_classes(); # loads My::Schema::CD, My::Schema::Artist,
218 # etc. (anything under the My::Schema namespace)
220 # loads My::Schema::CD, My::Schema::Artist, Other::Namespace::Producer but
221 # not Other::Namespace::LinerNotes nor My::Schema::Track
222 My::Schema->load_classes(qw/ CD Artist #Track /, {
223 Other::Namespace => [qw/ Producer #LinerNotes /],
229 my ($class, @params) = @_;
234 foreach my $param (@params) {
235 if (ref $param eq 'ARRAY') {
236 # filter out commented entries
237 my @modules = grep { $_ !~ /^#/ } @$param;
239 push (@{$comps_for{$class}}, @modules);
241 elsif (ref $param eq 'HASH') {
242 # more than one namespace possible
243 for my $comp ( keys %$param ) {
244 # filter out commented entries
245 my @modules = grep { $_ !~ /^#/ } @{$param->{$comp}};
247 push (@{$comps_for{$comp}}, @modules);
251 # filter out commented entries
252 push (@{$comps_for{$class}}, $param) if $param !~ /^#/;
256 eval "require Module::Find;";
257 $class->throw_exception(
258 "No arguments to load_classes and couldn't load Module::Find ($@)"
260 my @comp = map { substr $_, length "${class}::" }
261 Module::Find::findallmod($class);
262 $comps_for{$class} = \@comp;
267 no warnings qw/redefine/;
268 local *Class::C3::reinitialize = sub { };
269 foreach my $prefix (keys %comps_for) {
270 foreach my $comp (@{$comps_for{$prefix}||[]}) {
271 my $comp_class = "${prefix}::${comp}";
272 { # try to untaint module name. mods where this fails
273 # are left alone so we don't have to change the old behavior
274 no locale; # localized \w doesn't untaint expression
275 if ( $comp_class =~ m/^( (?:\w+::)* \w+ )$/x ) {
279 $class->ensure_class_loaded($comp_class);
280 $comp_class->source_name($comp) unless $comp_class->source_name;
282 push(@to_register, [ $comp_class->source_name, $comp_class ]);
286 Class::C3->reinitialize;
288 foreach my $to (@to_register) {
289 $class->register_class(@$to);
290 # if $class->can('result_source_instance');
294 =head2 compose_connection
298 =item Arguments: $target_namespace, @db_info
300 =item Return Value: $new_schema
304 Calls L<DBIx::Class::Schema/"compose_namespace"> to the target namespace,
305 calls L<DBIx::Class::Schema/connection> with @db_info on the new schema,
306 then injects the L<DBix::Class::ResultSetProxy> component and a
307 resultset_instance classdata entry on all the new classes, in order to support
308 $target_namespaces::$class->search(...) method calls.
310 This is primarily useful when you have a specific need for class method access
311 to a connection. In normal usage it is preferred to call
312 L<DBIx::Class::Schema/connect> and use the resulting schema object to operate
313 on L<DBIx::Class::ResultSet> objects with L<DBIx::Class::Schema/resultset> for
318 sub compose_connection {
319 my ($self, $target, @info) = @_;
320 my $base = 'DBIx::Class::ResultSetProxy';
321 eval "require ${base};";
322 $self->throw_exception
323 ("No arguments to load_classes and couldn't load ${base} ($@)")
326 if ($self eq $target) {
327 # Pathological case, largely caused by the docs on early C::M::DBIC::Plain
328 foreach my $moniker ($self->sources) {
329 my $source = $self->source($moniker);
330 my $class = $source->result_class;
331 $self->inject_base($class, $base);
332 $class->mk_classdata(resultset_instance => $source->resultset);
333 $class->mk_classdata(class_resolver => $self);
335 $self->connection(@info);
339 my $schema = $self->compose_namespace($target, $base);
342 *{"${target}::schema"} = sub { $schema };
345 $schema->connection(@info);
346 foreach my $moniker ($schema->sources) {
347 my $source = $schema->source($moniker);
348 my $class = $source->result_class;
349 #warn "$moniker $class $source ".$source->storage;
350 $class->mk_classdata(result_source_instance => $source);
351 $class->mk_classdata(resultset_instance => $source->resultset);
352 $class->mk_classdata(class_resolver => $schema);
357 =head2 compose_namespace
361 =item Arguments: $target_namespace, $additional_base_class?
363 =item Return Value: $new_schema
367 For each L<DBIx::Class::ResultSource> in the schema, this method creates a
368 class in the target namespace (e.g. $target_namespace::CD,
369 $target_namespace::Artist) that inherits from the corresponding classes
370 attached to the current schema.
372 It also attaches a corresponding L<DBIx::Class::ResultSource> object to the
373 new $schema object. If C<$additional_base_class> is given, the new composed
374 classes will inherit from first the corresponding classe from the current
375 schema then the base class.
377 For example, for a schema with My::Schema::CD and My::Schema::Artist classes,
379 $schema->compose_namespace('My::DB', 'Base::Class');
380 print join (', ', @My::DB::CD::ISA) . "\n";
381 print join (', ', @My::DB::Artist::ISA) ."\n";
383 will produce the output
385 My::Schema::CD, Base::Class
386 My::Schema::Artist, Base::Class
390 sub compose_namespace {
391 my ($self, $target, $base) = @_;
392 my %reg = %{ $self->source_registrations };
395 my $schema = $self->clone;
397 no warnings qw/redefine/;
398 local *Class::C3::reinitialize = sub { };
399 foreach my $moniker ($schema->sources) {
400 my $source = $schema->source($moniker);
401 my $target_class = "${target}::${moniker}";
403 $target_class => $source->result_class, ($base ? $base : ())
405 $source->result_class($target_class);
406 $target_class->result_source_instance($source)
407 if $target_class->can('result_source_instance');
410 Class::C3->reinitialize();
413 foreach my $meth (qw/class source resultset/) {
414 *{"${target}::${meth}"} =
415 sub { shift->schema->$meth(@_) };
421 =head2 setup_connection_class
425 =item Arguments: $target, @info
429 Sets up a database connection class to inject between the schema and the
430 subclasses that the schema creates.
434 sub setup_connection_class {
435 my ($class, $target, @info) = @_;
436 $class->inject_base($target => 'DBIx::Class::DB');
437 #$target->load_components('DB');
438 $target->connection(@info);
445 =item Arguments: $storage_type
447 =item Return Value: $storage_type
451 Set the storage class that will be instantiated when L</connect> is called.
452 If the classname starts with C<::>, the prefix C<DBIx::Class::Storage> is
453 assumed by L</connect>. Defaults to C<::DBI>,
454 which is L<DBIx::Class::Storage::DBI>.
456 You want to use this to hardcoded subclasses of L<DBIx::Class::Storage::DBI>
457 in cases where the appropriate subclass is not autodetected, such as when
458 dealing with MSSQL via L<DBD::Sybase>, in which case you'd set it to
459 C<::DBI::Sybase::MSSQL>.
465 =item Arguments: @args
467 =item Return Value: $new_schema
471 Instantiates a new Storage object of type
472 L<DBIx::Class::Schema/"storage_type"> and passes the arguments to
473 $storage->connect_info. Sets the connection in-place on the schema. See
474 L<DBIx::Class::Storage::DBI/"connect_info"> for more information.
479 my ($self, @info) = @_;
480 return $self if !@info && $self->storage;
481 my $storage_class = $self->storage_type;
482 $storage_class = 'DBIx::Class::Storage'.$storage_class
483 if $storage_class =~ m/^::/;
484 eval "require ${storage_class};";
485 $self->throw_exception(
486 "No arguments to load_classes and couldn't load ${storage_class} ($@)"
488 my $storage = $storage_class->new;
489 $storage->connect_info(\@info);
490 $self->storage($storage);
498 =item Arguments: @info
500 =item Return Value: $new_schema
504 This is a convenience method. It is equivalent to calling
505 $schema->clone->connection(@info). See L</connection> and L</clone> for more
510 sub connect { shift->clone->connection(@_) }
514 Begins a transaction (does nothing if AutoCommit is off). Equivalent to
515 calling $schema->storage->txn_begin. See
516 L<DBIx::Class::Storage::DBI/"txn_begin"> for more information.
520 sub txn_begin { shift->storage->txn_begin }
524 Commits the current transaction. Equivalent to calling
525 $schema->storage->txn_commit. See L<DBIx::Class::Storage::DBI/"txn_commit">
526 for more information.
530 sub txn_commit { shift->storage->txn_commit }
534 Rolls back the current transaction. Equivalent to calling
535 $schema->storage->txn_rollback. See
536 L<DBIx::Class::Storage::DBI/"txn_rollback"> for more information.
540 sub txn_rollback { shift->storage->txn_rollback }
546 =item Arguments: C<$coderef>, @coderef_args?
548 =item Return Value: The return value of $coderef
552 Executes C<$coderef> with (optional) arguments C<@coderef_args> atomically,
553 returning its result (if any). If an exception is caught, a rollback is issued
554 and the exception is rethrown. If the rollback fails, (i.e. throws an
555 exception) an exception is thrown that includes a "Rollback failed" message.
559 my $author_rs = $schema->resultset('Author')->find(1);
560 my @titles = qw/Night Day It/;
563 # If any one of these fails, the entire transaction fails
564 $author_rs->create_related('books', {
566 }) foreach (@titles);
568 return $author->books;
573 $rs = $schema->txn_do($coderef);
576 if ($@) { # Transaction failed
577 die "something terrible has happened!" #
578 if ($@ =~ /Rollback failed/); # Rollback failed
580 deal_with_failed_transaction();
583 In a nested transaction (calling txn_do() from within a txn_do() coderef) only
584 the outermost transaction will issue a L<DBIx::Class::Schema/"txn_commit"> on
585 the Schema's storage, and txn_do() can be called in void, scalar and list
586 context and it will behave as expected.
591 my ($self, $coderef, @args) = @_;
593 $self->storage or $self->throw_exception
594 ('txn_do called on $schema without storage');
595 ref $coderef eq 'CODE' or $self->throw_exception
596 ('$coderef must be a CODE reference');
598 my (@return_values, $return_value);
600 $self->txn_begin; # If this throws an exception, no rollback is needed
602 my $wantarray = wantarray; # Need to save this since the context
603 # inside the eval{} block is independent
604 # of the context that called txn_do()
607 # Need to differentiate between scalar/list context to allow for
608 # returning a list in scalar context to get the size of the list
611 @return_values = $coderef->(@args);
612 } elsif (defined $wantarray) {
614 $return_value = $coderef->(@args);
630 my $rollback_error = $@;
631 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
632 $self->throw_exception($error) # propagate nested rollback
633 if $rollback_error =~ /$exception_class/;
635 $self->throw_exception(
636 "Transaction aborted: $error. Rollback failed: ${rollback_error}"
639 $self->throw_exception($error); # txn failed but rollback succeeded
643 return $wantarray ? @return_values : $return_value;
650 =item Return Value: $new_schema
654 Clones the schema and its associated result_source objects and returns the
661 my $clone = { (ref $self ? %$self : ()) };
662 bless $clone, (ref $self || $self);
664 foreach my $moniker ($self->sources) {
665 my $source = $self->source($moniker);
666 my $new = $source->new($source);
667 $clone->register_source($moniker => $new);
676 =item Arguments: $source_name, \@data;
680 Pass this method a resultsource name, and an arrayref of
681 arrayrefs. The arrayrefs should contain a list of column names,
682 followed by one or many sets of matching data for the given columns.
684 Each set of data is inserted into the database using
685 L<DBIx::Class::ResultSet/create>, and a arrayref of the resulting row
690 $schema->populate('Artist', [
691 [ qw/artistid name/ ],
692 [ 1, 'Popular Band' ],
700 my ($self, $name, $data) = @_;
701 my $rs = $self->resultset($name);
702 my @names = @{shift(@$data)};
704 foreach my $item (@$data) {
706 @create{@names} = @$item;
707 push(@created, $rs->create(\%create));
712 =head2 throw_exception
716 =item Arguments: $message
720 Throws an exception. Defaults to using L<Carp::Clan> to report errors from
725 sub throw_exception {
730 =head2 deploy (EXPERIMENTAL)
734 =item Arguments: $sqlt_args, $dir
738 Attempts to deploy the schema to the current storage using L<SQL::Translator>.
740 Note that this feature is currently EXPERIMENTAL and may not work correctly
741 across all databases, or fully handle complex relationships.
743 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>. The most
744 common value for this would be C<< { add_drop_table => 1, } >> to have the SQL
745 produced include a DROP TABLE statement for each table created.
750 my ($self, $sqltargs, $dir) = @_;
751 $self->throw_exception("Can't deploy without storage") unless $self->storage;
752 $self->storage->deploy($self, undef, $sqltargs, $dir);
755 =head2 create_ddl_dir (EXPERIMENTAL)
759 =item Arguments: \@databases, $version, $directory, $sqlt_args
763 Creates an SQL file based on the Schema, for each of the specified
764 database types, in the given directory.
766 Note that this feature is currently EXPERIMENTAL and may not work correctly
767 across all databases, or fully handle complex relationships.
774 $self->throw_exception("Can't create_ddl_dir without storage") unless $self->storage;
775 $self->storage->create_ddl_dir($self, @_);
778 =head2 ddl_filename (EXPERIMENTAL)
780 my $filename = $table->ddl_filename($type, $dir, $version)
782 Creates a filename for a SQL file based on the table class name. Not
783 intended for direct end user use.
788 my ($self, $type, $dir, $version) = @_;
790 my $filename = ref($self);
791 $filename =~ s/::/-/;
792 $filename = "$dir$filename-$version-$type.sql";
801 Matt S. Trout <mst@shadowcatsystems.co.uk>
805 You may distribute this code under the same terms as Perl itself.