1 package DBIx::Class::Schema;
6 use DBIx::Class::Exception;
7 use Carp::Clan qw/^DBIx::Class/;
8 use Scalar::Util qw/weaken/;
13 use base qw/DBIx::Class/;
15 __PACKAGE__->mk_classdata('class_mappings' => {});
16 __PACKAGE__->mk_classdata('source_registrations' => {});
17 __PACKAGE__->mk_classdata('storage_type' => '::DBI');
18 __PACKAGE__->mk_classdata('storage');
19 __PACKAGE__->mk_classdata('exception_action');
20 __PACKAGE__->mk_classdata('stacktrace' => $ENV{DBIC_TRACE} || 0);
21 __PACKAGE__->mk_classdata('default_resultset_attributes' => {});
25 DBIx::Class::Schema - composable schemas
29 package Library::Schema;
30 use base qw/DBIx::Class::Schema/;
32 # load Library::Schema::CD, Library::Schema::Book, Library::Schema::DVD
33 __PACKAGE__->load_classes(qw/CD Book DVD/);
35 package Library::Schema::CD;
36 use base qw/DBIx::Class/;
37 __PACKAGE__->load_components(qw/PK::Auto Core/); # for example
38 __PACKAGE__->table('cd');
40 # Elsewhere in your code:
41 my $schema1 = Library::Schema->connect(
48 my $schema2 = Library::Schema->connect($coderef_returning_dbh);
50 # fetch objects using Library::Schema::DVD
51 my $resultset = $schema1->resultset('DVD')->search( ... );
52 my @dvd_objects = $schema2->resultset('DVD')->search( ... );
56 Creates database classes based on a schema. This is the recommended way to
57 use L<DBIx::Class> and allows you to use more than one concurrent connection
60 NB: If you're used to L<Class::DBI> it's worth reading the L</SYNOPSIS>
61 carefully, as DBIx::Class does things a little differently. Note in
62 particular which module inherits off which.
70 =item Arguments: $moniker, $component_class
74 Registers a class which isa DBIx::Class::ResultSourceProxy. Equivalent to
77 $schema->register_source($moniker, $component_class->result_source_instance);
82 my ($self, $moniker, $to_register) = @_;
83 $self->register_source($moniker => $to_register->result_source_instance);
86 =head2 register_source
90 =item Arguments: $moniker, $result_source
94 Registers the L<DBIx::Class::ResultSource> in the schema with the given
102 $self->_register_source(@_);
105 =head2 register_extra_source
109 =item Arguments: $moniker, $result_source
113 As L</register_source> but should be used if the result class already
114 has a source and you want to register an extra one.
118 sub register_extra_source {
121 $self->_register_source(@_, { extra => 1 });
124 sub _register_source {
125 my ($self, $moniker, $source, $params) = @_;
127 %$source = %{ $source->new( { %$source, source_name => $moniker }) };
129 my %reg = %{$self->source_registrations};
130 $reg{$moniker} = $source;
131 $self->source_registrations(\%reg);
133 $source->schema($self);
134 weaken($source->{schema}) if ref($self);
135 return if ($params->{extra});
137 if ($source->result_class) {
138 my %map = %{$self->class_mappings};
139 if (exists $map{$source->result_class}) {
140 warn $source->result_class . ' already has a source, use register_extra_source for additional sources';
142 $map{$source->result_class} = $moniker;
143 $self->class_mappings(\%map);
147 sub _unregister_source {
148 my ($self, $moniker) = @_;
149 my %reg = %{$self->source_registrations};
151 my $source = delete $reg{$moniker};
152 $self->source_registrations(\%reg);
153 if ($source->result_class) {
154 my %map = %{$self->class_mappings};
155 delete $map{$source->result_class};
156 $self->class_mappings(\%map);
164 =item Arguments: $moniker
166 =item Return Value: $classname
170 Retrieves the result class name for the given moniker. For example:
172 my $class = $schema->class('CD');
177 my ($self, $moniker) = @_;
178 return $self->source($moniker)->result_class;
185 =item Arguments: $moniker
187 =item Return Value: $result_source
191 my $source = $schema->source('Book');
193 Returns the L<DBIx::Class::ResultSource> object for the registered moniker.
198 my ($self, $moniker) = @_;
199 my $sreg = $self->source_registrations;
200 return $sreg->{$moniker} if exists $sreg->{$moniker};
202 # if we got here, they probably passed a full class name
203 my $mapped = $self->class_mappings->{$moniker};
204 $self->throw_exception("Can't find source for ${moniker}")
205 unless $mapped && exists $sreg->{$mapped};
206 return $sreg->{$mapped};
213 =item Return Value: @source_monikers
217 Returns the source monikers of all source registrations on this schema.
220 my @source_monikers = $schema->sources;
224 sub sources { return keys %{shift->source_registrations}; }
228 my $storage = $schema->storage;
230 Returns the L<DBIx::Class::Storage> object for this Schema.
236 =item Arguments: $moniker
238 =item Return Value: $result_set
242 my $rs = $schema->resultset('DVD');
244 Returns the L<DBIx::Class::ResultSet> object for the registered moniker.
249 my ($self, $moniker) = @_;
250 return $self->source($moniker)->resultset;
257 =item Arguments: @classes?, { $namespace => [ @classes ] }+
261 With no arguments, this method uses L<Module::Find> to find all classes under
262 the schema's namespace. Otherwise, this method loads the classes you specify
263 (using L<use>), and registers them (using L</"register_class">).
265 It is possible to comment out classes with a leading C<#>, but note that perl
266 will think it's a mistake (trying to use a comment in a qw list), so you'll
267 need to add C<no warnings 'qw';> before your load_classes call.
271 My::Schema->load_classes(); # loads My::Schema::CD, My::Schema::Artist,
272 # etc. (anything under the My::Schema namespace)
274 # loads My::Schema::CD, My::Schema::Artist, Other::Namespace::Producer but
275 # not Other::Namespace::LinerNotes nor My::Schema::Track
276 My::Schema->load_classes(qw/ CD Artist #Track /, {
277 Other::Namespace => [qw/ Producer #LinerNotes /],
283 my ($class, @params) = @_;
288 foreach my $param (@params) {
289 if (ref $param eq 'ARRAY') {
290 # filter out commented entries
291 my @modules = grep { $_ !~ /^#/ } @$param;
293 push (@{$comps_for{$class}}, @modules);
295 elsif (ref $param eq 'HASH') {
296 # more than one namespace possible
297 for my $comp ( keys %$param ) {
298 # filter out commented entries
299 my @modules = grep { $_ !~ /^#/ } @{$param->{$comp}};
301 push (@{$comps_for{$comp}}, @modules);
305 # filter out commented entries
306 push (@{$comps_for{$class}}, $param) if $param !~ /^#/;
310 my @comp = map { substr $_, length "${class}::" }
311 Module::Find::findallmod($class);
312 $comps_for{$class} = \@comp;
317 no warnings qw/redefine/;
318 local *Class::C3::reinitialize = sub { };
319 foreach my $prefix (keys %comps_for) {
320 foreach my $comp (@{$comps_for{$prefix}||[]}) {
321 my $comp_class = "${prefix}::${comp}";
322 { # try to untaint module name. mods where this fails
323 # are left alone so we don't have to change the old behavior
324 no locale; # localized \w doesn't untaint expression
325 if ( $comp_class =~ m/^( (?:\w+::)* \w+ )$/x ) {
329 $class->ensure_class_loaded($comp_class);
331 my $snsub = $comp_class->can('source_name');
333 warn "Failed to load $comp_class. Can't find source_name method. Is $comp_class really a full DBIC result class? Fix it, move it elsewhere, or make your load_classes call more specific.";
336 $comp = $snsub->($comp_class) || $comp;
338 push(@to_register, [ $comp, $comp_class ]);
342 Class::C3->reinitialize;
344 foreach my $to (@to_register) {
345 $class->register_class(@$to);
346 # if $class->can('result_source_instance');
350 =head2 load_namespaces
354 =item Arguments: %options?
358 This is an alternative to L</load_classes> above which assumes an alternative
359 layout for automatic class loading. It assumes that all result
360 classes are underneath a sub-namespace of the schema called C<Result>, any
361 corresponding ResultSet classes are underneath a sub-namespace of the schema
364 Both of the sub-namespaces are configurable if you don't like the defaults,
365 via the options C<result_namespace> and C<resultset_namespace>.
367 If (and only if) you specify the option C<default_resultset_class>, any found
368 Result classes for which we do not find a corresponding
369 ResultSet class will have their C<resultset_class> set to
370 C<default_resultset_class>.
372 C<load_namespaces> takes care of calling C<resultset_class> for you where
373 neccessary if you didn't do it for yourself.
375 All of the namespace and classname options to this method are relative to
376 the schema classname by default. To specify a fully-qualified name, prefix
377 it with a literal C<+>.
381 # load My::Schema::Result::CD, My::Schema::Result::Artist,
382 # My::Schema::ResultSet::CD, etc...
383 My::Schema->load_namespaces;
385 # Override everything to use ugly names.
386 # In this example, if there is a My::Schema::Res::Foo, but no matching
387 # My::Schema::RSets::Foo, then Foo will have its
388 # resultset_class set to My::Schema::RSetBase
389 My::Schema->load_namespaces(
390 result_namespace => 'Res',
391 resultset_namespace => 'RSets',
392 default_resultset_class => 'RSetBase',
395 # Put things in other namespaces
396 My::Schema->load_namespaces(
397 result_namespace => '+Some::Place::Results',
398 resultset_namespace => '+Another::Place::RSets',
401 If you'd like to use multiple namespaces of each type, simply use an arrayref
402 of namespaces for that option. In the case that the same result
403 (or resultset) class exists in multiple namespaces, the latter entries in
404 your list of namespaces will override earlier ones.
406 My::Schema->load_namespaces(
407 # My::Schema::Results_C::Foo takes precedence over My::Schema::Results_B::Foo :
408 result_namespace => [ 'Results_A', 'Results_B', 'Results_C' ],
409 resultset_namespace => [ '+Some::Place::RSets', 'RSets' ],
414 # Pre-pends our classname to the given relative classname or
415 # class namespace, unless there is a '+' prefix, which will
417 sub _expand_relative_name {
418 my ($class, $name) = @_;
420 $name = $class . '::' . $name if ! ($name =~ s/^\+//);
424 # returns a hash of $shortname => $fullname for every package
425 # found in the given namespaces ($shortname is with the $fullname's
426 # namespace stripped off)
427 sub _map_namespaces {
428 my ($class, @namespaces) = @_;
431 foreach my $namespace (@namespaces) {
434 map { (substr($_, length "${namespace}::"), $_) }
435 Module::Find::findallmod($namespace)
442 sub load_namespaces {
443 my ($class, %args) = @_;
445 my $result_namespace = delete $args{result_namespace} || 'Result';
446 my $resultset_namespace = delete $args{resultset_namespace} || 'ResultSet';
447 my $default_resultset_class = delete $args{default_resultset_class};
449 $class->throw_exception('load_namespaces: unknown option(s): '
450 . join(q{,}, map { qq{'$_'} } keys %args))
451 if scalar keys %args;
453 $default_resultset_class
454 = $class->_expand_relative_name($default_resultset_class);
456 for my $arg ($result_namespace, $resultset_namespace) {
457 $arg = [ $arg ] if !ref($arg) && $arg;
459 $class->throw_exception('load_namespaces: namespace arguments must be '
460 . 'a simple string or an arrayref')
461 if ref($arg) ne 'ARRAY';
463 $_ = $class->_expand_relative_name($_) for (@$arg);
466 my %results = $class->_map_namespaces(@$result_namespace);
467 my %resultsets = $class->_map_namespaces(@$resultset_namespace);
471 no warnings 'redefine';
472 local *Class::C3::reinitialize = sub { };
473 use warnings 'redefine';
475 foreach my $result (keys %results) {
476 my $result_class = $results{$result};
477 $class->ensure_class_loaded($result_class);
478 $result_class->source_name($result) unless $result_class->source_name;
480 my $rs_class = delete $resultsets{$result};
481 my $rs_set = $result_class->resultset_class;
482 if($rs_set && $rs_set ne 'DBIx::Class::ResultSet') {
483 if($rs_class && $rs_class ne $rs_set) {
484 warn "We found ResultSet class '$rs_class' for '$result', but it seems "
485 . "that you had already set '$result' to use '$rs_set' instead";
488 elsif($rs_class ||= $default_resultset_class) {
489 $class->ensure_class_loaded($rs_class);
490 $result_class->resultset_class($rs_class);
493 push(@to_register, [ $result_class->source_name, $result_class ]);
497 foreach (sort keys %resultsets) {
498 warn "load_namespaces found ResultSet class $_ with no "
499 . 'corresponding Result class';
502 Class::C3->reinitialize;
503 $class->register_class(@$_) for (@to_register);
508 =head2 compose_connection (DEPRECATED)
512 =item Arguments: $target_namespace, @db_info
514 =item Return Value: $new_schema
518 DEPRECATED. You probably wanted compose_namespace.
520 Actually, you probably just wanted to call connect.
524 (hidden due to deprecation)
526 Calls L<DBIx::Class::Schema/"compose_namespace"> to the target namespace,
527 calls L<DBIx::Class::Schema/connection> with @db_info on the new schema,
528 then injects the L<DBix::Class::ResultSetProxy> component and a
529 resultset_instance classdata entry on all the new classes, in order to support
530 $target_namespaces::$class->search(...) method calls.
532 This is primarily useful when you have a specific need for class method access
533 to a connection. In normal usage it is preferred to call
534 L<DBIx::Class::Schema/connect> and use the resulting schema object to operate
535 on L<DBIx::Class::ResultSet> objects with L<DBIx::Class::Schema/resultset> for
545 sub compose_connection {
546 my ($self, $target, @info) = @_;
548 warn "compose_connection deprecated as of 0.08000"
549 unless ($INC{"DBIx/Class/CDBICompat.pm"} || $warn++);
551 my $base = 'DBIx::Class::ResultSetProxy';
552 eval "require ${base};";
553 $self->throw_exception
554 ("No arguments to load_classes and couldn't load ${base} ($@)")
557 if ($self eq $target) {
558 # Pathological case, largely caused by the docs on early C::M::DBIC::Plain
559 foreach my $moniker ($self->sources) {
560 my $source = $self->source($moniker);
561 my $class = $source->result_class;
562 $self->inject_base($class, $base);
563 $class->mk_classdata(resultset_instance => $source->resultset);
564 $class->mk_classdata(class_resolver => $self);
566 $self->connection(@info);
570 my $schema = $self->compose_namespace($target, $base);
573 my $name = join '::', $target, 'schema';
574 *$name = Sub::Name::subname $name, sub { $schema };
577 $schema->connection(@info);
578 foreach my $moniker ($schema->sources) {
579 my $source = $schema->source($moniker);
580 my $class = $source->result_class;
581 #warn "$moniker $class $source ".$source->storage;
582 $class->mk_classdata(result_source_instance => $source);
583 $class->mk_classdata(resultset_instance => $source->resultset);
584 $class->mk_classdata(class_resolver => $schema);
590 =head2 compose_namespace
594 =item Arguments: $target_namespace, $additional_base_class?
596 =item Return Value: $new_schema
600 For each L<DBIx::Class::ResultSource> in the schema, this method creates a
601 class in the target namespace (e.g. $target_namespace::CD,
602 $target_namespace::Artist) that inherits from the corresponding classes
603 attached to the current schema.
605 It also attaches a corresponding L<DBIx::Class::ResultSource> object to the
606 new $schema object. If C<$additional_base_class> is given, the new composed
607 classes will inherit from first the corresponding classe from the current
608 schema then the base class.
610 For example, for a schema with My::Schema::CD and My::Schema::Artist classes,
612 $schema->compose_namespace('My::DB', 'Base::Class');
613 print join (', ', @My::DB::CD::ISA) . "\n";
614 print join (', ', @My::DB::Artist::ISA) ."\n";
616 will produce the output
618 My::Schema::CD, Base::Class
619 My::Schema::Artist, Base::Class
623 # this might be oversimplified
624 # sub compose_namespace {
625 # my ($self, $target, $base) = @_;
627 # my $schema = $self->clone;
628 # foreach my $moniker ($schema->sources) {
629 # my $source = $schema->source($moniker);
630 # my $target_class = "${target}::${moniker}";
631 # $self->inject_base(
632 # $target_class => $source->result_class, ($base ? $base : ())
634 # $source->result_class($target_class);
635 # $target_class->result_source_instance($source)
636 # if $target_class->can('result_source_instance');
637 # $schema->register_source($moniker, $source);
642 sub compose_namespace {
643 my ($self, $target, $base) = @_;
644 my $schema = $self->clone;
646 no warnings qw/redefine/;
647 # local *Class::C3::reinitialize = sub { };
648 foreach my $moniker ($schema->sources) {
649 my $source = $schema->source($moniker);
650 my $target_class = "${target}::${moniker}";
652 $target_class => $source->result_class, ($base ? $base : ())
654 $source->result_class($target_class);
655 $target_class->result_source_instance($source)
656 if $target_class->can('result_source_instance');
657 $schema->register_source($moniker, $source);
660 # Class::C3->reinitialize();
663 no warnings 'redefine';
664 foreach my $meth (qw/class source resultset/) {
665 *{"${target}::${meth}"} =
666 sub { shift->schema->$meth(@_) };
672 sub setup_connection_class {
673 my ($class, $target, @info) = @_;
674 $class->inject_base($target => 'DBIx::Class::DB');
675 #$target->load_components('DB');
676 $target->connection(@info);
683 =item Arguments: $storage_type|{$storage_type, \%args}
685 =item Return Value: $storage_type|{$storage_type, \%args}
689 Set the storage class that will be instantiated when L</connect> is called.
690 If the classname starts with C<::>, the prefix C<DBIx::Class::Storage> is
691 assumed by L</connect>. Defaults to C<::DBI>,
692 which is L<DBIx::Class::Storage::DBI>.
694 You want to use this to hardcoded subclasses of L<DBIx::Class::Storage::DBI>
695 in cases where the appropriate subclass is not autodetected, such as when
696 dealing with MSSQL via L<DBD::Sybase>, in which case you'd set it to
697 C<::DBI::Sybase::MSSQL>.
699 If your storage type requires instantiation arguments, those are defined as a
700 second argument in the form of a hashref and the entire value needs to be
701 wrapped into an arrayref or a hashref. We support both types of refs here in
702 order to play nice with your Config::[class] or your choice.
704 See L<DBIx::Class::Storage::DBI::Replicated> for an example of this.
710 =item Arguments: @args
712 =item Return Value: $new_schema
716 Instantiates a new Storage object of type
717 L<DBIx::Class::Schema/"storage_type"> and passes the arguments to
718 $storage->connect_info. Sets the connection in-place on the schema.
720 See L<DBIx::Class::Storage::DBI/"connect_info"> for DBI-specific syntax,
721 or L<DBIx::Class::Storage> in general.
726 my ($self, @info) = @_;
727 return $self if !@info && $self->storage;
729 my ($storage_class, $args) = ref $self->storage_type ?
730 ($self->_normalize_storage_type($self->storage_type),{}) : ($self->storage_type, {});
732 $storage_class = 'DBIx::Class::Storage'.$storage_class
733 if $storage_class =~ m/^::/;
734 eval "require ${storage_class};";
735 $self->throw_exception(
736 "No arguments to load_classes and couldn't load ${storage_class} ($@)"
738 my $storage = $storage_class->new($self=>$args);
739 $storage->connect_info(\@info);
740 $self->storage($storage);
744 sub _normalize_storage_type {
745 my ($self, $storage_type) = @_;
746 if(ref $storage_type eq 'ARRAY') {
747 return @$storage_type;
748 } elsif(ref $storage_type eq 'HASH') {
749 return %$storage_type;
751 $self->throw_exception('Unsupported REFTYPE given: '. ref $storage_type);
759 =item Arguments: @info
761 =item Return Value: $new_schema
765 This is a convenience method. It is equivalent to calling
766 $schema->clone->connection(@info). See L</connection> and L</clone> for more
771 sub connect { shift->clone->connection(@_) }
777 =item Arguments: C<$coderef>, @coderef_args?
779 =item Return Value: The return value of $coderef
783 Executes C<$coderef> with (optional) arguments C<@coderef_args> atomically,
784 returning its result (if any). Equivalent to calling $schema->storage->txn_do.
785 See L<DBIx::Class::Storage/"txn_do"> for more information.
787 This interface is preferred over using the individual methods L</txn_begin>,
788 L</txn_commit>, and L</txn_rollback> below.
795 $self->storage or $self->throw_exception
796 ('txn_do called on $schema without storage');
798 $self->storage->txn_do(@_);
801 =head2 txn_scope_guard (EXPERIMENTAL)
803 Runs C<txn_scope_guard> on the schema's storage. See
804 L<DBIx::Class::Storage/txn_scope_guard>.
808 sub txn_scope_guard {
811 $self->storage or $self->throw_exception
812 ('txn_scope_guard called on $schema without storage');
814 $self->storage->txn_scope_guard(@_);
819 Begins a transaction (does nothing if AutoCommit is off). Equivalent to
820 calling $schema->storage->txn_begin. See
821 L<DBIx::Class::Storage::DBI/"txn_begin"> for more information.
828 $self->storage or $self->throw_exception
829 ('txn_begin called on $schema without storage');
831 $self->storage->txn_begin;
836 Commits the current transaction. Equivalent to calling
837 $schema->storage->txn_commit. See L<DBIx::Class::Storage::DBI/"txn_commit">
838 for more information.
845 $self->storage or $self->throw_exception
846 ('txn_commit called on $schema without storage');
848 $self->storage->txn_commit;
853 Rolls back the current transaction. Equivalent to calling
854 $schema->storage->txn_rollback. See
855 L<DBIx::Class::Storage::DBI/"txn_rollback"> for more information.
862 $self->storage or $self->throw_exception
863 ('txn_rollback called on $schema without storage');
865 $self->storage->txn_rollback;
870 Creates a new savepoint (does nothing outside a transaction).
871 Equivalent to calling $schema->storage->svp_begin. See
872 L<DBIx::Class::Storage::DBI/"svp_begin"> for more information.
877 my ($self, $name) = @_;
879 $self->storage or $self->throw_exception
880 ('svp_begin called on $schema without storage');
882 $self->storage->svp_begin($name);
887 Releases a savepoint (does nothing outside a transaction).
888 Equivalent to calling $schema->storage->svp_release. See
889 L<DBIx::Class::Storage::DBI/"svp_release"> for more information.
894 my ($self, $name) = @_;
896 $self->storage or $self->throw_exception
897 ('svp_release called on $schema without storage');
899 $self->storage->svp_release($name);
904 Rollback to a savepoint (does nothing outside a transaction).
905 Equivalent to calling $schema->storage->svp_rollback. See
906 L<DBIx::Class::Storage::DBI/"svp_rollback"> for more information.
911 my ($self, $name) = @_;
913 $self->storage or $self->throw_exception
914 ('svp_rollback called on $schema without storage');
916 $self->storage->svp_rollback($name);
923 =item Return Value: $new_schema
927 Clones the schema and its associated result_source objects and returns the
934 my $clone = { (ref $self ? %$self : ()) };
935 bless $clone, (ref $self || $self);
937 $clone->class_mappings({ %{$clone->class_mappings} });
938 $clone->source_registrations({ %{$clone->source_registrations} });
939 foreach my $moniker ($self->sources) {
940 my $source = $self->source($moniker);
941 my $new = $source->new($source);
942 # we use extra here as we want to leave the class_mappings as they are
943 # but overwrite the source_registrations entry with the new source
944 $clone->register_extra_source($moniker => $new);
946 $clone->storage->set_schema($clone) if $clone->storage;
954 =item Arguments: $source_name, \@data;
958 Pass this method a resultsource name, and an arrayref of
959 arrayrefs. The arrayrefs should contain a list of column names,
960 followed by one or many sets of matching data for the given columns.
962 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
963 to insert the data, as this is a fast method. However, insert_bulk currently
964 assumes that your datasets all contain the same type of values, using scalar
965 references in a column in one row, and not in another will probably not work.
967 Otherwise, each set of data is inserted into the database using
968 L<DBIx::Class::ResultSet/create>, and a arrayref of the resulting row
973 $schema->populate('Artist', [
974 [ qw/artistid name/ ],
975 [ 1, 'Popular Band' ],
980 Since wantarray context is basically the same as looping over $rs->create(...)
981 you won't see any performance benefits and in this case the method is more for
982 convenience. Void context sends the column information directly to storage
983 using <DBI>s bulk insert method. So the performance will be much better for
984 storages that support this method.
986 Because of this difference in the way void context inserts rows into your
987 database you need to note how this will effect any loaded components that
988 override or augment insert. For example if you are using a component such
989 as L<DBIx::Class::UUIDColumns> to populate your primary keys you MUST use
990 wantarray context if you want the PKs automatically created.
995 my ($self, $name, $data) = @_;
996 my $rs = $self->resultset($name);
997 my @names = @{shift(@$data)};
998 if(defined wantarray) {
1000 foreach my $item (@$data) {
1002 @create{@names} = @$item;
1003 push(@created, $rs->create(\%create));
1007 my @results_to_create;
1008 foreach my $datum (@$data) {
1009 my %result_to_create;
1010 foreach my $index (0..$#names) {
1011 $result_to_create{$names[$index]} = $$datum[$index];
1013 push @results_to_create, \%result_to_create;
1015 $rs->populate(\@results_to_create);
1018 =head2 exception_action
1022 =item Arguments: $code_reference
1026 If C<exception_action> is set for this class/object, L</throw_exception>
1027 will prefer to call this code reference with the exception as an argument,
1028 rather than its normal C<croak> or C<confess> action.
1030 Your subroutine should probably just wrap the error in the exception
1031 object/class of your choosing and rethrow. If, against all sage advice,
1032 you'd like your C<exception_action> to suppress a particular exception
1033 completely, simply have it return true.
1038 use base qw/DBIx::Class::Schema/;
1039 use My::ExceptionClass;
1040 __PACKAGE__->exception_action(sub { My::ExceptionClass->throw(@_) });
1041 __PACKAGE__->load_classes;
1044 my $schema_obj = My::Schema->connect( .... );
1045 $schema_obj->exception_action(sub { My::ExceptionClass->throw(@_) });
1047 # suppress all exceptions, like a moron:
1048 $schema_obj->exception_action(sub { 1 });
1054 =item Arguments: boolean
1058 Whether L</throw_exception> should include stack trace information.
1059 Defaults to false normally, but defaults to true if C<$ENV{DBIC_TRACE}>
1062 =head2 throw_exception
1066 =item Arguments: $message
1070 Throws an exception. Defaults to using L<Carp::Clan> to report errors from
1071 user's perspective. See L</exception_action> for details on overriding
1072 this method's behavior. If L</stacktrace> is turned on, C<throw_exception>'s
1073 default behavior will provide a detailed stack trace.
1077 sub throw_exception {
1080 DBIx::Class::Exception->throw($_[0], $self->stacktrace)
1081 if !$self->exception_action || !$self->exception_action->(@_);
1088 =item Arguments: $sqlt_args, $dir
1092 Attempts to deploy the schema to the current storage using L<SQL::Translator>.
1094 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>. The most
1095 common value for this would be C<< { add_drop_table => 1, } >> to have the SQL
1096 produced include a DROP TABLE statement for each table created.
1098 Additionally, the DBIx::Class parser accepts a C<sources> parameter as a hash
1099 ref or an array ref, containing a list of source to deploy. If present, then
1100 only the sources listed will get deployed. Furthermore, you can use the
1101 C<add_fk_index> parser parameter to prevent the parser from creating an index for each
1107 my ($self, $sqltargs, $dir) = @_;
1108 $self->throw_exception("Can't deploy without storage") unless $self->storage;
1109 $self->storage->deploy($self, undef, $sqltargs, $dir);
1112 =head2 deployment_statements
1116 =item Arguments: $rdbms_type, $sqlt_args, $dir
1120 A convenient shortcut to storage->deployment_statements(). Returns the SQL statements
1121 used by L</deploy> and L<DBIx::Class::Schema::Storage/deploy>. C<$rdbms_type> provides
1122 the (optional) SQLT (not DBI) database driver name for which the SQL statements are produced.
1123 If not supplied, the type is determined by interrogating the current connection.
1124 The other two arguments are identical to those of L</deploy>.
1128 sub deployment_statements {
1131 $self->throw_exception("Can't generate deployment statements without a storage")
1132 if not $self->storage;
1134 $self->storage->deployment_statements($self, @_);
1137 =head2 create_ddl_dir (EXPERIMENTAL)
1141 =item Arguments: \@databases, $version, $directory, $preversion, $sqlt_args
1145 Creates an SQL file based on the Schema, for each of the specified
1146 database types, in the given directory. Given a previous version number,
1147 this will also create a file containing the ALTER TABLE statements to
1148 transform the previous schema into the current one. Note that these
1149 statements may contain DROP TABLE or DROP COLUMN statements that can
1150 potentially destroy data.
1152 The file names are created using the C<ddl_filename> method below, please
1153 override this method in your schema if you would like a different file
1154 name format. For the ALTER file, the same format is used, replacing
1155 $version in the name with "$preversion-$version".
1157 See L<DBIx::Class::Schema/deploy> for details of $sqlt_args.
1159 If no arguments are passed, then the following default values are used:
1163 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
1165 =item version - $schema->VERSION
1167 =item directory - './'
1169 =item preversion - <none>
1173 Note that this feature is currently EXPERIMENTAL and may not work correctly
1174 across all databases, or fully handle complex relationships.
1176 WARNING: Please check all SQL files created, before applying them.
1180 sub create_ddl_dir {
1183 $self->throw_exception("Can't create_ddl_dir without storage") unless $self->storage;
1184 $self->storage->create_ddl_dir($self, @_);
1191 =item Arguments: $database-type, $version, $directory, $preversion
1195 my $filename = $table->ddl_filename($type, $version, $dir, $preversion)
1197 This method is called by C<create_ddl_dir> to compose a file name out of
1198 the supplied directory, database type and version number. The default file
1199 name format is: C<$dir$schema-$version-$type.sql>.
1201 You may override this method in your schema if you wish to use a different
1207 my ($self, $type, $version, $dir, $preversion) = @_;
1209 my $filename = ref($self);
1210 $filename =~ s/::/-/g;
1211 $filename = File::Spec->catfile($dir, "$filename-$version-$type.sql");
1212 $filename =~ s/$version/$preversion-$version/ if($preversion);
1217 =head2 sqlt_deploy_hook($sqlt_schema)
1219 An optional sub which you can declare in your own Schema class that will get
1220 passed the L<SQL::Translator::Schema> object when you deploy the schema via
1221 L</create_ddl_dir> or L</deploy>.
1223 For an example of what you can do with this, see
1224 L<DBIx::Class::Manual::Cookbook/Adding Indexes And Functions To Your SQL>.
1228 Provided as the recommened way of thawing schema objects. You can call
1229 C<Storable::thaw> directly if you wish, but the thawed objects will not have a
1230 reference to any schema, so are rather useless
1235 my ($self, $obj) = @_;
1236 local $DBIx::Class::ResultSourceHandle::thaw_schema = $self;
1237 return Storable::thaw($obj);
1242 This doesn't actualy do anything more than call L<Storable/freeze>, it is just
1243 provided here for symetry.
1248 return Storable::freeze($_[1]);
1253 Recommeneded way of dcloning objects. This is needed to properly maintain
1254 references to the schema object (which itself is B<not> cloned.)
1259 my ($self, $obj) = @_;
1260 local $DBIx::Class::ResultSourceHandle::thaw_schema = $self;
1261 return Storable::dclone($obj);
1264 =head2 schema_version
1266 Returns the current schema class' $VERSION
1270 sub schema_version {
1272 my $class = ref($self)||$self;
1274 # does -not- use $schema->VERSION
1275 # since that varies in results depending on if version.pm is installed, and if
1276 # so the perl or XS versions. If you want this to change, bug the version.pm
1277 # author to make vpp and vxs behave the same.
1282 $version = ${"${class}::VERSION"};
1291 Matt S. Trout <mst@shadowcatsystems.co.uk>
1295 You may distribute this code under the same terms as Perl itself.