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);
135 return if ($params->{extra});
137 weaken($source->{schema}) if ref($self);
138 if ($source->result_class) {
139 my %map = %{$self->class_mappings};
140 if (exists $map{$source->result_class}) {
141 warn $source->result_class . ' already has a source, use register_extra_source for additional sources';
143 $map{$source->result_class} = $moniker;
144 $self->class_mappings(\%map);
148 sub _unregister_source {
149 my ($self, $moniker) = @_;
150 my %reg = %{$self->source_registrations};
152 my $source = delete $reg{$moniker};
153 $self->source_registrations(\%reg);
154 if ($source->result_class) {
155 my %map = %{$self->class_mappings};
156 delete $map{$source->result_class};
157 $self->class_mappings(\%map);
165 =item Arguments: $moniker
167 =item Return Value: $classname
171 Retrieves the result class name for the given moniker. For example:
173 my $class = $schema->class('CD');
178 my ($self, $moniker) = @_;
179 return $self->source($moniker)->result_class;
186 =item Arguments: $moniker
188 =item Return Value: $result_source
192 my $source = $schema->source('Book');
194 Returns the L<DBIx::Class::ResultSource> object for the registered moniker.
199 my ($self, $moniker) = @_;
200 my $sreg = $self->source_registrations;
201 return $sreg->{$moniker} if exists $sreg->{$moniker};
203 # if we got here, they probably passed a full class name
204 my $mapped = $self->class_mappings->{$moniker};
205 $self->throw_exception("Can't find source for ${moniker}")
206 unless $mapped && exists $sreg->{$mapped};
207 return $sreg->{$mapped};
214 =item Return Value: @source_monikers
218 Returns the source monikers of all source registrations on this schema.
221 my @source_monikers = $schema->sources;
225 sub sources { return keys %{shift->source_registrations}; }
229 my $storage = $schema->storage;
231 Returns the L<DBIx::Class::Storage> object for this Schema.
237 =item Arguments: $moniker
239 =item Return Value: $result_set
243 my $rs = $schema->resultset('DVD');
245 Returns the L<DBIx::Class::ResultSet> object for the registered moniker.
250 my ($self, $moniker) = @_;
251 return $self->source($moniker)->resultset;
258 =item Arguments: @classes?, { $namespace => [ @classes ] }+
262 With no arguments, this method uses L<Module::Find> to find all classes under
263 the schema's namespace. Otherwise, this method loads the classes you specify
264 (using L<use>), and registers them (using L</"register_class">).
266 It is possible to comment out classes with a leading C<#>, but note that perl
267 will think it's a mistake (trying to use a comment in a qw list), so you'll
268 need to add C<no warnings 'qw';> before your load_classes call.
272 My::Schema->load_classes(); # loads My::Schema::CD, My::Schema::Artist,
273 # etc. (anything under the My::Schema namespace)
275 # loads My::Schema::CD, My::Schema::Artist, Other::Namespace::Producer but
276 # not Other::Namespace::LinerNotes nor My::Schema::Track
277 My::Schema->load_classes(qw/ CD Artist #Track /, {
278 Other::Namespace => [qw/ Producer #LinerNotes /],
284 my ($class, @params) = @_;
289 foreach my $param (@params) {
290 if (ref $param eq 'ARRAY') {
291 # filter out commented entries
292 my @modules = grep { $_ !~ /^#/ } @$param;
294 push (@{$comps_for{$class}}, @modules);
296 elsif (ref $param eq 'HASH') {
297 # more than one namespace possible
298 for my $comp ( keys %$param ) {
299 # filter out commented entries
300 my @modules = grep { $_ !~ /^#/ } @{$param->{$comp}};
302 push (@{$comps_for{$comp}}, @modules);
306 # filter out commented entries
307 push (@{$comps_for{$class}}, $param) if $param !~ /^#/;
311 my @comp = map { substr $_, length "${class}::" }
312 Module::Find::findallmod($class);
313 $comps_for{$class} = \@comp;
318 no warnings qw/redefine/;
319 local *Class::C3::reinitialize = sub { };
320 foreach my $prefix (keys %comps_for) {
321 foreach my $comp (@{$comps_for{$prefix}||[]}) {
322 my $comp_class = "${prefix}::${comp}";
323 { # try to untaint module name. mods where this fails
324 # are left alone so we don't have to change the old behavior
325 no locale; # localized \w doesn't untaint expression
326 if ( $comp_class =~ m/^( (?:\w+::)* \w+ )$/x ) {
330 $class->ensure_class_loaded($comp_class);
332 $comp = $comp_class->source_name || $comp;
334 push(@to_register, [ $comp, $comp_class ]);
338 Class::C3->reinitialize;
340 foreach my $to (@to_register) {
341 $class->register_class(@$to);
342 # if $class->can('result_source_instance');
346 =head2 load_namespaces
350 =item Arguments: %options?
354 This is an alternative to L</load_classes> above which assumes an alternative
355 layout for automatic class loading. It assumes that all result
356 classes are underneath a sub-namespace of the schema called C<Result>, any
357 corresponding ResultSet classes are underneath a sub-namespace of the schema
360 Both of the sub-namespaces are configurable if you don't like the defaults,
361 via the options C<result_namespace> and C<resultset_namespace>.
363 If (and only if) you specify the option C<default_resultset_class>, any found
364 Result classes for which we do not find a corresponding
365 ResultSet class will have their C<resultset_class> set to
366 C<default_resultset_class>.
368 C<load_namespaces> takes care of calling C<resultset_class> for you where
369 neccessary if you didn't do it for yourself.
371 All of the namespace and classname options to this method are relative to
372 the schema classname by default. To specify a fully-qualified name, prefix
373 it with a literal C<+>.
377 # load My::Schema::Result::CD, My::Schema::Result::Artist,
378 # My::Schema::ResultSet::CD, etc...
379 My::Schema->load_namespaces;
381 # Override everything to use ugly names.
382 # In this example, if there is a My::Schema::Res::Foo, but no matching
383 # My::Schema::RSets::Foo, then Foo will have its
384 # resultset_class set to My::Schema::RSetBase
385 My::Schema->load_namespaces(
386 result_namespace => 'Res',
387 resultset_namespace => 'RSets',
388 default_resultset_class => 'RSetBase',
391 # Put things in other namespaces
392 My::Schema->load_namespaces(
393 result_namespace => '+Some::Place::Results',
394 resultset_namespace => '+Another::Place::RSets',
397 If you'd like to use multiple namespaces of each type, simply use an arrayref
398 of namespaces for that option. In the case that the same result
399 (or resultset) class exists in multiple namespaces, the latter entries in
400 your list of namespaces will override earlier ones.
402 My::Schema->load_namespaces(
403 # My::Schema::Results_C::Foo takes precedence over My::Schema::Results_B::Foo :
404 result_namespace => [ 'Results_A', 'Results_B', 'Results_C' ],
405 resultset_namespace => [ '+Some::Place::RSets', 'RSets' ],
410 # Pre-pends our classname to the given relative classname or
411 # class namespace, unless there is a '+' prefix, which will
413 sub _expand_relative_name {
414 my ($class, $name) = @_;
416 $name = $class . '::' . $name if ! ($name =~ s/^\+//);
420 # returns a hash of $shortname => $fullname for every package
421 # found in the given namespaces ($shortname is with the $fullname's
422 # namespace stripped off)
423 sub _map_namespaces {
424 my ($class, @namespaces) = @_;
427 foreach my $namespace (@namespaces) {
430 map { (substr($_, length "${namespace}::"), $_) }
431 Module::Find::findallmod($namespace)
438 sub load_namespaces {
439 my ($class, %args) = @_;
441 my $result_namespace = delete $args{result_namespace} || 'Result';
442 my $resultset_namespace = delete $args{resultset_namespace} || 'ResultSet';
443 my $default_resultset_class = delete $args{default_resultset_class};
445 $class->throw_exception('load_namespaces: unknown option(s): '
446 . join(q{,}, map { qq{'$_'} } keys %args))
447 if scalar keys %args;
449 $default_resultset_class
450 = $class->_expand_relative_name($default_resultset_class);
452 for my $arg ($result_namespace, $resultset_namespace) {
453 $arg = [ $arg ] if !ref($arg) && $arg;
455 $class->throw_exception('load_namespaces: namespace arguments must be '
456 . 'a simple string or an arrayref')
457 if ref($arg) ne 'ARRAY';
459 $_ = $class->_expand_relative_name($_) for (@$arg);
462 my %results = $class->_map_namespaces(@$result_namespace);
463 my %resultsets = $class->_map_namespaces(@$resultset_namespace);
467 no warnings 'redefine';
468 local *Class::C3::reinitialize = sub { };
469 use warnings 'redefine';
471 foreach my $result (keys %results) {
472 my $result_class = $results{$result};
473 $class->ensure_class_loaded($result_class);
474 $result_class->source_name($result) unless $result_class->source_name;
476 my $rs_class = delete $resultsets{$result};
477 my $rs_set = $result_class->resultset_class;
478 if($rs_set && $rs_set ne 'DBIx::Class::ResultSet') {
479 if($rs_class && $rs_class ne $rs_set) {
480 warn "We found ResultSet class '$rs_class' for '$result', but it seems "
481 . "that you had already set '$result' to use '$rs_set' instead";
484 elsif($rs_class ||= $default_resultset_class) {
485 $class->ensure_class_loaded($rs_class);
486 $result_class->resultset_class($rs_class);
489 push(@to_register, [ $result_class->source_name, $result_class ]);
493 foreach (sort keys %resultsets) {
494 warn "load_namespaces found ResultSet class $_ with no "
495 . 'corresponding Result class';
498 Class::C3->reinitialize;
499 $class->register_class(@$_) for (@to_register);
504 =head2 compose_connection (DEPRECATED)
508 =item Arguments: $target_namespace, @db_info
510 =item Return Value: $new_schema
514 DEPRECATED. You probably wanted compose_namespace.
516 Actually, you probably just wanted to call connect.
520 (hidden due to deprecation)
522 Calls L<DBIx::Class::Schema/"compose_namespace"> to the target namespace,
523 calls L<DBIx::Class::Schema/connection> with @db_info on the new schema,
524 then injects the L<DBix::Class::ResultSetProxy> component and a
525 resultset_instance classdata entry on all the new classes, in order to support
526 $target_namespaces::$class->search(...) method calls.
528 This is primarily useful when you have a specific need for class method access
529 to a connection. In normal usage it is preferred to call
530 L<DBIx::Class::Schema/connect> and use the resulting schema object to operate
531 on L<DBIx::Class::ResultSet> objects with L<DBIx::Class::Schema/resultset> for
541 sub compose_connection {
542 my ($self, $target, @info) = @_;
544 warn "compose_connection deprecated as of 0.08000"
545 unless ($INC{"DBIx/Class/CDBICompat.pm"} || $warn++);
547 my $base = 'DBIx::Class::ResultSetProxy';
548 eval "require ${base};";
549 $self->throw_exception
550 ("No arguments to load_classes and couldn't load ${base} ($@)")
553 if ($self eq $target) {
554 # Pathological case, largely caused by the docs on early C::M::DBIC::Plain
555 foreach my $moniker ($self->sources) {
556 my $source = $self->source($moniker);
557 my $class = $source->result_class;
558 $self->inject_base($class, $base);
559 $class->mk_classdata(resultset_instance => $source->resultset);
560 $class->mk_classdata(class_resolver => $self);
562 $self->connection(@info);
566 my $schema = $self->compose_namespace($target, $base);
569 my $name = join '::', $target, 'schema';
570 *$name = Sub::Name::subname $name, sub { $schema };
573 $schema->connection(@info);
574 foreach my $moniker ($schema->sources) {
575 my $source = $schema->source($moniker);
576 my $class = $source->result_class;
577 #warn "$moniker $class $source ".$source->storage;
578 $class->mk_classdata(result_source_instance => $source);
579 $class->mk_classdata(resultset_instance => $source->resultset);
580 $class->mk_classdata(class_resolver => $schema);
586 =head2 compose_namespace
590 =item Arguments: $target_namespace, $additional_base_class?
592 =item Return Value: $new_schema
596 For each L<DBIx::Class::ResultSource> in the schema, this method creates a
597 class in the target namespace (e.g. $target_namespace::CD,
598 $target_namespace::Artist) that inherits from the corresponding classes
599 attached to the current schema.
601 It also attaches a corresponding L<DBIx::Class::ResultSource> object to the
602 new $schema object. If C<$additional_base_class> is given, the new composed
603 classes will inherit from first the corresponding classe from the current
604 schema then the base class.
606 For example, for a schema with My::Schema::CD and My::Schema::Artist classes,
608 $schema->compose_namespace('My::DB', 'Base::Class');
609 print join (', ', @My::DB::CD::ISA) . "\n";
610 print join (', ', @My::DB::Artist::ISA) ."\n";
612 will produce the output
614 My::Schema::CD, Base::Class
615 My::Schema::Artist, Base::Class
619 sub compose_namespace {
620 my ($self, $target, $base) = @_;
621 my $schema = $self->clone;
623 no warnings qw/redefine/;
624 local *Class::C3::reinitialize = sub { };
625 foreach my $moniker ($schema->sources) {
626 my $source = $schema->source($moniker);
627 my $target_class = "${target}::${moniker}";
629 $target_class => $source->result_class, ($base ? $base : ())
631 $source->result_class($target_class);
632 $target_class->result_source_instance($source)
633 if $target_class->can('result_source_instance');
636 Class::C3->reinitialize();
639 no warnings 'redefine';
640 foreach my $meth (qw/class source resultset/) {
641 my $name = join '::', $target, $meth;
642 *$name = Sub::Name::subname $name, sub { shift->schema->$meth(@_) };
648 sub setup_connection_class {
649 my ($class, $target, @info) = @_;
650 $class->inject_base($target => 'DBIx::Class::DB');
651 #$target->load_components('DB');
652 $target->connection(@info);
659 =item Arguments: $storage_type|{$storage_type, \%args}
661 =item Return Value: $storage_type|{$storage_type, \%args}
665 Set the storage class that will be instantiated when L</connect> is called.
666 If the classname starts with C<::>, the prefix C<DBIx::Class::Storage> is
667 assumed by L</connect>. Defaults to C<::DBI>,
668 which is L<DBIx::Class::Storage::DBI>.
670 You want to use this to hardcoded subclasses of L<DBIx::Class::Storage::DBI>
671 in cases where the appropriate subclass is not autodetected, such as when
672 dealing with MSSQL via L<DBD::Sybase>, in which case you'd set it to
673 C<::DBI::Sybase::MSSQL>.
675 If your storage type requires instantiation arguments, those are defined as a
676 second argument in the form of a hashref and the entire value needs to be
677 wrapped into an arrayref or a hashref. We support both types of refs here in
678 order to play nice with your Config::[class] or your choice.
680 See L<DBIx::Class::Storage::DBI::Replicated> for an example of this.
686 =item Arguments: @args
688 =item Return Value: $new_schema
692 Instantiates a new Storage object of type
693 L<DBIx::Class::Schema/"storage_type"> and passes the arguments to
694 $storage->connect_info. Sets the connection in-place on the schema.
696 See L<DBIx::Class::Storage::DBI/"connect_info"> for DBI-specific syntax,
697 or L<DBIx::Class::Storage> in general.
702 my ($self, @info) = @_;
703 return $self if !@info && $self->storage;
705 my ($storage_class, $args) = ref $self->storage_type ?
706 ($self->_normalize_storage_type($self->storage_type),{}) : ($self->storage_type, {});
708 $storage_class = 'DBIx::Class::Storage'.$storage_class
709 if $storage_class =~ m/^::/;
710 eval "require ${storage_class};";
711 $self->throw_exception(
712 "No arguments to load_classes and couldn't load ${storage_class} ($@)"
714 my $storage = $storage_class->new($self=>$args);
715 $storage->connect_info(\@info);
716 $self->storage($storage);
720 sub _normalize_storage_type {
721 my ($self, $storage_type) = @_;
722 if(ref $storage_type eq 'ARRAY') {
723 return @$storage_type;
724 } elsif(ref $storage_type eq 'HASH') {
725 return %$storage_type;
727 $self->throw_exception('Unsupported REFTYPE given: '. ref $storage_type);
735 =item Arguments: @info
737 =item Return Value: $new_schema
741 This is a convenience method. It is equivalent to calling
742 $schema->clone->connection(@info). See L</connection> and L</clone> for more
747 sub connect { shift->clone->connection(@_) }
753 =item Arguments: C<$coderef>, @coderef_args?
755 =item Return Value: The return value of $coderef
759 Executes C<$coderef> with (optional) arguments C<@coderef_args> atomically,
760 returning its result (if any). Equivalent to calling $schema->storage->txn_do.
761 See L<DBIx::Class::Storage/"txn_do"> for more information.
763 This interface is preferred over using the individual methods L</txn_begin>,
764 L</txn_commit>, and L</txn_rollback> below.
771 $self->storage or $self->throw_exception
772 ('txn_do called on $schema without storage');
774 $self->storage->txn_do(@_);
777 =head2 txn_scope_guard (EXPERIMENTAL)
779 Runs C<txn_scope_guard> on the schema's storage. See
780 L<DBIx::Class::Storage/txn_scope_guard>.
784 sub txn_scope_guard {
787 $self->storage or $self->throw_exception
788 ('txn_scope_guard called on $schema without storage');
790 $self->storage->txn_scope_guard(@_);
795 Begins a transaction (does nothing if AutoCommit is off). Equivalent to
796 calling $schema->storage->txn_begin. See
797 L<DBIx::Class::Storage::DBI/"txn_begin"> for more information.
804 $self->storage or $self->throw_exception
805 ('txn_begin called on $schema without storage');
807 $self->storage->txn_begin;
812 Commits the current transaction. Equivalent to calling
813 $schema->storage->txn_commit. See L<DBIx::Class::Storage::DBI/"txn_commit">
814 for more information.
821 $self->storage or $self->throw_exception
822 ('txn_commit called on $schema without storage');
824 $self->storage->txn_commit;
829 Rolls back the current transaction. Equivalent to calling
830 $schema->storage->txn_rollback. See
831 L<DBIx::Class::Storage::DBI/"txn_rollback"> for more information.
838 $self->storage or $self->throw_exception
839 ('txn_rollback called on $schema without storage');
841 $self->storage->txn_rollback;
846 Creates a new savepoint (does nothing outside a transaction).
847 Equivalent to calling $schema->storage->svp_begin. See
848 L<DBIx::Class::Storage::DBI/"svp_begin"> for more information.
853 my ($self, $name) = @_;
855 $self->storage or $self->throw_exception
856 ('svp_begin called on $schema without storage');
858 $self->storage->svp_begin($name);
863 Releases a savepoint (does nothing outside a transaction).
864 Equivalent to calling $schema->storage->svp_release. See
865 L<DBIx::Class::Storage::DBI/"svp_release"> for more information.
870 my ($self, $name) = @_;
872 $self->storage or $self->throw_exception
873 ('svp_release called on $schema without storage');
875 $self->storage->svp_release($name);
880 Rollback to a savepoint (does nothing outside a transaction).
881 Equivalent to calling $schema->storage->svp_rollback. See
882 L<DBIx::Class::Storage::DBI/"svp_rollback"> for more information.
887 my ($self, $name) = @_;
889 $self->storage or $self->throw_exception
890 ('svp_rollback called on $schema without storage');
892 $self->storage->svp_rollback($name);
899 =item Return Value: $new_schema
903 Clones the schema and its associated result_source objects and returns the
910 my $clone = { (ref $self ? %$self : ()) };
911 bless $clone, (ref $self || $self);
913 foreach my $moniker ($self->sources) {
914 my $source = $self->source($moniker);
915 my $new = $source->new($source);
916 # we use extra here as we want to leave the class_mappings as they are
917 # but overwrite the source_registrations entry with the new source
918 $clone->register_extra_source($moniker => $new);
920 $clone->storage->set_schema($clone) if $clone->storage;
928 =item Arguments: $source_name, \@data;
932 Pass this method a resultsource name, and an arrayref of
933 arrayrefs. The arrayrefs should contain a list of column names,
934 followed by one or many sets of matching data for the given columns.
936 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
937 to insert the data, as this is a fast method. However, insert_bulk currently
938 assumes that your datasets all contain the same type of values, using scalar
939 references in a column in one row, and not in another will probably not work.
941 Otherwise, each set of data is inserted into the database using
942 L<DBIx::Class::ResultSet/create>, and a arrayref of the resulting row
947 $schema->populate('Artist', [
948 [ qw/artistid name/ ],
949 [ 1, 'Popular Band' ],
954 Since wantarray context is basically the same as looping over $rs->create(...)
955 you won't see any performance benefits and in this case the method is more for
956 convenience. Void context sends the column information directly to storage
957 using <DBI>s bulk insert method. So the performance will be much better for
958 storages that support this method.
960 Because of this difference in the way void context inserts rows into your
961 database you need to note how this will effect any loaded components that
962 override or augment insert. For example if you are using a component such
963 as L<DBIx::Class::UUIDColumns> to populate your primary keys you MUST use
964 wantarray context if you want the PKs automatically created.
969 my ($self, $name, $data) = @_;
970 my $rs = $self->resultset($name);
971 my @names = @{shift(@$data)};
972 if(defined wantarray) {
974 foreach my $item (@$data) {
976 @create{@names} = @$item;
977 push(@created, $rs->create(\%create));
981 my @results_to_create;
982 foreach my $datum (@$data) {
983 my %result_to_create;
984 foreach my $index (0..$#names) {
985 $result_to_create{$names[$index]} = $$datum[$index];
987 push @results_to_create, \%result_to_create;
989 $rs->populate(\@results_to_create);
992 =head2 exception_action
996 =item Arguments: $code_reference
1000 If C<exception_action> is set for this class/object, L</throw_exception>
1001 will prefer to call this code reference with the exception as an argument,
1002 rather than its normal C<croak> or C<confess> action.
1004 Your subroutine should probably just wrap the error in the exception
1005 object/class of your choosing and rethrow. If, against all sage advice,
1006 you'd like your C<exception_action> to suppress a particular exception
1007 completely, simply have it return true.
1012 use base qw/DBIx::Class::Schema/;
1013 use My::ExceptionClass;
1014 __PACKAGE__->exception_action(sub { My::ExceptionClass->throw(@_) });
1015 __PACKAGE__->load_classes;
1018 my $schema_obj = My::Schema->connect( .... );
1019 $schema_obj->exception_action(sub { My::ExceptionClass->throw(@_) });
1021 # suppress all exceptions, like a moron:
1022 $schema_obj->exception_action(sub { 1 });
1028 =item Arguments: boolean
1032 Whether L</throw_exception> should include stack trace information.
1033 Defaults to false normally, but defaults to true if C<$ENV{DBIC_TRACE}>
1036 =head2 throw_exception
1040 =item Arguments: $message
1044 Throws an exception. Defaults to using L<Carp::Clan> to report errors from
1045 user's perspective. See L</exception_action> for details on overriding
1046 this method's behavior. If L</stacktrace> is turned on, C<throw_exception>'s
1047 default behavior will provide a detailed stack trace.
1051 sub throw_exception {
1054 DBIx::Class::Exception->throw($_[0], $self->stacktrace)
1055 if !$self->exception_action || !$self->exception_action->(@_);
1062 =item Arguments: $sqlt_args, $dir
1066 Attempts to deploy the schema to the current storage using L<SQL::Translator>.
1068 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>. The most
1069 common value for this would be C<< { add_drop_table => 1, } >> to have the SQL
1070 produced include a DROP TABLE statement for each table created.
1072 Additionally, the DBIx::Class parser accepts a C<sources> parameter as a hash
1073 ref or an array ref, containing a list of source to deploy. If present, then
1074 only the sources listed will get deployed. Furthermore, you can use the
1075 C<add_fk_index> parser parameter to prevent the parser from creating an index for each
1081 my ($self, $sqltargs, $dir) = @_;
1082 $self->throw_exception("Can't deploy without storage") unless $self->storage;
1083 $self->storage->deploy($self, undef, $sqltargs, $dir);
1086 =head2 deployment_statements
1090 =item Arguments: $rdbms_type
1094 Returns the SQL statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1095 C<$rdbms_type> provides the DBI database driver name for which the SQL
1096 statements are produced. If not supplied, the type of the current schema storage
1101 sub deployment_statements {
1102 my ($self, $rdbms_type) = @_;
1104 $self->throw_exception("Can't generate deployment statements without a storage")
1105 if not $self->storage;
1107 $self->storage->deployment_statements($self, $rdbms_type);
1110 =head2 create_ddl_dir (EXPERIMENTAL)
1114 =item Arguments: \@databases, $version, $directory, $preversion, $sqlt_args
1118 Creates an SQL file based on the Schema, for each of the specified
1119 database types, in the given directory. Given a previous version number,
1120 this will also create a file containing the ALTER TABLE statements to
1121 transform the previous schema into the current one. Note that these
1122 statements may contain DROP TABLE or DROP COLUMN statements that can
1123 potentially destroy data.
1125 The file names are created using the C<ddl_filename> method below, please
1126 override this method in your schema if you would like a different file
1127 name format. For the ALTER file, the same format is used, replacing
1128 $version in the name with "$preversion-$version".
1130 See L<DBIx::Class::Schema/deploy> for details of $sqlt_args.
1132 If no arguments are passed, then the following default values are used:
1136 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
1138 =item version - $schema->VERSION
1140 =item directory - './'
1142 =item preversion - <none>
1146 Note that this feature is currently EXPERIMENTAL and may not work correctly
1147 across all databases, or fully handle complex relationships.
1149 WARNING: Please check all SQL files created, before applying them.
1153 sub create_ddl_dir {
1156 $self->throw_exception("Can't create_ddl_dir without storage") unless $self->storage;
1157 $self->storage->create_ddl_dir($self, @_);
1164 =item Arguments: $database-type, $version, $directory, $preversion
1168 my $filename = $table->ddl_filename($type, $version, $dir, $preversion)
1170 This method is called by C<create_ddl_dir> to compose a file name out of
1171 the supplied directory, database type and version number. The default file
1172 name format is: C<$dir$schema-$version-$type.sql>.
1174 You may override this method in your schema if you wish to use a different
1180 my ($self, $type, $version, $dir, $preversion) = @_;
1182 my $filename = ref($self);
1183 $filename =~ s/::/-/g;
1184 $filename = File::Spec->catfile($dir, "$filename-$version-$type.sql");
1185 $filename =~ s/$version/$preversion-$version/ if($preversion);
1190 =head2 sqlt_deploy_hook($sqlt_schema)
1192 An optional sub which you can declare in your own Schema class that will get
1193 passed the L<SQL::Translator::Schema> object when you deploy the schema via
1194 L</create_ddl_dir> or L</deploy>.
1196 For an example of what you can do with this, see
1197 L<DBIx::Class::Manual::Cookbook/Adding Indexes And Functions To Your SQL>.
1201 Provided as the recommened way of thawing schema objects. You can call
1202 C<Storable::thaw> directly if you wish, but the thawed objects will not have a
1203 reference to any schema, so are rather useless
1208 my ($self, $obj) = @_;
1209 local $DBIx::Class::ResultSourceHandle::thaw_schema = $self;
1210 return Storable::thaw($obj);
1215 This doesn't actualy do anything more than call L<Storable/freeze>, it is just
1216 provided here for symetry.
1221 return Storable::freeze($_[1]);
1226 Recommeneded way of dcloning objects. This is needed to properly maintain
1227 references to the schema object (which itself is B<not> cloned.)
1232 my ($self, $obj) = @_;
1233 local $DBIx::Class::ResultSourceHandle::thaw_schema = $self;
1234 return Storable::dclone($obj);
1237 =head2 schema_version
1239 Returns the current schema class' $VERSION
1243 sub schema_version {
1245 my $class = ref($self)||$self;
1247 # does -not- use $schema->VERSION
1248 # since that varies in results depending on if version.pm is installed, and if
1249 # so the perl or XS versions. If you want this to change, bug the version.pm
1250 # author to make vpp and vxs behave the same.
1255 $version = ${"${class}::VERSION"};
1264 Matt S. Trout <mst@shadowcatsystems.co.uk>
1268 You may distribute this code under the same terms as Perl itself.