1 package DBIx::Class::Schema;
6 use base 'DBIx::Class';
10 use Scalar::Util qw/weaken blessed/;
11 use DBIx::Class::_Util qw(refcount quote_sub);
12 use Devel::GlobalDestruction;
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 all Result classes in Library/Schema/Result/
33 __PACKAGE__->load_namespaces();
35 package Library::Schema::Result::CD;
36 use base qw/DBIx::Class::Core/;
38 __PACKAGE__->load_components(qw/InflateColumn::DateTime/); # for example
39 __PACKAGE__->table('cd');
41 # Elsewhere in your code:
42 my $schema1 = Library::Schema->connect(
49 my $schema2 = Library::Schema->connect($coderef_returning_dbh);
51 # fetch objects using Library::Schema::Result::DVD
52 my $resultset = $schema1->resultset('DVD')->search( ... );
53 my @dvd_objects = $schema2->resultset('DVD')->search( ... );
57 Creates database classes based on a schema. This is the recommended way to
58 use L<DBIx::Class> and allows you to use more than one concurrent connection
61 NB: If you're used to L<Class::DBI> it's worth reading the L</SYNOPSIS>
62 carefully, as DBIx::Class does things a little differently. Note in
63 particular which module inherits off which.
67 =head2 load_namespaces
71 =item Arguments: %options?
75 package MyApp::Schema;
76 __PACKAGE__->load_namespaces();
78 __PACKAGE__->load_namespaces(
79 result_namespace => 'Res',
80 resultset_namespace => 'RSet',
81 default_resultset_class => '+MyApp::Othernamespace::RSet',
84 With no arguments, this method uses L<Module::Find> to load all of the
85 Result and ResultSet classes under the namespace of the schema from
86 which it is called. For example, C<My::Schema> will by default find
87 and load Result classes named C<My::Schema::Result::*> and ResultSet
88 classes named C<My::Schema::ResultSet::*>.
90 ResultSet classes are associated with Result class of the same name.
91 For example, C<My::Schema::Result::CD> will get the ResultSet class
92 C<My::Schema::ResultSet::CD> if it is present.
94 Both Result and ResultSet namespaces are configurable via the
95 C<result_namespace> and C<resultset_namespace> options.
97 Another option, C<default_resultset_class> specifies a custom default
98 ResultSet class for Result classes with no corresponding ResultSet.
100 All of the namespace and classname options are by default relative to
101 the schema classname. To specify a fully-qualified name, prefix it
102 with a literal C<+>. For example, C<+Other::NameSpace::Result>.
106 You will be warned if ResultSet classes are discovered for which there
107 are no matching Result classes like this:
109 load_namespaces found ResultSet class $classname with no corresponding Result class
111 If a Result class is found to already have a ResultSet class set using
112 L</resultset_class> to some other class, you will be warned like this:
114 We found ResultSet class '$rs_class' for '$result', but it seems
115 that you had already set '$result' to use '$rs_set' instead
119 # load My::Schema::Result::CD, My::Schema::Result::Artist,
120 # My::Schema::ResultSet::CD, etc...
121 My::Schema->load_namespaces;
123 # Override everything to use ugly names.
124 # In this example, if there is a My::Schema::Res::Foo, but no matching
125 # My::Schema::RSets::Foo, then Foo will have its
126 # resultset_class set to My::Schema::RSetBase
127 My::Schema->load_namespaces(
128 result_namespace => 'Res',
129 resultset_namespace => 'RSets',
130 default_resultset_class => 'RSetBase',
133 # Put things in other namespaces
134 My::Schema->load_namespaces(
135 result_namespace => '+Some::Place::Results',
136 resultset_namespace => '+Another::Place::RSets',
139 To search multiple namespaces for either Result or ResultSet classes,
140 use an arrayref of namespaces for that option. In the case that the
141 same result (or resultset) class exists in multiple namespaces, later
142 entries in the list of namespaces will override earlier ones.
144 My::Schema->load_namespaces(
145 # My::Schema::Results_C::Foo takes precedence over My::Schema::Results_B::Foo :
146 result_namespace => [ 'Results_A', 'Results_B', 'Results_C' ],
147 resultset_namespace => [ '+Some::Place::RSets', 'RSets' ],
152 # Pre-pends our classname to the given relative classname or
153 # class namespace, unless there is a '+' prefix, which will
155 sub _expand_relative_name {
156 my ($class, $name) = @_;
157 $name =~ s/^\+// or $name = "${class}::${name}";
161 # Finds all modules in the supplied namespace, or if omitted in the
162 # namespace of $class. Untaints all findings as they can be assumed
165 require Module::Find;
167 { $_ =~ /(.+)/ } # untaint result
168 Module::Find::findallmod( $_[1] || ref $_[0] || $_[0] )
172 # returns a hash of $shortname => $fullname for every package
173 # found in the given namespaces ($shortname is with the $fullname's
174 # namespace stripped off)
175 sub _map_namespaces {
176 my ($me, $namespaces) = @_;
179 for my $ns (@$namespaces) {
180 $res{ substr($_, length "${ns}::") } = $_
181 for $me->_findallmod($ns);
187 # returns the result_source_instance for the passed class/object,
188 # or dies with an informative message (used by load_namespaces)
189 sub _ns_get_rsrc_instance {
191 my $rs_class = ref ($_[0]) || $_[0];
194 $rs_class->result_source_instance
196 $me->throw_exception (
197 "Attempt to load_namespaces() class $rs_class failed - are you sure this is a real Result Class?: $_"
202 sub load_namespaces {
203 my ($class, %args) = @_;
205 my $result_namespace = delete $args{result_namespace} || 'Result';
206 my $resultset_namespace = delete $args{resultset_namespace} || 'ResultSet';
208 my $default_resultset_class = delete $args{default_resultset_class};
210 $default_resultset_class = $class->_expand_relative_name($default_resultset_class)
211 if $default_resultset_class;
213 $class->throw_exception('load_namespaces: unknown option(s): '
214 . join(q{,}, map { qq{'$_'} } keys %args))
215 if scalar keys %args;
217 for my $arg ($result_namespace, $resultset_namespace) {
218 $arg = [ $arg ] if ( $arg and ! ref $arg );
220 $class->throw_exception('load_namespaces: namespace arguments must be '
221 . 'a simple string or an arrayref')
222 if ref($arg) ne 'ARRAY';
224 $_ = $class->_expand_relative_name($_) for (@$arg);
227 my $results_by_source_name = $class->_map_namespaces($result_namespace);
228 my $resultsets_by_source_name = $class->_map_namespaces($resultset_namespace);
232 no warnings qw/redefine/;
233 local *Class::C3::reinitialize = sub { } if DBIx::Class::_ENV_::OLD_MRO;
234 use warnings qw/redefine/;
236 # ensure classes are loaded and attached in inheritance order
237 for my $result_class (values %$results_by_source_name) {
238 $class->ensure_class_loaded($result_class);
241 my @source_names_by_subclass_last = sort {
244 scalar @{mro::get_linear_isa( $results_by_source_name->{$a} )}
250 scalar @{mro::get_linear_isa( $results_by_source_name->{$b} )}
253 } keys(%$results_by_source_name);
255 foreach my $source_name (@source_names_by_subclass_last) {
256 my $result_class = $results_by_source_name->{$source_name};
258 my $preset_resultset_class = $class->_ns_get_rsrc_instance ($result_class)->resultset_class;
259 my $found_resultset_class = delete $resultsets_by_source_name->{$source_name};
261 if($preset_resultset_class && $preset_resultset_class ne 'DBIx::Class::ResultSet') {
262 if($found_resultset_class && $found_resultset_class ne $preset_resultset_class) {
263 carp "We found ResultSet class '$found_resultset_class' matching '$results_by_source_name->{$source_name}', but it seems "
264 . "that you had already set the '$results_by_source_name->{$source_name}' resultet to '$preset_resultset_class' instead";
267 # elsif - there may be *no* default_resultset_class, in which case we fallback to
268 # DBIx::Class::Resultset and there is nothing to check
269 elsif($found_resultset_class ||= $default_resultset_class) {
270 $class->ensure_class_loaded($found_resultset_class);
271 if(!$found_resultset_class->isa("DBIx::Class::ResultSet")) {
272 carp "load_namespaces found ResultSet class '$found_resultset_class' that does not subclass DBIx::Class::ResultSet";
275 $class->_ns_get_rsrc_instance ($result_class)->resultset_class($found_resultset_class);
278 my $source_name = $class->_ns_get_rsrc_instance ($result_class)->source_name || $source_name;
280 push(@to_register, [ $source_name, $result_class ]);
284 foreach (sort keys %$resultsets_by_source_name) {
285 carp "load_namespaces found ResultSet class '$resultsets_by_source_name->{$_}' "
286 .'with no corresponding Result class';
289 Class::C3->reinitialize if DBIx::Class::_ENV_::OLD_MRO;
291 $class->register_class(@$_) for (@to_register);
300 =item Arguments: @classes?, { $namespace => [ @classes ] }+
304 L</load_classes> is an alternative method to L</load_namespaces>, both of
305 which serve similar purposes, each with different advantages and disadvantages.
306 In the general case you should use L</load_namespaces>, unless you need to
307 be able to specify that only specific classes are loaded at runtime.
309 With no arguments, this method uses L<Module::Find> to find all classes under
310 the schema's namespace. Otherwise, this method loads the classes you specify
311 (using L<use>), and registers them (using L</"register_class">).
313 It is possible to comment out classes with a leading C<#>, but note that perl
314 will think it's a mistake (trying to use a comment in a qw list), so you'll
315 need to add C<no warnings 'qw';> before your load_classes call.
317 If any classes found do not appear to be Result class files, you will
318 get the following warning:
320 Failed to load $comp_class. Can't find source_name method. Is
321 $comp_class really a full DBIC result class? Fix it, move it elsewhere,
322 or make your load_classes call more specific.
326 My::Schema->load_classes(); # loads My::Schema::CD, My::Schema::Artist,
327 # etc. (anything under the My::Schema namespace)
329 # loads My::Schema::CD, My::Schema::Artist, Other::Namespace::Producer but
330 # not Other::Namespace::LinerNotes nor My::Schema::Track
331 My::Schema->load_classes(qw/ CD Artist #Track /, {
332 Other::Namespace => [qw/ Producer #LinerNotes /],
338 my ($class, @params) = @_;
343 foreach my $param (@params) {
344 if (ref $param eq 'ARRAY') {
345 # filter out commented entries
346 my @modules = grep { $_ !~ /^#/ } @$param;
348 push (@{$comps_for{$class}}, @modules);
350 elsif (ref $param eq 'HASH') {
351 # more than one namespace possible
352 for my $comp ( keys %$param ) {
353 # filter out commented entries
354 my @modules = grep { $_ !~ /^#/ } @{$param->{$comp}};
356 push (@{$comps_for{$comp}}, @modules);
360 # filter out commented entries
361 push (@{$comps_for{$class}}, $param) if $param !~ /^#/;
365 my @comp = map { substr $_, length "${class}::" }
366 $class->_findallmod($class);
367 $comps_for{$class} = \@comp;
372 no warnings qw/redefine/;
373 local *Class::C3::reinitialize = sub { } if DBIx::Class::_ENV_::OLD_MRO;
374 use warnings qw/redefine/;
376 foreach my $prefix (keys %comps_for) {
377 foreach my $comp (@{$comps_for{$prefix}||[]}) {
378 my $comp_class = "${prefix}::${comp}";
379 $class->ensure_class_loaded($comp_class);
381 my $snsub = $comp_class->can('source_name');
383 carp "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.";
386 $comp = $snsub->($comp_class) || $comp;
388 push(@to_register, [ $comp, $comp_class ]);
392 Class::C3->reinitialize if DBIx::Class::_ENV_::OLD_MRO;
394 foreach my $to (@to_register) {
395 $class->register_class(@$to);
403 =item Arguments: $storage_type|{$storage_type, \%args}
405 =item Return Value: $storage_type|{$storage_type, \%args}
407 =item Default value: DBIx::Class::Storage::DBI
411 Set the storage class that will be instantiated when L</connect> is called.
412 If the classname starts with C<::>, the prefix C<DBIx::Class::Storage> is
413 assumed by L</connect>.
415 You want to use this to set subclasses of L<DBIx::Class::Storage::DBI>
416 in cases where the appropriate subclass is not autodetected.
418 If your storage type requires instantiation arguments, those are
419 defined as a second argument in the form of a hashref and the entire
420 value needs to be wrapped into an arrayref or a hashref. We support
421 both types of refs here in order to play nice with your
422 Config::[class] or your choice. See
423 L<DBIx::Class::Storage::DBI::Replicated> for an example of this.
425 =head2 exception_action
429 =item Arguments: $code_reference
431 =item Return Value: $code_reference
433 =item Default value: None
437 When L</throw_exception> is invoked and L</exception_action> is set to a code
438 reference, this reference will be called instead of
439 L<DBIx::Class::Exception/throw>, with the exception message passed as the only
442 Your custom throw code B<must> rethrow the exception, as L</throw_exception> is
443 an integral part of DBIC's internal execution control flow.
448 use base qw/DBIx::Class::Schema/;
449 use My::ExceptionClass;
450 __PACKAGE__->exception_action(sub { My::ExceptionClass->throw(@_) });
451 __PACKAGE__->load_classes;
454 my $schema_obj = My::Schema->connect( .... );
455 $schema_obj->exception_action(sub { My::ExceptionClass->throw(@_) });
461 =item Arguments: boolean
465 Whether L</throw_exception> should include stack trace information.
466 Defaults to false normally, but defaults to true if C<$ENV{DBIC_TRACE}>
469 =head2 sqlt_deploy_hook
473 =item Arguments: $sqlt_schema
477 An optional sub which you can declare in your own Schema class that will get
478 passed the L<SQL::Translator::Schema> object when you deploy the schema via
479 L</create_ddl_dir> or L</deploy>.
481 For an example of what you can do with this, see
482 L<DBIx::Class::Manual::Cookbook/Adding Indexes And Functions To Your SQL>.
484 Note that sqlt_deploy_hook is called by L</deployment_statements>, which in turn
485 is called before L</deploy>. Therefore the hook can be used only to manipulate
486 the L<SQL::Translator::Schema> object before it is turned into SQL fed to the
487 database. If you want to execute post-deploy statements which can not be generated
488 by L<SQL::Translator>, the currently suggested method is to overload L</deploy>
489 and use L<dbh_do|DBIx::Class::Storage::DBI/dbh_do>.
497 =item Arguments: @connectinfo
499 =item Return Value: $new_schema
503 Creates and returns a new Schema object. The connection info set on it
504 is used to create a new instance of the storage backend and set it on
507 See L<DBIx::Class::Storage::DBI/"connect_info"> for DBI-specific
508 syntax on the C<@connectinfo> argument, or L<DBIx::Class::Storage> in
511 Note that C<connect_info> expects an arrayref of arguments, but
512 C<connect> does not. C<connect> wraps its arguments in an arrayref
513 before passing them to C<connect_info>.
517 C<connect> is a convenience method. It is equivalent to calling
518 $schema->clone->connection(@connectinfo). To write your own overloaded
519 version, overload L</connection> instead.
523 sub connect { shift->clone->connection(@_) }
529 =item Arguments: L<$source_name|DBIx::Class::ResultSource/source_name>
531 =item Return Value: L<$resultset|DBIx::Class::ResultSet>
535 my $rs = $schema->resultset('DVD');
537 Returns the L<DBIx::Class::ResultSet> object for the registered source
543 my ($self, $source_name) = @_;
544 $self->throw_exception('resultset() expects a source name')
545 unless defined $source_name;
546 return $self->source($source_name)->resultset;
553 =item Return Value: L<@source_names|DBIx::Class::ResultSource/source_name>
557 my @source_names = $schema->sources;
559 Lists names of all the sources registered on this Schema object.
563 sub sources { keys %{shift->source_registrations} }
569 =item Arguments: L<$source_name|DBIx::Class::ResultSource/source_name>
571 =item Return Value: L<$result_source|DBIx::Class::ResultSource>
575 my $source = $schema->source('Book');
577 Returns the L<DBIx::Class::ResultSource> object for the registered
585 $self->throw_exception("source() expects a source name")
588 my $source_name = shift;
590 my $sreg = $self->source_registrations;
591 return $sreg->{$source_name} if exists $sreg->{$source_name};
593 # if we got here, they probably passed a full class name
594 my $mapped = $self->class_mappings->{$source_name};
595 $self->throw_exception("Can't find source for ${source_name}")
596 unless $mapped && exists $sreg->{$mapped};
597 return $sreg->{$mapped};
604 =item Arguments: L<$source_name|DBIx::Class::ResultSource/source_name>
606 =item Return Value: $classname
610 my $class = $schema->class('CD');
612 Retrieves the Result class name for the given source name.
617 return shift->source(shift)->result_class;
624 =item Arguments: C<$coderef>, @coderef_args?
626 =item Return Value: The return value of $coderef
630 Executes C<$coderef> with (optional) arguments C<@coderef_args> atomically,
631 returning its result (if any). Equivalent to calling $schema->storage->txn_do.
632 See L<DBIx::Class::Storage/"txn_do"> for more information.
634 This interface is preferred over using the individual methods L</txn_begin>,
635 L</txn_commit>, and L</txn_rollback> below.
637 WARNING: If you are connected with C<< AutoCommit => 0 >> the transaction is
638 considered nested, and you will still need to call L</txn_commit> to write your
639 changes when appropriate. You will also want to connect with C<< auto_savepoint =>
640 1 >> to get partial rollback to work, if the storage driver for your database
643 Connecting with C<< AutoCommit => 1 >> is recommended.
650 $self->storage or $self->throw_exception
651 ('txn_do called on $schema without storage');
653 $self->storage->txn_do(@_);
656 =head2 txn_scope_guard
658 Runs C<txn_scope_guard> on the schema's storage. See
659 L<DBIx::Class::Storage/txn_scope_guard>.
663 sub txn_scope_guard {
666 $self->storage or $self->throw_exception
667 ('txn_scope_guard called on $schema without storage');
669 $self->storage->txn_scope_guard(@_);
674 Begins a transaction (does nothing if AutoCommit is off). Equivalent to
675 calling $schema->storage->txn_begin. See
676 L<DBIx::Class::Storage/"txn_begin"> for more information.
683 $self->storage or $self->throw_exception
684 ('txn_begin called on $schema without storage');
686 $self->storage->txn_begin;
691 Commits the current transaction. Equivalent to calling
692 $schema->storage->txn_commit. See L<DBIx::Class::Storage/"txn_commit">
693 for more information.
700 $self->storage or $self->throw_exception
701 ('txn_commit called on $schema without storage');
703 $self->storage->txn_commit;
708 Rolls back the current transaction. Equivalent to calling
709 $schema->storage->txn_rollback. See
710 L<DBIx::Class::Storage/"txn_rollback"> for more information.
717 $self->storage or $self->throw_exception
718 ('txn_rollback called on $schema without storage');
720 $self->storage->txn_rollback;
725 my $storage = $schema->storage;
727 Returns the L<DBIx::Class::Storage> object for this Schema. Grab this
728 if you want to turn on SQL statement debugging at runtime, or set the
729 quote character. For the default storage, the documentation can be
730 found in L<DBIx::Class::Storage::DBI>.
736 =item Arguments: L<$source_name|DBIx::Class::ResultSource/source_name>, [ \@column_list, \@row_values+ ] | [ \%col_data+ ]
738 =item Return Value: L<\@result_objects|DBIx::Class::Manual::ResultClass> (scalar context) | L<@result_objects|DBIx::Class::Manual::ResultClass> (list context)
742 A convenience shortcut to L<DBIx::Class::ResultSet/populate>. Equivalent to:
744 $schema->resultset($source_name)->populate([...]);
750 The context of this method call has an important effect on what is
751 submitted to storage. In void context data is fed directly to fastpath
752 insertion routines provided by the underlying storage (most often
753 L<DBI/execute_for_fetch>), bypassing the L<new|DBIx::Class::Row/new> and
754 L<insert|DBIx::Class::Row/insert> calls on the
755 L<Result|DBIx::Class::Manual::ResultClass> class, including any
756 augmentation of these methods provided by components. For example if you
757 are using something like L<DBIx::Class::UUIDColumns> to create primary
758 keys for you, you will find that your PKs are empty. In this case you
759 will have to explicitly force scalar or list context in order to create
767 my ($self, $name, $data) = @_;
768 my $rs = $self->resultset($name)
769 or $self->throw_exception("'$name' is not a resultset");
771 return $rs->populate($data);
778 =item Arguments: @args
780 =item Return Value: $new_schema
784 Similar to L</connect> except sets the storage object and connection
785 data in-place on the Schema class. You should probably be calling
786 L</connect> to get a proper Schema object instead.
790 Overload C<connection> to change the behaviour of C<connect>.
795 my ($self, @info) = @_;
796 return $self if !@info && $self->storage;
798 my ($storage_class, $args) = ref $self->storage_type
799 ? $self->_normalize_storage_type($self->storage_type)
800 : $self->storage_type
803 $storage_class =~ s/^::/DBIx::Class::Storage::/;
806 $self->ensure_class_loaded ($storage_class);
809 $self->throw_exception(
810 "Unable to load storage class ${storage_class}: $_"
814 my $storage = $storage_class->new( $self => $args||{} );
815 $storage->connect_info(\@info);
816 $self->storage($storage);
820 sub _normalize_storage_type {
821 my ($self, $storage_type) = @_;
822 if(ref $storage_type eq 'ARRAY') {
823 return @$storage_type;
824 } elsif(ref $storage_type eq 'HASH') {
825 return %$storage_type;
827 $self->throw_exception('Unsupported REFTYPE given: '. ref $storage_type);
831 =head2 compose_namespace
835 =item Arguments: $target_namespace, $additional_base_class?
837 =item Return Value: $new_schema
841 For each L<DBIx::Class::ResultSource> in the schema, this method creates a
842 class in the target namespace (e.g. $target_namespace::CD,
843 $target_namespace::Artist) that inherits from the corresponding classes
844 attached to the current schema.
846 It also attaches a corresponding L<DBIx::Class::ResultSource> object to the
847 new $schema object. If C<$additional_base_class> is given, the new composed
848 classes will inherit from first the corresponding class from the current
849 schema then the base class.
851 For example, for a schema with My::Schema::CD and My::Schema::Artist classes,
853 $schema->compose_namespace('My::DB', 'Base::Class');
854 print join (', ', @My::DB::CD::ISA) . "\n";
855 print join (', ', @My::DB::Artist::ISA) ."\n";
857 will produce the output
859 My::Schema::CD, Base::Class
860 My::Schema::Artist, Base::Class
864 # this might be oversimplified
865 # sub compose_namespace {
866 # my ($self, $target, $base) = @_;
868 # my $schema = $self->clone;
869 # foreach my $source_name ($schema->sources) {
870 # my $source = $schema->source($source_name);
871 # my $target_class = "${target}::${source_name}";
872 # $self->inject_base(
873 # $target_class => $source->result_class, ($base ? $base : ())
875 # $source->result_class($target_class);
876 # $target_class->result_source_instance($source)
877 # if $target_class->can('result_source_instance');
878 # $schema->register_source($source_name, $source);
883 sub compose_namespace {
884 my ($self, $target, $base) = @_;
886 my $schema = $self->clone;
888 $schema->source_registrations({});
890 # the original class-mappings must remain - otherwise
891 # reverse_relationship_info will not work
892 #$schema->class_mappings({});
895 no warnings qw/redefine/;
896 local *Class::C3::reinitialize = sub { } if DBIx::Class::_ENV_::OLD_MRO;
897 use warnings qw/redefine/;
899 foreach my $source_name ($self->sources) {
900 my $orig_source = $self->source($source_name);
902 my $target_class = "${target}::${source_name}";
903 $self->inject_base($target_class, $orig_source->result_class, ($base || ()) );
905 # register_source examines result_class, and then returns us a clone
906 my $new_source = $schema->register_source($source_name, bless
907 { %$orig_source, result_class => $target_class },
911 if ($target_class->can('result_source_instance')) {
912 # give the class a schema-less source copy
913 $target_class->result_source_instance( bless
914 { %$new_source, schema => ref $new_source->{schema} || $new_source->{schema} },
920 quote_sub "${target}::${_}" => "shift->schema->$_(\@_)"
921 for qw(class source resultset);
924 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
929 sub setup_connection_class {
930 my ($class, $target, @info) = @_;
931 $class->inject_base($target => 'DBIx::Class::DB');
932 #$target->load_components('DB');
933 $target->connection(@info);
938 Creates a new savepoint (does nothing outside a transaction).
939 Equivalent to calling $schema->storage->svp_begin. See
940 L<DBIx::Class::Storage/"svp_begin"> for more information.
945 my ($self, $name) = @_;
947 $self->storage or $self->throw_exception
948 ('svp_begin called on $schema without storage');
950 $self->storage->svp_begin($name);
955 Releases a savepoint (does nothing outside a transaction).
956 Equivalent to calling $schema->storage->svp_release. See
957 L<DBIx::Class::Storage/"svp_release"> for more information.
962 my ($self, $name) = @_;
964 $self->storage or $self->throw_exception
965 ('svp_release called on $schema without storage');
967 $self->storage->svp_release($name);
972 Rollback to a savepoint (does nothing outside a transaction).
973 Equivalent to calling $schema->storage->svp_rollback. See
974 L<DBIx::Class::Storage/"svp_rollback"> for more information.
979 my ($self, $name) = @_;
981 $self->storage or $self->throw_exception
982 ('svp_rollback called on $schema without storage');
984 $self->storage->svp_rollback($name);
991 =item Arguments: %attrs?
993 =item Return Value: $new_schema
997 Clones the schema and its associated result_source objects and returns the
998 copy. The resulting copy will have the same attributes as the source schema,
999 except for those attributes explicitly overridden by the provided C<%attrs>.
1007 (ref $self ? %$self : ()),
1008 (@_ == 1 && ref $_[0] eq 'HASH' ? %{ $_[0] } : @_),
1010 bless $clone, (ref $self || $self);
1012 $clone->$_(undef) for qw/class_mappings source_registrations storage/;
1014 $clone->_copy_state_from($self);
1019 # Needed in Schema::Loader - if you refactor, please make a compatibility shim
1021 sub _copy_state_from {
1022 my ($self, $from) = @_;
1024 $self->class_mappings({ %{$from->class_mappings} });
1025 $self->source_registrations({ %{$from->source_registrations} });
1027 foreach my $source_name ($from->sources) {
1028 my $source = $from->source($source_name);
1029 my $new = $source->new($source);
1030 # we use extra here as we want to leave the class_mappings as they are
1031 # but overwrite the source_registrations entry with the new source
1032 $self->register_extra_source($source_name => $new);
1035 if ($from->storage) {
1036 $self->storage($from->storage);
1037 $self->storage->set_schema($self);
1041 =head2 throw_exception
1045 =item Arguments: $message
1049 Throws an exception. Obeys the exemption rules of L<DBIx::Class::Carp> to report
1050 errors from outer-user's perspective. See L</exception_action> for details on overriding
1051 this method's behavior. If L</stacktrace> is turned on, C<throw_exception>'s
1052 default behavior will provide a detailed stack trace.
1056 sub throw_exception {
1059 if (my $act = $self->exception_action) {
1061 DBIx::Class::Exception->throw(
1062 "Invocation of the exception_action handler installed on $self did *not*"
1063 .' result in an exception. DBIx::Class is unable to function without a reliable'
1064 .' exception mechanism, ensure that exception_action does not hide exceptions'
1065 ." (original error: $_[0])"
1070 "The exception_action handler installed on $self returned false instead"
1071 .' of throwing an exception. This behavior has been deprecated, adjust your'
1072 .' handler to always rethrow the supplied error.'
1076 DBIx::Class::Exception->throw($_[0], $self->stacktrace);
1083 =item Arguments: \%sqlt_args, $dir
1087 Attempts to deploy the schema to the current storage using L<SQL::Translator>.
1089 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
1090 The most common value for this would be C<< { add_drop_table => 1 } >>
1091 to have the SQL produced include a C<DROP TABLE> statement for each table
1092 created. For quoting purposes supply C<quote_identifiers>.
1094 Additionally, the DBIx::Class parser accepts a C<sources> parameter as a hash
1095 ref or an array ref, containing a list of source to deploy. If present, then
1096 only the sources listed will get deployed. Furthermore, you can use the
1097 C<add_fk_index> parser parameter to prevent the parser from creating an index for each
1103 my ($self, $sqltargs, $dir) = @_;
1104 $self->throw_exception("Can't deploy without storage") unless $self->storage;
1105 $self->storage->deploy($self, undef, $sqltargs, $dir);
1108 =head2 deployment_statements
1112 =item Arguments: See L<DBIx::Class::Storage::DBI/deployment_statements>
1114 =item Return Value: $listofstatements
1118 A convenient shortcut to
1119 C<< $self->storage->deployment_statements($self, @args) >>.
1120 Returns the SQL statements used by L</deploy> and
1121 L<DBIx::Class::Schema::Storage/deploy>.
1125 sub deployment_statements {
1128 $self->throw_exception("Can't generate deployment statements without a storage")
1129 if not $self->storage;
1131 $self->storage->deployment_statements($self, @_);
1134 =head2 create_ddl_dir
1138 =item Arguments: See L<DBIx::Class::Storage::DBI/create_ddl_dir>
1142 A convenient shortcut to
1143 C<< $self->storage->create_ddl_dir($self, @args) >>.
1145 Creates an SQL file based on the Schema, for each of the specified
1146 database types, in the given directory.
1150 sub create_ddl_dir {
1153 $self->throw_exception("Can't create_ddl_dir without storage") unless $self->storage;
1154 $self->storage->create_ddl_dir($self, @_);
1161 =item Arguments: $database-type, $version, $directory, $preversion
1163 =item Return Value: $normalised_filename
1167 my $filename = $table->ddl_filename($type, $version, $dir, $preversion)
1169 This method is called by C<create_ddl_dir> to compose a file name out of
1170 the supplied directory, database type and version number. The default file
1171 name format is: C<$dir$schema-$version-$type.sql>.
1173 You may override this method in your schema if you wish to use a different
1178 Prior to DBIx::Class version 0.08100 this method had a different signature:
1180 my $filename = $table->ddl_filename($type, $dir, $version, $preversion)
1182 In recent versions variables $dir and $version were reversed in order to
1183 bring the signature in line with other Schema/Storage methods. If you
1184 really need to maintain backward compatibility, you can do the following
1185 in any overriding methods:
1187 ($dir, $version) = ($version, $dir) if ($DBIx::Class::VERSION < 0.08100);
1192 my ($self, $type, $version, $dir, $preversion) = @_;
1196 $version = "$preversion-$version" if $preversion;
1198 my $class = blessed($self) || $self;
1201 return File::Spec->catfile($dir, "$class-$version-$type.sql");
1206 Provided as the recommended way of thawing schema objects. You can call
1207 C<Storable::thaw> directly if you wish, but the thawed objects will not have a
1208 reference to any schema, so are rather useless.
1213 my ($self, $obj) = @_;
1214 local $DBIx::Class::ResultSourceHandle::thaw_schema = $self;
1216 return Storable::thaw($obj);
1221 This doesn't actually do anything more than call L<Storable/nfreeze>, it is just
1222 provided here for symmetry.
1228 return Storable::nfreeze($_[1]);
1235 =item Arguments: $object
1237 =item Return Value: dcloned $object
1241 Recommended way of dcloning L<DBIx::Class::Row> and L<DBIx::Class::ResultSet>
1242 objects so their references to the schema object
1243 (which itself is B<not> cloned) are properly maintained.
1248 my ($self, $obj) = @_;
1249 local $DBIx::Class::ResultSourceHandle::thaw_schema = $self;
1251 return Storable::dclone($obj);
1254 =head2 schema_version
1256 Returns the current schema class' $VERSION in a normalised way.
1260 sub schema_version {
1262 my $class = ref($self)||$self;
1264 # does -not- use $schema->VERSION
1265 # since that varies in results depending on if version.pm is installed, and if
1266 # so the perl or XS versions. If you want this to change, bug the version.pm
1267 # author to make vpp and vxs behave the same.
1272 $version = ${"${class}::VERSION"};
1278 =head2 register_class
1282 =item Arguments: $source_name, $component_class
1286 This method is called by L</load_namespaces> and L</load_classes> to install the found classes into your Schema. You should be using those instead of this one.
1288 You will only need this method if you have your Result classes in
1289 files which are not named after the packages (or all in the same
1290 file). You may also need it to register classes at runtime.
1292 Registers a class which isa DBIx::Class::ResultSourceProxy. Equivalent to
1295 $schema->register_source($source_name, $component_class->result_source_instance);
1299 sub register_class {
1300 my ($self, $source_name, $to_register) = @_;
1301 $self->register_source($source_name => $to_register->result_source_instance);
1304 =head2 register_source
1308 =item Arguments: $source_name, L<$result_source|DBIx::Class::ResultSource>
1312 This method is called by L</register_class>.
1314 Registers the L<DBIx::Class::ResultSource> in the schema with the given
1319 sub register_source { shift->_register_source(@_) }
1321 =head2 unregister_source
1325 =item Arguments: $source_name
1329 Removes the L<DBIx::Class::ResultSource> from the schema for the given source name.
1333 sub unregister_source { shift->_unregister_source(@_) }
1335 =head2 register_extra_source
1339 =item Arguments: $source_name, L<$result_source|DBIx::Class::ResultSource>
1343 As L</register_source> but should be used if the result class already
1344 has a source and you want to register an extra one.
1348 sub register_extra_source { shift->_register_source(@_, { extra => 1 }) }
1350 sub _register_source {
1351 my ($self, $source_name, $source, $params) = @_;
1353 $source = $source->new({ %$source, source_name => $source_name });
1355 $source->schema($self);
1356 weaken $source->{schema} if ref($self);
1358 my %reg = %{$self->source_registrations};
1359 $reg{$source_name} = $source;
1360 $self->source_registrations(\%reg);
1362 return $source if $params->{extra};
1364 my $rs_class = $source->result_class;
1365 if ($rs_class and my $rsrc = try { $rs_class->result_source_instance } ) {
1366 my %map = %{$self->class_mappings};
1368 exists $map{$rs_class}
1370 $map{$rs_class} ne $source_name
1372 $rsrc ne $_[2] # orig_source
1375 "$rs_class already had a registered source which was replaced by this call. "
1376 . 'Perhaps you wanted register_extra_source(), though it is more likely you did '
1377 . 'something wrong.'
1381 $map{$rs_class} = $source_name;
1382 $self->class_mappings(\%map);
1388 my $global_phase_destroy;
1390 return if $global_phase_destroy ||= in_global_destruction;
1393 my $srcs = $self->source_registrations;
1395 for my $source_name (keys %$srcs) {
1396 # find first source that is not about to be GCed (someone other than $self
1397 # holds a reference to it) and reattach to it, weakening our own link
1399 # during global destruction (if we have not yet bailed out) this should throw
1400 # which will serve as a signal to not try doing anything else
1401 # however beware - on older perls the exception seems randomly untrappable
1402 # due to some weird race condition during thread joining :(((
1403 if (length ref $srcs->{$source_name} and refcount($srcs->{$source_name}) > 1) {
1406 $srcs->{$source_name}->schema($self);
1407 weaken $srcs->{$source_name};
1410 $global_phase_destroy = 1;
1418 sub _unregister_source {
1419 my ($self, $source_name) = @_;
1420 my %reg = %{$self->source_registrations};
1422 my $source = delete $reg{$source_name};
1423 $self->source_registrations(\%reg);
1424 if ($source->result_class) {
1425 my %map = %{$self->class_mappings};
1426 delete $map{$source->result_class};
1427 $self->class_mappings(\%map);
1432 =head2 compose_connection (DEPRECATED)
1436 =item Arguments: $target_namespace, @db_info
1438 =item Return Value: $new_schema
1442 DEPRECATED. You probably wanted compose_namespace.
1444 Actually, you probably just wanted to call connect.
1448 (hidden due to deprecation)
1450 Calls L<DBIx::Class::Schema/"compose_namespace"> to the target namespace,
1451 calls L<DBIx::Class::Schema/connection> with @db_info on the new schema,
1452 then injects the L<DBix::Class::ResultSetProxy> component and a
1453 resultset_instance classdata entry on all the new classes, in order to support
1454 $target_namespaces::$class->search(...) method calls.
1456 This is primarily useful when you have a specific need for class method access
1457 to a connection. In normal usage it is preferred to call
1458 L<DBIx::Class::Schema/connect> and use the resulting schema object to operate
1459 on L<DBIx::Class::ResultSet> objects with L<DBIx::Class::Schema/resultset> for
1466 sub compose_connection {
1467 my ($self, $target, @info) = @_;
1469 carp_once "compose_connection deprecated as of 0.08000"
1470 unless $INC{"DBIx/Class/CDBICompat.pm"};
1472 my $base = 'DBIx::Class::ResultSetProxy';
1474 eval "require ${base};"
1477 $self->throw_exception
1478 ("No arguments to load_classes and couldn't load ${base} ($_)")
1481 if ($self eq $target) {
1482 # Pathological case, largely caused by the docs on early C::M::DBIC::Plain
1483 foreach my $source_name ($self->sources) {
1484 my $source = $self->source($source_name);
1485 my $class = $source->result_class;
1486 $self->inject_base($class, $base);
1487 $class->mk_classdata(resultset_instance => $source->resultset);
1488 $class->mk_classdata(class_resolver => $self);
1490 $self->connection(@info);
1494 my $schema = $self->compose_namespace($target, $base);
1495 quote_sub "${target}::schema", '$s', { '$s' => \$schema };
1497 $schema->connection(@info);
1498 foreach my $source_name ($schema->sources) {
1499 my $source = $schema->source($source_name);
1500 my $class = $source->result_class;
1501 #warn "$source_name $class $source ".$source->storage;
1502 $class->mk_classdata(result_source_instance => $source);
1503 $class->mk_classdata(resultset_instance => $source->resultset);
1504 $class->mk_classdata(class_resolver => $schema);
1511 =head1 AUTHOR AND CONTRIBUTORS
1513 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
1517 You may distribute this code under the same terms as Perl itself.