1 package DBIx::Class::Schema;
6 use DBIx::Class::Exception;
7 use Carp::Clan qw/^DBIx::Class|^Try::Tiny/;
9 use Scalar::Util 'weaken';
10 use Sub::Name 'subname';
11 use B 'svref_2object';
14 use base qw/DBIx::Class/;
16 __PACKAGE__->mk_classdata('class_mappings' => {});
17 __PACKAGE__->mk_classdata('source_registrations' => {});
18 __PACKAGE__->mk_classdata('storage_type' => '::DBI');
19 __PACKAGE__->mk_classdata('storage');
20 __PACKAGE__->mk_classdata('exception_action');
21 __PACKAGE__->mk_classdata('stacktrace' => $ENV{DBIC_TRACE} || 0);
22 __PACKAGE__->mk_classdata('default_resultset_attributes' => {});
26 DBIx::Class::Schema - composable schemas
30 package Library::Schema;
31 use base qw/DBIx::Class::Schema/;
33 # load all Result classes in Library/Schema/Result/
34 __PACKAGE__->load_namespaces();
36 package Library::Schema::Result::CD;
37 use base qw/DBIx::Class::Core/;
39 __PACKAGE__->load_components(qw/InflateColumn::DateTime/); # for example
40 __PACKAGE__->table('cd');
42 # Elsewhere in your code:
43 my $schema1 = Library::Schema->connect(
50 my $schema2 = Library::Schema->connect($coderef_returning_dbh);
52 # fetch objects using Library::Schema::Result::DVD
53 my $resultset = $schema1->resultset('DVD')->search( ... );
54 my @dvd_objects = $schema2->resultset('DVD')->search( ... );
58 Creates database classes based on a schema. This is the recommended way to
59 use L<DBIx::Class> and allows you to use more than one concurrent connection
62 NB: If you're used to L<Class::DBI> it's worth reading the L</SYNOPSIS>
63 carefully, as DBIx::Class does things a little differently. Note in
64 particular which module inherits off which.
68 =head2 load_namespaces
72 =item Arguments: %options?
76 __PACKAGE__->load_namespaces();
78 __PACKAGE__->load_namespaces(
79 result_namespace => 'Res',
80 resultset_namespace => 'RSet',
81 default_resultset_class => '+MyDB::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) = @_;
158 $name = $class . '::' . $name if ! ($name =~ s/^\+//);
162 # Finds all modules in the supplied namespace, or if omitted in the
163 # namespace of $class. Untaints all findings as they can be assumed
167 my $ns = shift || ref $proto || $proto;
169 require Module::Find;
170 my @mods = Module::Find::findallmod($ns);
172 # try to untaint module names. mods where this fails
173 # are left alone so we don't have to change the old behavior
174 no locale; # localized \w doesn't untaint expression
175 return map { $_ =~ m/^( (?:\w+::)* \w+ )$/x ? $1 : $_ } @mods;
178 # returns a hash of $shortname => $fullname for every package
179 # found in the given namespaces ($shortname is with the $fullname's
180 # namespace stripped off)
181 sub _map_namespaces {
182 my ($class, @namespaces) = @_;
185 foreach my $namespace (@namespaces) {
188 map { (substr($_, length "${namespace}::"), $_) }
189 $class->_findallmod($namespace)
196 # returns the result_source_instance for the passed class/object,
197 # or dies with an informative message (used by load_namespaces)
198 sub _ns_get_rsrc_instance {
200 my $rs = ref ($_[0]) || $_[0];
202 if ($rs->can ('result_source_instance') ) {
203 return $rs->result_source_instance;
206 $class->throw_exception (
207 "Attempt to load_namespaces() class $rs failed - are you sure this is a real Result Class?"
212 sub load_namespaces {
213 my ($class, %args) = @_;
215 my $result_namespace = delete $args{result_namespace} || 'Result';
216 my $resultset_namespace = delete $args{resultset_namespace} || 'ResultSet';
217 my $default_resultset_class = delete $args{default_resultset_class};
219 $class->throw_exception('load_namespaces: unknown option(s): '
220 . join(q{,}, map { qq{'$_'} } keys %args))
221 if scalar keys %args;
223 $default_resultset_class
224 = $class->_expand_relative_name($default_resultset_class);
226 for my $arg ($result_namespace, $resultset_namespace) {
227 $arg = [ $arg ] if !ref($arg) && $arg;
229 $class->throw_exception('load_namespaces: namespace arguments must be '
230 . 'a simple string or an arrayref')
231 if ref($arg) ne 'ARRAY';
233 $_ = $class->_expand_relative_name($_) for (@$arg);
236 my %results = $class->_map_namespaces(@$result_namespace);
237 my %resultsets = $class->_map_namespaces(@$resultset_namespace);
241 no warnings qw/redefine/;
242 local *Class::C3::reinitialize = sub { } if DBIx::Class::_ENV_::OLD_MRO;
243 use warnings qw/redefine/;
245 # ensure classes are loaded and attached in inheritance order
246 for my $res (values %results) {
247 $class->ensure_class_loaded($res);
250 my @subclass_last = sort {
253 scalar @{mro::get_linear_isa( $results{$a} )}
259 scalar @{mro::get_linear_isa( $results{$b} )}
264 foreach my $result (@subclass_last) {
265 my $result_class = $results{$result};
267 my $rs_class = delete $resultsets{$result};
268 my $rs_set = $class->_ns_get_rsrc_instance ($result_class)->resultset_class;
270 if($rs_set && $rs_set ne 'DBIx::Class::ResultSet') {
271 if($rs_class && $rs_class ne $rs_set) {
272 carp "We found ResultSet class '$rs_class' for '$result', but it seems "
273 . "that you had already set '$result' to use '$rs_set' instead";
276 elsif($rs_class ||= $default_resultset_class) {
277 $class->ensure_class_loaded($rs_class);
278 if(!$rs_class->isa("DBIx::Class::ResultSet")) {
279 carp "load_namespaces found ResultSet class $rs_class that does not subclass DBIx::Class::ResultSet";
282 $class->_ns_get_rsrc_instance ($result_class)->resultset_class($rs_class);
285 my $source_name = $class->_ns_get_rsrc_instance ($result_class)->source_name || $result;
287 push(@to_register, [ $source_name, $result_class ]);
291 foreach (sort keys %resultsets) {
292 carp "load_namespaces found ResultSet class $_ with no "
293 . 'corresponding Result class';
296 Class::C3->reinitialize if DBIx::Class::_ENV_::OLD_MRO;
298 $class->register_class(@$_) for (@to_register);
307 =item Arguments: @classes?, { $namespace => [ @classes ] }+
311 L</load_classes> is an alternative method to L</load_namespaces>, both of
312 which serve similar purposes, each with different advantages and disadvantages.
313 In the general case you should use L</load_namespaces>, unless you need to
314 be able to specify that only specific classes are loaded at runtime.
316 With no arguments, this method uses L<Module::Find> to find all classes under
317 the schema's namespace. Otherwise, this method loads the classes you specify
318 (using L<use>), and registers them (using L</"register_class">).
320 It is possible to comment out classes with a leading C<#>, but note that perl
321 will think it's a mistake (trying to use a comment in a qw list), so you'll
322 need to add C<no warnings 'qw';> before your load_classes call.
324 If any classes found do not appear to be Result class files, you will
325 get the following warning:
327 Failed to load $comp_class. Can't find source_name method. Is
328 $comp_class really a full DBIC result class? Fix it, move it elsewhere,
329 or make your load_classes call more specific.
333 My::Schema->load_classes(); # loads My::Schema::CD, My::Schema::Artist,
334 # etc. (anything under the My::Schema namespace)
336 # loads My::Schema::CD, My::Schema::Artist, Other::Namespace::Producer but
337 # not Other::Namespace::LinerNotes nor My::Schema::Track
338 My::Schema->load_classes(qw/ CD Artist #Track /, {
339 Other::Namespace => [qw/ Producer #LinerNotes /],
345 my ($class, @params) = @_;
350 foreach my $param (@params) {
351 if (ref $param eq 'ARRAY') {
352 # filter out commented entries
353 my @modules = grep { $_ !~ /^#/ } @$param;
355 push (@{$comps_for{$class}}, @modules);
357 elsif (ref $param eq 'HASH') {
358 # more than one namespace possible
359 for my $comp ( keys %$param ) {
360 # filter out commented entries
361 my @modules = grep { $_ !~ /^#/ } @{$param->{$comp}};
363 push (@{$comps_for{$comp}}, @modules);
367 # filter out commented entries
368 push (@{$comps_for{$class}}, $param) if $param !~ /^#/;
372 my @comp = map { substr $_, length "${class}::" }
374 $comps_for{$class} = \@comp;
379 no warnings qw/redefine/;
380 local *Class::C3::reinitialize = sub { } if DBIx::Class::_ENV_::OLD_MRO;
381 use warnings qw/redefine/;
383 foreach my $prefix (keys %comps_for) {
384 foreach my $comp (@{$comps_for{$prefix}||[]}) {
385 my $comp_class = "${prefix}::${comp}";
386 $class->ensure_class_loaded($comp_class);
388 my $snsub = $comp_class->can('source_name');
390 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.";
393 $comp = $snsub->($comp_class) || $comp;
395 push(@to_register, [ $comp, $comp_class ]);
399 Class::C3->reinitialize if DBIx::Class::_ENV_::OLD_MRO;
401 foreach my $to (@to_register) {
402 $class->register_class(@$to);
403 # if $class->can('result_source_instance');
411 =item Arguments: $storage_type|{$storage_type, \%args}
413 =item Return value: $storage_type|{$storage_type, \%args}
415 =item Default value: DBIx::Class::Storage::DBI
419 Set the storage class that will be instantiated when L</connect> is called.
420 If the classname starts with C<::>, the prefix C<DBIx::Class::Storage> is
421 assumed by L</connect>.
423 You want to use this to set subclasses of L<DBIx::Class::Storage::DBI>
424 in cases where the appropriate subclass is not autodetected.
426 If your storage type requires instantiation arguments, those are
427 defined as a second argument in the form of a hashref and the entire
428 value needs to be wrapped into an arrayref or a hashref. We support
429 both types of refs here in order to play nice with your
430 Config::[class] or your choice. See
431 L<DBIx::Class::Storage::DBI::Replicated> for an example of this.
433 =head2 exception_action
437 =item Arguments: $code_reference
439 =item Return value: $code_reference
441 =item Default value: None
445 When L</throw_exception> is invoked and L</exception_action> is set to a code
446 reference, this reference will be called instead of
447 L<DBIx::Class::Exception/throw>, with the exception message passed as the only
450 Your custom throw code B<must> rethrow the exception, as L</throw_exception> is
451 an integral part of DBIC's internal execution control flow.
456 use base qw/DBIx::Class::Schema/;
457 use My::ExceptionClass;
458 __PACKAGE__->exception_action(sub { My::ExceptionClass->throw(@_) });
459 __PACKAGE__->load_classes;
462 my $schema_obj = My::Schema->connect( .... );
463 $schema_obj->exception_action(sub { My::ExceptionClass->throw(@_) });
469 =item Arguments: boolean
473 Whether L</throw_exception> should include stack trace information.
474 Defaults to false normally, but defaults to true if C<$ENV{DBIC_TRACE}>
477 =head2 sqlt_deploy_hook
481 =item Arguments: $sqlt_schema
485 An optional sub which you can declare in your own Schema class that will get
486 passed the L<SQL::Translator::Schema> object when you deploy the schema via
487 L</create_ddl_dir> or L</deploy>.
489 For an example of what you can do with this, see
490 L<DBIx::Class::Manual::Cookbook/Adding Indexes And Functions To Your SQL>.
492 Note that sqlt_deploy_hook is called by L</deployment_statements>, which in turn
493 is called before L</deploy>. Therefore the hook can be used only to manipulate
494 the L<SQL::Translator::Schema> object before it is turned into SQL fed to the
495 database. If you want to execute post-deploy statements which can not be generated
496 by L<SQL::Translator>, the currently suggested method is to overload L</deploy>
497 and use L<dbh_do|DBIx::Class::Storage::DBI/dbh_do>.
505 =item Arguments: @connectinfo
507 =item Return Value: $new_schema
511 Creates and returns a new Schema object. The connection info set on it
512 is used to create a new instance of the storage backend and set it on
515 See L<DBIx::Class::Storage::DBI/"connect_info"> for DBI-specific
516 syntax on the C<@connectinfo> argument, or L<DBIx::Class::Storage> in
519 Note that C<connect_info> expects an arrayref of arguments, but
520 C<connect> does not. C<connect> wraps its arguments in an arrayref
521 before passing them to C<connect_info>.
525 C<connect> is a convenience method. It is equivalent to calling
526 $schema->clone->connection(@connectinfo). To write your own overloaded
527 version, overload L</connection> instead.
531 sub connect { shift->clone->connection(@_) }
537 =item Arguments: $source_name
539 =item Return Value: $resultset
543 my $rs = $schema->resultset('DVD');
545 Returns the L<DBIx::Class::ResultSet> object for the registered source
551 my ($self, $moniker) = @_;
552 $self->throw_exception('resultset() expects a source name')
553 unless defined $moniker;
554 return $self->source($moniker)->resultset;
561 =item Return Value: @source_names
565 my @source_names = $schema->sources;
567 Lists names of all the sources registered on this Schema object.
571 sub sources { return keys %{shift->source_registrations}; }
577 =item Arguments: $source_name
579 =item Return Value: $result_source
583 my $source = $schema->source('Book');
585 Returns the L<DBIx::Class::ResultSource> object for the registered
593 $self->throw_exception("source() expects a source name")
598 my $sreg = $self->source_registrations;
599 return $sreg->{$moniker} if exists $sreg->{$moniker};
601 # if we got here, they probably passed a full class name
602 my $mapped = $self->class_mappings->{$moniker};
603 $self->throw_exception("Can't find source for ${moniker}")
604 unless $mapped && exists $sreg->{$mapped};
605 return $sreg->{$mapped};
612 =item Arguments: $source_name
614 =item Return Value: $classname
618 my $class = $schema->class('CD');
620 Retrieves the Result class name for the given source name.
625 my ($self, $moniker) = @_;
626 return $self->source($moniker)->result_class;
633 =item Arguments: C<$coderef>, @coderef_args?
635 =item Return Value: The return value of $coderef
639 Executes C<$coderef> with (optional) arguments C<@coderef_args> atomically,
640 returning its result (if any). Equivalent to calling $schema->storage->txn_do.
641 See L<DBIx::Class::Storage/"txn_do"> for more information.
643 This interface is preferred over using the individual methods L</txn_begin>,
644 L</txn_commit>, and L</txn_rollback> below.
646 WARNING: If you are connected with C<< AutoCommit => 0 >> the transaction is
647 considered nested, and you will still need to call L</txn_commit> to write your
648 changes when appropriate. You will also want to connect with C<< auto_savepoint =>
649 1 >> to get partial rollback to work, if the storage driver for your database
652 Connecting with C<< AutoCommit => 1 >> is recommended.
659 $self->storage or $self->throw_exception
660 ('txn_do called on $schema without storage');
662 $self->storage->txn_do(@_);
665 =head2 txn_scope_guard
667 Runs C<txn_scope_guard> on the schema's storage. See
668 L<DBIx::Class::Storage/txn_scope_guard>.
672 sub txn_scope_guard {
675 $self->storage or $self->throw_exception
676 ('txn_scope_guard called on $schema without storage');
678 $self->storage->txn_scope_guard(@_);
683 Begins a transaction (does nothing if AutoCommit is off). Equivalent to
684 calling $schema->storage->txn_begin. See
685 L<DBIx::Class::Storage/"txn_begin"> for more information.
692 $self->storage or $self->throw_exception
693 ('txn_begin called on $schema without storage');
695 $self->storage->txn_begin;
700 Commits the current transaction. Equivalent to calling
701 $schema->storage->txn_commit. See L<DBIx::Class::Storage/"txn_commit">
702 for more information.
709 $self->storage or $self->throw_exception
710 ('txn_commit called on $schema without storage');
712 $self->storage->txn_commit;
717 Rolls back the current transaction. Equivalent to calling
718 $schema->storage->txn_rollback. See
719 L<DBIx::Class::Storage/"txn_rollback"> for more information.
726 $self->storage or $self->throw_exception
727 ('txn_rollback called on $schema without storage');
729 $self->storage->txn_rollback;
734 my $storage = $schema->storage;
736 Returns the L<DBIx::Class::Storage> object for this Schema. Grab this
737 if you want to turn on SQL statement debugging at runtime, or set the
738 quote character. For the default storage, the documentation can be
739 found in L<DBIx::Class::Storage::DBI>.
745 =item Arguments: $source_name, \@data;
747 =item Return value: \@$objects | nothing
751 Pass this method a resultsource name, and an arrayref of
752 arrayrefs. The arrayrefs should contain a list of column names,
753 followed by one or many sets of matching data for the given columns.
755 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
756 to insert the data, as this is a fast method. However, insert_bulk currently
757 assumes that your datasets all contain the same type of values, using scalar
758 references in a column in one row, and not in another will probably not work.
760 Otherwise, each set of data is inserted into the database using
761 L<DBIx::Class::ResultSet/create>, and a arrayref of the resulting row
766 $schema->populate('Artist', [
767 [ qw/artistid name/ ],
768 [ 1, 'Popular Band' ],
773 Since wantarray context is basically the same as looping over $rs->create(...)
774 you won't see any performance benefits and in this case the method is more for
775 convenience. Void context sends the column information directly to storage
776 using <DBI>s bulk insert method. So the performance will be much better for
777 storages that support this method.
779 Because of this difference in the way void context inserts rows into your
780 database you need to note how this will effect any loaded components that
781 override or augment insert. For example if you are using a component such
782 as L<DBIx::Class::UUIDColumns> to populate your primary keys you MUST use
783 wantarray context if you want the PKs automatically created.
788 my ($self, $name, $data) = @_;
789 if(my $rs = $self->resultset($name)) {
790 if(defined wantarray) {
791 return $rs->populate($data);
793 $rs->populate($data);
796 $self->throw_exception("$name is not a resultset");
804 =item Arguments: @args
806 =item Return Value: $new_schema
810 Similar to L</connect> except sets the storage object and connection
811 data in-place on the Schema class. You should probably be calling
812 L</connect> to get a proper Schema object instead.
816 Overload C<connection> to change the behaviour of C<connect>.
821 my ($self, @info) = @_;
822 return $self if !@info && $self->storage;
824 my ($storage_class, $args) = ref $self->storage_type ?
825 ($self->_normalize_storage_type($self->storage_type),{}) : ($self->storage_type, {});
827 $storage_class = 'DBIx::Class::Storage'.$storage_class
828 if $storage_class =~ m/^::/;
830 $self->ensure_class_loaded ($storage_class);
833 $self->throw_exception(
834 "No arguments to load_classes and couldn't load ${storage_class} ($_)"
837 my $storage = $storage_class->new($self=>$args);
838 $storage->connect_info(\@info);
839 $self->storage($storage);
843 sub _normalize_storage_type {
844 my ($self, $storage_type) = @_;
845 if(ref $storage_type eq 'ARRAY') {
846 return @$storage_type;
847 } elsif(ref $storage_type eq 'HASH') {
848 return %$storage_type;
850 $self->throw_exception('Unsupported REFTYPE given: '. ref $storage_type);
854 =head2 compose_namespace
858 =item Arguments: $target_namespace, $additional_base_class?
860 =item Retur Value: $new_schema
864 For each L<DBIx::Class::ResultSource> in the schema, this method creates a
865 class in the target namespace (e.g. $target_namespace::CD,
866 $target_namespace::Artist) that inherits from the corresponding classes
867 attached to the current schema.
869 It also attaches a corresponding L<DBIx::Class::ResultSource> object to the
870 new $schema object. If C<$additional_base_class> is given, the new composed
871 classes will inherit from first the corresponding class from the current
872 schema then the base class.
874 For example, for a schema with My::Schema::CD and My::Schema::Artist classes,
876 $schema->compose_namespace('My::DB', 'Base::Class');
877 print join (', ', @My::DB::CD::ISA) . "\n";
878 print join (', ', @My::DB::Artist::ISA) ."\n";
880 will produce the output
882 My::Schema::CD, Base::Class
883 My::Schema::Artist, Base::Class
887 # this might be oversimplified
888 # sub compose_namespace {
889 # my ($self, $target, $base) = @_;
891 # my $schema = $self->clone;
892 # foreach my $moniker ($schema->sources) {
893 # my $source = $schema->source($moniker);
894 # my $target_class = "${target}::${moniker}";
895 # $self->inject_base(
896 # $target_class => $source->result_class, ($base ? $base : ())
898 # $source->result_class($target_class);
899 # $target_class->result_source_instance($source)
900 # if $target_class->can('result_source_instance');
901 # $schema->register_source($moniker, $source);
906 sub compose_namespace {
907 my ($self, $target, $base) = @_;
908 my $schema = $self->clone;
910 no warnings qw/redefine/;
911 local *Class::C3::reinitialize = sub { } if DBIx::Class::_ENV_::OLD_MRO;
912 use warnings qw/redefine/;
915 foreach my $moniker ($schema->sources) {
916 my $source = $schema->source($moniker);
917 my $target_class = "${target}::${moniker}";
919 $target_class => $source->result_class, ($base ? $base : ())
921 $source->result_class($target_class);
922 if ($target_class->can('result_source_instance')) {
924 # since the newly created classes are registered only with
925 # the instance of $schema, it should be safe to weaken
926 # the ref (it will GC when $schema is destroyed)
927 $target_class->result_source_instance($source);
928 weaken ${"${target_class}::__cag_result_source_instance"};
930 $schema->register_source($moniker, $source);
933 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
936 no warnings 'redefine';
937 foreach my $meth (qw/class source resultset/) {
938 *{"${target}::${meth}"} = subname "${target}::${meth}" =>
939 sub { shift->schema->$meth(@_) };
945 sub setup_connection_class {
946 my ($class, $target, @info) = @_;
947 $class->inject_base($target => 'DBIx::Class::DB');
948 #$target->load_components('DB');
949 $target->connection(@info);
954 Creates a new savepoint (does nothing outside a transaction).
955 Equivalent to calling $schema->storage->svp_begin. See
956 L<DBIx::Class::Storage/"svp_begin"> for more information.
961 my ($self, $name) = @_;
963 $self->storage or $self->throw_exception
964 ('svp_begin called on $schema without storage');
966 $self->storage->svp_begin($name);
971 Releases a savepoint (does nothing outside a transaction).
972 Equivalent to calling $schema->storage->svp_release. See
973 L<DBIx::Class::Storage/"svp_release"> for more information.
978 my ($self, $name) = @_;
980 $self->storage or $self->throw_exception
981 ('svp_release called on $schema without storage');
983 $self->storage->svp_release($name);
988 Rollback to a savepoint (does nothing outside a transaction).
989 Equivalent to calling $schema->storage->svp_rollback. See
990 L<DBIx::Class::Storage/"svp_rollback"> for more information.
995 my ($self, $name) = @_;
997 $self->storage or $self->throw_exception
998 ('svp_rollback called on $schema without storage');
1000 $self->storage->svp_rollback($name);
1007 =item Return Value: $new_schema
1011 Clones the schema and its associated result_source objects and returns the
1018 my $clone = { (ref $self ? %$self : ()) };
1019 bless $clone, (ref $self || $self);
1021 $clone->class_mappings({ %{$clone->class_mappings} });
1022 $clone->source_registrations({ %{$clone->source_registrations} });
1023 foreach my $moniker ($self->sources) {
1024 my $source = $self->source($moniker);
1025 my $new = $source->new($source);
1026 # we use extra here as we want to leave the class_mappings as they are
1027 # but overwrite the source_registrations entry with the new source
1028 $clone->register_extra_source($moniker => $new);
1030 $clone->storage->set_schema($clone) if $clone->storage;
1034 =head2 throw_exception
1038 =item Arguments: $message
1042 Throws an exception. Defaults to using L<Carp::Clan> to report errors from
1043 user's perspective. See L</exception_action> for details on overriding
1044 this method's behavior. If L</stacktrace> is turned on, C<throw_exception>'s
1045 default behavior will provide a detailed stack trace.
1049 my $false_exception_action_warned;
1050 sub throw_exception {
1053 if (my $act = $self->exception_action) {
1055 DBIx::Class::Exception->throw(
1056 "Invocation of the exception_action handler installed on $self did *not*"
1057 .' result in an exception. DBIx::Class is unable to function without a reliable'
1058 .' exception mechanism, ensure that exception_action does not hide exceptions'
1059 ." (original error: $_[0])"
1062 elsif(! $false_exception_action_warned++) {
1064 "The exception_action handler installed on $self returned false instead"
1065 .' of throwing an exception. This behavior has been deprecated, adjust your'
1066 .' handler to always rethrow the supplied error.'
1071 DBIx::Class::Exception->throw($_[0], $self->stacktrace);
1078 =item Arguments: \%sqlt_args, $dir
1082 Attempts to deploy the schema to the current storage using L<SQL::Translator>.
1084 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
1085 The most common value for this would be C<< { add_drop_table => 1 } >>
1086 to have the SQL produced include a C<DROP TABLE> statement for each table
1087 created. For quoting purposes supply C<quote_table_names> and
1088 C<quote_field_names>.
1090 Additionally, the DBIx::Class parser accepts a C<sources> parameter as a hash
1091 ref or an array ref, containing a list of source to deploy. If present, then
1092 only the sources listed will get deployed. Furthermore, you can use the
1093 C<add_fk_index> parser parameter to prevent the parser from creating an index for each
1099 my ($self, $sqltargs, $dir) = @_;
1100 $self->throw_exception("Can't deploy without storage") unless $self->storage;
1101 $self->storage->deploy($self, undef, $sqltargs, $dir);
1104 =head2 deployment_statements
1108 =item Arguments: See L<DBIx::Class::Storage::DBI/deployment_statements>
1110 =item Return value: $listofstatements
1114 A convenient shortcut to
1115 C<< $self->storage->deployment_statements($self, @args) >>.
1116 Returns the SQL statements used by L</deploy> and
1117 L<DBIx::Class::Schema::Storage/deploy>.
1121 sub deployment_statements {
1124 $self->throw_exception("Can't generate deployment statements without a storage")
1125 if not $self->storage;
1127 $self->storage->deployment_statements($self, @_);
1130 =head2 create_ddl_dir
1134 =item Arguments: See L<DBIx::Class::Storage::DBI/create_ddl_dir>
1138 A convenient shortcut to
1139 C<< $self->storage->create_ddl_dir($self, @args) >>.
1141 Creates an SQL file based on the Schema, for each of the specified
1142 database types, in the given directory.
1146 sub create_ddl_dir {
1149 $self->throw_exception("Can't create_ddl_dir without storage") unless $self->storage;
1150 $self->storage->create_ddl_dir($self, @_);
1157 =item Arguments: $database-type, $version, $directory, $preversion
1159 =item Return value: $normalised_filename
1163 my $filename = $table->ddl_filename($type, $version, $dir, $preversion)
1165 This method is called by C<create_ddl_dir> to compose a file name out of
1166 the supplied directory, database type and version number. The default file
1167 name format is: C<$dir$schema-$version-$type.sql>.
1169 You may override this method in your schema if you wish to use a different
1174 Prior to DBIx::Class version 0.08100 this method had a different signature:
1176 my $filename = $table->ddl_filename($type, $dir, $version, $preversion)
1178 In recent versions variables $dir and $version were reversed in order to
1179 bring the signature in line with other Schema/Storage methods. If you
1180 really need to maintain backward compatibility, you can do the following
1181 in any overriding methods:
1183 ($dir, $version) = ($version, $dir) if ($DBIx::Class::VERSION < 0.08100);
1188 my ($self, $type, $version, $dir, $preversion) = @_;
1192 my $filename = ref($self);
1193 $filename =~ s/::/-/g;
1194 $filename = File::Spec->catfile($dir, "$filename-$version-$type.sql");
1195 $filename =~ s/$version/$preversion-$version/ if($preversion);
1202 Provided as the recommended way of thawing schema objects. You can call
1203 C<Storable::thaw> directly if you wish, but the thawed objects will not have a
1204 reference to any schema, so are rather useless.
1209 my ($self, $obj) = @_;
1210 local $DBIx::Class::ResultSourceHandle::thaw_schema = $self;
1212 return Storable::thaw($obj);
1217 This doesn't actually do anything more than call L<Storable/nfreeze>, it is just
1218 provided here for symmetry.
1224 return Storable::nfreeze($_[1]);
1231 =item Arguments: $object
1233 =item Return Value: dcloned $object
1237 Recommended way of dcloning L<DBIx::Class::Row> and L<DBIx::Class::ResultSet>
1238 objects so their references to the schema object
1239 (which itself is B<not> cloned) are properly maintained.
1244 my ($self, $obj) = @_;
1245 local $DBIx::Class::ResultSourceHandle::thaw_schema = $self;
1247 return Storable::dclone($obj);
1250 =head2 schema_version
1252 Returns the current schema class' $VERSION in a normalised way.
1256 sub schema_version {
1258 my $class = ref($self)||$self;
1260 # does -not- use $schema->VERSION
1261 # since that varies in results depending on if version.pm is installed, and if
1262 # so the perl or XS versions. If you want this to change, bug the version.pm
1263 # author to make vpp and vxs behave the same.
1268 $version = ${"${class}::VERSION"};
1274 =head2 register_class
1278 =item Arguments: $moniker, $component_class
1282 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.
1284 You will only need this method if you have your Result classes in
1285 files which are not named after the packages (or all in the same
1286 file). You may also need it to register classes at runtime.
1288 Registers a class which isa DBIx::Class::ResultSourceProxy. Equivalent to
1291 $schema->register_source($moniker, $component_class->result_source_instance);
1295 sub register_class {
1296 my ($self, $moniker, $to_register) = @_;
1297 $self->register_source($moniker => $to_register->result_source_instance);
1300 =head2 register_source
1304 =item Arguments: $moniker, $result_source
1308 This method is called by L</register_class>.
1310 Registers the L<DBIx::Class::ResultSource> in the schema with the given
1315 sub register_source {
1318 $self->_register_source(@_);
1321 =head2 unregister_source
1325 =item Arguments: $moniker
1329 Removes the L<DBIx::Class::ResultSource> from the schema for the given moniker.
1333 sub unregister_source {
1336 $self->_unregister_source(@_);
1339 =head2 register_extra_source
1343 =item Arguments: $moniker, $result_source
1347 As L</register_source> but should be used if the result class already
1348 has a source and you want to register an extra one.
1352 sub register_extra_source {
1355 $self->_register_source(@_, { extra => 1 });
1358 sub _register_source {
1359 my ($self, $moniker, $source, $params) = @_;
1361 my $orig_source = $source;
1363 $source = $source->new({ %$source, source_name => $moniker });
1364 $source->schema($self);
1365 weaken $source->{schema} if ref($self);
1367 my $rs_class = $source->result_class;
1369 my %reg = %{$self->source_registrations};
1370 $reg{$moniker} = $source;
1371 $self->source_registrations(\%reg);
1373 return if ($params->{extra});
1374 return unless defined($rs_class) && $rs_class->can('result_source_instance');
1376 my %map = %{$self->class_mappings};
1378 exists $map{$rs_class}
1380 $map{$rs_class} ne $moniker
1382 $rs_class->result_source_instance ne $orig_source
1384 carp "$rs_class already has a source, use register_extra_source for additional sources";
1386 $map{$rs_class} = $moniker;
1387 $self->class_mappings(\%map);
1391 my $global_phase_destroy;
1393 # SpeedyCGI runs END blocks every cycle but keeps object instances
1394 # hence we have to disable the globaldestroy hatch, and rely on the
1395 # eval trap below (which appears to work, but is risky done so late)
1396 END { $global_phase_destroy = 1 unless $CGI::SpeedyCGI::i_am_speedy }
1399 return if $global_phase_destroy;
1402 my $srcs = $self->source_registrations;
1404 for my $moniker (keys %$srcs) {
1405 # find first source that is not about to be GCed (someone other than $self
1406 # holds a reference to it) and reattach to it, weakening our own link
1408 # during global destruction (if we have not yet bailed out) this will throw
1409 # which will serve as a signal to not try doing anything else
1410 if (ref $srcs->{$moniker} and svref_2object($srcs->{$moniker})->REFCNT > 1) {
1413 $srcs->{$moniker}->schema($self);
1416 $global_phase_destroy = 1;
1420 weaken $srcs->{$moniker};
1427 sub _unregister_source {
1428 my ($self, $moniker) = @_;
1429 my %reg = %{$self->source_registrations};
1431 my $source = delete $reg{$moniker};
1432 $self->source_registrations(\%reg);
1433 if ($source->result_class) {
1434 my %map = %{$self->class_mappings};
1435 delete $map{$source->result_class};
1436 $self->class_mappings(\%map);
1441 =head2 compose_connection (DEPRECATED)
1445 =item Arguments: $target_namespace, @db_info
1447 =item Return Value: $new_schema
1451 DEPRECATED. You probably wanted compose_namespace.
1453 Actually, you probably just wanted to call connect.
1457 (hidden due to deprecation)
1459 Calls L<DBIx::Class::Schema/"compose_namespace"> to the target namespace,
1460 calls L<DBIx::Class::Schema/connection> with @db_info on the new schema,
1461 then injects the L<DBix::Class::ResultSetProxy> component and a
1462 resultset_instance classdata entry on all the new classes, in order to support
1463 $target_namespaces::$class->search(...) method calls.
1465 This is primarily useful when you have a specific need for class method access
1466 to a connection. In normal usage it is preferred to call
1467 L<DBIx::Class::Schema/connect> and use the resulting schema object to operate
1468 on L<DBIx::Class::ResultSet> objects with L<DBIx::Class::Schema/resultset> for
1478 sub compose_connection {
1479 my ($self, $target, @info) = @_;
1481 carp "compose_connection deprecated as of 0.08000"
1482 unless ($INC{"DBIx/Class/CDBICompat.pm"} || $warn++);
1484 my $base = 'DBIx::Class::ResultSetProxy';
1486 eval "require ${base};"
1489 $self->throw_exception
1490 ("No arguments to load_classes and couldn't load ${base} ($_)")
1493 if ($self eq $target) {
1494 # Pathological case, largely caused by the docs on early C::M::DBIC::Plain
1495 foreach my $moniker ($self->sources) {
1496 my $source = $self->source($moniker);
1497 my $class = $source->result_class;
1498 $self->inject_base($class, $base);
1499 $class->mk_classdata(resultset_instance => $source->resultset);
1500 $class->mk_classdata(class_resolver => $self);
1502 $self->connection(@info);
1506 my $schema = $self->compose_namespace($target, $base);
1509 my $name = join '::', $target, 'schema';
1510 *$name = subname $name, sub { $schema };
1513 $schema->connection(@info);
1514 foreach my $moniker ($schema->sources) {
1515 my $source = $schema->source($moniker);
1516 my $class = $source->result_class;
1517 #warn "$moniker $class $source ".$source->storage;
1518 $class->mk_classdata(result_source_instance => $source);
1519 $class->mk_classdata(resultset_instance => $source->resultset);
1520 $class->mk_classdata(class_resolver => $schema);
1530 Matt S. Trout <mst@shadowcatsystems.co.uk>
1534 You may distribute this code under the same terms as Perl itself.