X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema.pm;h=415fd79984ec2b4af0418b06d17498a1d7fd6801;hb=0c11ad0ee5c8407f6b87d6e15c62a1b445076dc0;hp=21f055b267b78a5a3d3599d9d388aaee6b97fea8;hpb=5b60f0c107afa5bfac568b691f663e2430df7618;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Schema.pm b/lib/DBIx/Class/Schema.pm index 21f055b..415fd79 100644 --- a/lib/DBIx/Class/Schema.pm +++ b/lib/DBIx/Class/Schema.pm @@ -4,10 +4,13 @@ use strict; use warnings; use DBIx::Class::Exception; -use Carp::Clan qw/^DBIx::Class/; -use Scalar::Util qw/weaken/; -use File::Spec; -require Module::Find; +use DBIx::Class::Carp; +use Try::Tiny; +use Scalar::Util qw/weaken blessed/; +use Sub::Name 'subname'; +use B 'svref_2object'; +use Devel::GlobalDestruction; +use namespace::clean; use base qw/DBIx::Class/; @@ -28,12 +31,13 @@ DBIx::Class::Schema - composable schemas package Library::Schema; use base qw/DBIx::Class::Schema/; - # load Library::Schema::CD, Library::Schema::Book, Library::Schema::DVD - __PACKAGE__->load_classes(qw/CD Book DVD/); + # load all Result classes in Library/Schema/Result/ + __PACKAGE__->load_namespaces(); - package Library::Schema::CD; - use base qw/DBIx::Class/; - __PACKAGE__->load_components(qw/PK::Auto Core/); # for example + package Library::Schema::Result::CD; + use base qw/DBIx::Class::Core/; + + __PACKAGE__->load_components(qw/InflateColumn::DateTime/); # for example __PACKAGE__->table('cd'); # Elsewhere in your code: @@ -41,12 +45,12 @@ DBIx::Class::Schema - composable schemas $dsn, $user, $password, - { AutoCommit => 0 }, + { AutoCommit => 1 }, ); my $schema2 = Library::Schema->connect($coderef_returning_dbh); - # fetch objects using Library::Schema::DVD + # fetch objects using Library::Schema::Result::DVD my $resultset = $schema1->resultset('DVD')->search( ... ); my @dvd_objects = $schema2->resultset('DVD')->search( ... ); @@ -60,187 +64,237 @@ NB: If you're used to L it's worth reading the L carefully, as DBIx::Class does things a little differently. Note in particular which module inherits off which. -=head1 METHODS - -=head2 schema_version - -Returns the current schema class' $VERSION - -=cut - -sub schema_version { - my ($self) = @_; - my $class = ref($self)||$self; - - # does -not- use $schema->VERSION - # since that varies in results depending on if version.pm is installed, and if - # so the perl or XS versions. If you want this to change, bug the version.pm - # author to make vpp and vxs behave the same. - - my $version; - { - no strict 'refs'; - $version = ${"${class}::VERSION"}; - } - return $version; -} +=head1 SETUP METHODS -=head2 register_class +=head2 load_namespaces =over 4 -=item Arguments: $moniker, $component_class +=item Arguments: %options? =back -Registers a class which isa DBIx::Class::ResultSourceProxy. Equivalent to -calling: - - $schema->register_source($moniker, $component_class->result_source_instance); - -=cut - -sub register_class { - my ($self, $moniker, $to_register) = @_; - $self->register_source($moniker => $to_register->result_source_instance); -} - -=head2 register_source - -=over 4 - -=item Arguments: $moniker, $result_source + __PACKAGE__->load_namespaces(); -=back + __PACKAGE__->load_namespaces( + result_namespace => 'Res', + resultset_namespace => 'RSet', + default_resultset_class => '+MyDB::Othernamespace::RSet', + ); -Registers the L in the schema with the given -moniker. +With no arguments, this method uses L to load all of the +Result and ResultSet classes under the namespace of the schema from +which it is called. For example, C will by default find +and load Result classes named C and ResultSet +classes named C. -=cut +ResultSet classes are associated with Result class of the same name. +For example, C will get the ResultSet class +C if it is present. -sub register_source { - my ($self, $moniker, $source) = @_; +Both Result and ResultSet namespaces are configurable via the +C and C options. - %$source = %{ $source->new( { %$source, source_name => $moniker }) }; +Another option, C specifies a custom default +ResultSet class for Result classes with no corresponding ResultSet. - my %reg = %{$self->source_registrations}; - $reg{$moniker} = $source; - $self->source_registrations(\%reg); +All of the namespace and classname options are by default relative to +the schema classname. To specify a fully-qualified name, prefix it +with a literal C<+>. For example, C<+Other::NameSpace::Result>. - $source->schema($self); +=head3 Warnings - weaken($source->{schema}) if ref($self); - if ($source->result_class) { - my %map = %{$self->class_mappings}; - $map{$source->result_class} = $moniker; - $self->class_mappings(\%map); - } -} +You will be warned if ResultSet classes are discovered for which there +are no matching Result classes like this: -sub _unregister_source { - my ($self, $moniker) = @_; - my %reg = %{$self->source_registrations}; + load_namespaces found ResultSet class $classname with no corresponding Result class - my $source = delete $reg{$moniker}; - $self->source_registrations(\%reg); - if ($source->result_class) { - my %map = %{$self->class_mappings}; - delete $map{$source->result_class}; - $self->class_mappings(\%map); - } -} +If a Result class is found to already have a ResultSet class set using +L to some other class, you will be warned like this: -=head2 class + We found ResultSet class '$rs_class' for '$result', but it seems + that you had already set '$result' to use '$rs_set' instead -=over 4 +=head3 Examples -=item Arguments: $moniker + # load My::Schema::Result::CD, My::Schema::Result::Artist, + # My::Schema::ResultSet::CD, etc... + My::Schema->load_namespaces; -=item Return Value: $classname + # Override everything to use ugly names. + # In this example, if there is a My::Schema::Res::Foo, but no matching + # My::Schema::RSets::Foo, then Foo will have its + # resultset_class set to My::Schema::RSetBase + My::Schema->load_namespaces( + result_namespace => 'Res', + resultset_namespace => 'RSets', + default_resultset_class => 'RSetBase', + ); -=back + # Put things in other namespaces + My::Schema->load_namespaces( + result_namespace => '+Some::Place::Results', + resultset_namespace => '+Another::Place::RSets', + ); -Retrieves the result class name for the given moniker. For example: +To search multiple namespaces for either Result or ResultSet classes, +use an arrayref of namespaces for that option. In the case that the +same result (or resultset) class exists in multiple namespaces, later +entries in the list of namespaces will override earlier ones. - my $class = $schema->class('CD'); + My::Schema->load_namespaces( + # My::Schema::Results_C::Foo takes precedence over My::Schema::Results_B::Foo : + result_namespace => [ 'Results_A', 'Results_B', 'Results_C' ], + resultset_namespace => [ '+Some::Place::RSets', 'RSets' ], + ); =cut -sub class { - my ($self, $moniker) = @_; - return $self->source($moniker)->result_class; +# Pre-pends our classname to the given relative classname or +# class namespace, unless there is a '+' prefix, which will +# be stripped. +sub _expand_relative_name { + my ($class, $name) = @_; + return if !$name; + $name = $class . '::' . $name if ! ($name =~ s/^\+//); + return $name; } -=head2 source +# Finds all modules in the supplied namespace, or if omitted in the +# namespace of $class. Untaints all findings as they can be assumed +# to be safe +sub _findallmod { + my $proto = shift; + my $ns = shift || ref $proto || $proto; -=over 4 + require Module::Find; -=item Arguments: $moniker + # untaint result + return map { $_ =~ /(.+)/ } Module::Find::findallmod($ns); +} -=item Return Value: $result_source +# returns a hash of $shortname => $fullname for every package +# found in the given namespaces ($shortname is with the $fullname's +# namespace stripped off) +sub _map_namespaces { + my ($class, @namespaces) = @_; -=back + my @results_hash; + foreach my $namespace (@namespaces) { + push( + @results_hash, + map { (substr($_, length "${namespace}::"), $_) } + $class->_findallmod($namespace) + ); + } - my $source = $schema->source('Book'); + @results_hash; +} + +# returns the result_source_instance for the passed class/object, +# or dies with an informative message (used by load_namespaces) +sub _ns_get_rsrc_instance { + my $me = shift; + my $rs_class = ref ($_[0]) || $_[0]; + + return try { + $rs_class->result_source_instance + } catch { + $me->throw_exception ( + "Attempt to load_namespaces() class $rs_class failed - are you sure this is a real Result Class?: $_" + ); + }; +} -Returns the L object for the registered moniker. +sub load_namespaces { + my ($class, %args) = @_; -=cut + my $result_namespace = delete $args{result_namespace} || 'Result'; + my $resultset_namespace = delete $args{resultset_namespace} || 'ResultSet'; + my $default_resultset_class = delete $args{default_resultset_class}; -sub source { - my ($self, $moniker) = @_; - my $sreg = $self->source_registrations; - return $sreg->{$moniker} if exists $sreg->{$moniker}; + $class->throw_exception('load_namespaces: unknown option(s): ' + . join(q{,}, map { qq{'$_'} } keys %args)) + if scalar keys %args; - # if we got here, they probably passed a full class name - my $mapped = $self->class_mappings->{$moniker}; - $self->throw_exception("Can't find source for ${moniker}") - unless $mapped && exists $sreg->{$mapped}; - return $sreg->{$mapped}; -} + $default_resultset_class + = $class->_expand_relative_name($default_resultset_class); -=head2 sources + for my $arg ($result_namespace, $resultset_namespace) { + $arg = [ $arg ] if !ref($arg) && $arg; -=over 4 + $class->throw_exception('load_namespaces: namespace arguments must be ' + . 'a simple string or an arrayref') + if ref($arg) ne 'ARRAY'; -=item Return Value: @source_monikers + $_ = $class->_expand_relative_name($_) for (@$arg); + } -=back + my %results = $class->_map_namespaces(@$result_namespace); + my %resultsets = $class->_map_namespaces(@$resultset_namespace); -Returns the source monikers of all source registrations on this schema. -For example: + my @to_register; + { + no warnings qw/redefine/; + local *Class::C3::reinitialize = sub { } if DBIx::Class::_ENV_::OLD_MRO; + use warnings qw/redefine/; - my @source_monikers = $schema->sources; + # ensure classes are loaded and attached in inheritance order + for my $res (values %results) { + $class->ensure_class_loaded($res); + } + my %inh_idx; + my @subclass_last = sort { -=cut + ($inh_idx{$a} ||= + scalar @{mro::get_linear_isa( $results{$a} )} + ) -sub sources { return keys %{shift->source_registrations}; } + <=> -=head2 storage + ($inh_idx{$b} ||= + scalar @{mro::get_linear_isa( $results{$b} )} + ) - my $storage = $schema->storage; + } keys(%results); -Returns the L object for this Schema. + foreach my $result (@subclass_last) { + my $result_class = $results{$result}; -=head2 resultset + my $rs_class = delete $resultsets{$result}; + my $rs_set = $class->_ns_get_rsrc_instance ($result_class)->resultset_class; -=over 4 + if($rs_set && $rs_set ne 'DBIx::Class::ResultSet') { + if($rs_class && $rs_class ne $rs_set) { + carp "We found ResultSet class '$rs_class' for '$result', but it seems " + . "that you had already set '$result' to use '$rs_set' instead"; + } + } + elsif($rs_class ||= $default_resultset_class) { + $class->ensure_class_loaded($rs_class); + if(!$rs_class->isa("DBIx::Class::ResultSet")) { + carp "load_namespaces found ResultSet class $rs_class that does not subclass DBIx::Class::ResultSet"; + } -=item Arguments: $moniker + $class->_ns_get_rsrc_instance ($result_class)->resultset_class($rs_class); + } -=item Return Value: $result_set + my $source_name = $class->_ns_get_rsrc_instance ($result_class)->source_name || $result; -=back + push(@to_register, [ $source_name, $result_class ]); + } + } - my $rs = $schema->resultset('DVD'); + foreach (sort keys %resultsets) { + carp "load_namespaces found ResultSet class $_ with no " + . 'corresponding Result class'; + } -Returns the L object for the registered moniker. + Class::C3->reinitialize if DBIx::Class::_ENV_::OLD_MRO; -=cut + $class->register_class(@$_) for (@to_register); -sub resultset { - my ($self, $moniker) = @_; - return $self->source($moniker)->resultset; + return; } =head2 load_classes @@ -251,6 +305,11 @@ sub resultset { =back +L is an alternative method to L, both of +which serve similar purposes, each with different advantages and disadvantages. +In the general case you should use L, unless you need to +be able to specify that only specific classes are loaded at runtime. + With no arguments, this method uses L to find all classes under the schema's namespace. Otherwise, this method loads the classes you specify (using L), and registers them (using L). @@ -259,6 +318,13 @@ It is possible to comment out classes with a leading C<#>, but note that perl will think it's a mistake (trying to use a comment in a qw list), so you'll need to add C before your load_classes call. +If any classes found do not appear to be Result class files, you will +get the following warning: + + 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. + Example: My::Schema->load_classes(); # loads My::Schema::CD, My::Schema::Artist, @@ -301,420 +367,260 @@ sub load_classes { } } else { my @comp = map { substr $_, length "${class}::" } - Module::Find::findallmod($class); + $class->_findallmod; $comps_for{$class} = \@comp; } my @to_register; { no warnings qw/redefine/; - local *Class::C3::reinitialize = sub { }; + local *Class::C3::reinitialize = sub { } if DBIx::Class::_ENV_::OLD_MRO; + use warnings qw/redefine/; + foreach my $prefix (keys %comps_for) { foreach my $comp (@{$comps_for{$prefix}||[]}) { my $comp_class = "${prefix}::${comp}"; - { # try to untaint module name. mods where this fails - # are left alone so we don't have to change the old behavior - no locale; # localized \w doesn't untaint expression - if ( $comp_class =~ m/^( (?:\w+::)* \w+ )$/x ) { - $comp_class = $1; - } - } $class->ensure_class_loaded($comp_class); - $comp = $comp_class->source_name || $comp; -# $DB::single = 1; + my $snsub = $comp_class->can('source_name'); + if(! $snsub ) { + 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."; + next; + } + $comp = $snsub->($comp_class) || $comp; + push(@to_register, [ $comp, $comp_class ]); } } } - Class::C3->reinitialize; + Class::C3->reinitialize if DBIx::Class::_ENV_::OLD_MRO; foreach my $to (@to_register) { $class->register_class(@$to); - # if $class->can('result_source_instance'); } } -=head2 load_namespaces +=head2 storage_type =over 4 -=item Arguments: %options? +=item Arguments: $storage_type|{$storage_type, \%args} -=back +=item Return value: $storage_type|{$storage_type, \%args} -This is an alternative to L above which assumes an alternative -layout for automatic class loading. It assumes that all result -classes are underneath a sub-namespace of the schema called C, any -corresponding ResultSet classes are underneath a sub-namespace of the schema -called C. +=item Default value: DBIx::Class::Storage::DBI -Both of the sub-namespaces are configurable if you don't like the defaults, -via the options C and C. +=back -If (and only if) you specify the option C, any found -Result classes for which we do not find a corresponding -ResultSet class will have their C set to -C. +Set the storage class that will be instantiated when L is called. +If the classname starts with C<::>, the prefix C is +assumed by L. -C takes care of calling C for you where -neccessary if you didn't do it for yourself. +You want to use this to set subclasses of L +in cases where the appropriate subclass is not autodetected. -All of the namespace and classname options to this method are relative to -the schema classname by default. To specify a fully-qualified name, prefix -it with a literal C<+>. +If your storage type requires instantiation arguments, those are +defined as a second argument in the form of a hashref and the entire +value needs to be wrapped into an arrayref or a hashref. We support +both types of refs here in order to play nice with your +Config::[class] or your choice. See +L for an example of this. -Examples: +=head2 exception_action - # load My::Schema::Result::CD, My::Schema::Result::Artist, - # My::Schema::ResultSet::CD, etc... - My::Schema->load_namespaces; +=over 4 - # Override everything to use ugly names. - # In this example, if there is a My::Schema::Res::Foo, but no matching - # My::Schema::RSets::Foo, then Foo will have its - # resultset_class set to My::Schema::RSetBase - My::Schema->load_namespaces( - result_namespace => 'Res', - resultset_namespace => 'RSets', - default_resultset_class => 'RSetBase', - ); +=item Arguments: $code_reference - # Put things in other namespaces - My::Schema->load_namespaces( - result_namespace => '+Some::Place::Results', - resultset_namespace => '+Another::Place::RSets', - ); +=item Return value: $code_reference -If you'd like to use multiple namespaces of each type, simply use an arrayref -of namespaces for that option. In the case that the same result -(or resultset) class exists in multiple namespaces, the latter entries in -your list of namespaces will override earlier ones. +=item Default value: None - My::Schema->load_namespaces( - # My::Schema::Results_C::Foo takes precedence over My::Schema::Results_B::Foo : - result_namespace => [ 'Results_A', 'Results_B', 'Results_C' ], - resultset_namespace => [ '+Some::Place::RSets', 'RSets' ], - ); +=back -=cut +When L is invoked and L is set to a code +reference, this reference will be called instead of +L, with the exception message passed as the only +argument. -# Pre-pends our classname to the given relative classname or -# class namespace, unless there is a '+' prefix, which will -# be stripped. -sub _expand_relative_name { - my ($class, $name) = @_; - return if !$name; - $name = $class . '::' . $name if ! ($name =~ s/^\+//); - return $name; -} +Your custom throw code B rethrow the exception, as L is +an integral part of DBIC's internal execution control flow. -# returns a hash of $shortname => $fullname for every package -# found in the given namespaces ($shortname is with the $fullname's -# namespace stripped off) -sub _map_namespaces { - my ($class, @namespaces) = @_; +Example: - my @results_hash; - foreach my $namespace (@namespaces) { - push( - @results_hash, - map { (substr($_, length "${namespace}::"), $_) } - Module::Find::findallmod($namespace) - ); - } - - @results_hash; -} - -sub load_namespaces { - my ($class, %args) = @_; + package My::Schema; + use base qw/DBIx::Class::Schema/; + use My::ExceptionClass; + __PACKAGE__->exception_action(sub { My::ExceptionClass->throw(@_) }); + __PACKAGE__->load_classes; - my $result_namespace = delete $args{result_namespace} || 'Result'; - my $resultset_namespace = delete $args{resultset_namespace} || 'ResultSet'; - my $default_resultset_class = delete $args{default_resultset_class}; + # or: + my $schema_obj = My::Schema->connect( .... ); + $schema_obj->exception_action(sub { My::ExceptionClass->throw(@_) }); - $class->throw_exception('load_namespaces: unknown option(s): ' - . join(q{,}, map { qq{'$_'} } keys %args)) - if scalar keys %args; +=head2 stacktrace - $default_resultset_class - = $class->_expand_relative_name($default_resultset_class); +=over 4 - for my $arg ($result_namespace, $resultset_namespace) { - $arg = [ $arg ] if !ref($arg) && $arg; +=item Arguments: boolean - $class->throw_exception('load_namespaces: namespace arguments must be ' - . 'a simple string or an arrayref') - if ref($arg) ne 'ARRAY'; +=back - $_ = $class->_expand_relative_name($_) for (@$arg); - } +Whether L should include stack trace information. +Defaults to false normally, but defaults to true if C<$ENV{DBIC_TRACE}> +is true. - my %results = $class->_map_namespaces(@$result_namespace); - my %resultsets = $class->_map_namespaces(@$resultset_namespace); +=head2 sqlt_deploy_hook - my @to_register; - { - no warnings 'redefine'; - local *Class::C3::reinitialize = sub { }; - use warnings 'redefine'; +=over - foreach my $result (keys %results) { - my $result_class = $results{$result}; - $class->ensure_class_loaded($result_class); - $result_class->source_name($result) unless $result_class->source_name; +=item Arguments: $sqlt_schema - my $rs_class = delete $resultsets{$result}; - my $rs_set = $result_class->resultset_class; - if($rs_set && $rs_set ne 'DBIx::Class::ResultSet') { - if($rs_class && $rs_class ne $rs_set) { - warn "We found ResultSet class '$rs_class' for '$result', but it seems " - . "that you had already set '$result' to use '$rs_set' instead"; - } - } - elsif($rs_class ||= $default_resultset_class) { - $class->ensure_class_loaded($rs_class); - $result_class->resultset_class($rs_class); - } +=back - push(@to_register, [ $result_class->source_name, $result_class ]); - } - } +An optional sub which you can declare in your own Schema class that will get +passed the L object when you deploy the schema via +L or L. - foreach (sort keys %resultsets) { - warn "load_namespaces found ResultSet class $_ with no " - . 'corresponding Result class'; - } +For an example of what you can do with this, see +L. - Class::C3->reinitialize; - $class->register_class(@$_) for (@to_register); +Note that sqlt_deploy_hook is called by L, which in turn +is called before L. Therefore the hook can be used only to manipulate +the L object before it is turned into SQL fed to the +database. If you want to execute post-deploy statements which can not be generated +by L, the currently suggested method is to overload L +and use L. - return; -} +=head1 METHODS -=head2 compose_connection (DEPRECATED) +=head2 connect =over 4 -=item Arguments: $target_namespace, @db_info +=item Arguments: @connectinfo =item Return Value: $new_schema =back -DEPRECATED. You probably wanted compose_namespace. - -Actually, you probably just wanted to call connect. - -=begin hidden +Creates and returns a new Schema object. The connection info set on it +is used to create a new instance of the storage backend and set it on +the Schema object. -(hidden due to deprecation) +See L for DBI-specific +syntax on the C<@connectinfo> argument, or L in +general. -Calls L to the target namespace, -calls L with @db_info on the new schema, -then injects the L component and a -resultset_instance classdata entry on all the new classes, in order to support -$target_namespaces::$class->search(...) method calls. +Note that C expects an arrayref of arguments, but +C does not. C wraps its arguments in an arrayref +before passing them to C. -This is primarily useful when you have a specific need for class method access -to a connection. In normal usage it is preferred to call -L and use the resulting schema object to operate -on L objects with L for -more information. +=head3 Overloading -=end hidden +C is a convenience method. It is equivalent to calling +$schema->clone->connection(@connectinfo). To write your own overloaded +version, overload L instead. =cut -{ - my $warn; - - sub compose_connection { - my ($self, $target, @info) = @_; - - warn "compose_connection deprecated as of 0.08000" - unless ($INC{"DBIx/Class/CDBICompat.pm"} || $warn++); - - my $base = 'DBIx::Class::ResultSetProxy'; - eval "require ${base};"; - $self->throw_exception - ("No arguments to load_classes and couldn't load ${base} ($@)") - if $@; - - if ($self eq $target) { - # Pathological case, largely caused by the docs on early C::M::DBIC::Plain - foreach my $moniker ($self->sources) { - my $source = $self->source($moniker); - my $class = $source->result_class; - $self->inject_base($class, $base); - $class->mk_classdata(resultset_instance => $source->resultset); - $class->mk_classdata(class_resolver => $self); - } - $self->connection(@info); - return $self; - } - - my $schema = $self->compose_namespace($target, $base); - { - no strict 'refs'; - *{"${target}::schema"} = sub { $schema }; - } - - $schema->connection(@info); - foreach my $moniker ($schema->sources) { - my $source = $schema->source($moniker); - my $class = $source->result_class; - #warn "$moniker $class $source ".$source->storage; - $class->mk_classdata(result_source_instance => $source); - $class->mk_classdata(resultset_instance => $source->resultset); - $class->mk_classdata(class_resolver => $schema); - } - return $schema; - } -} +sub connect { shift->clone->connection(@_) } -=head2 compose_namespace +=head2 resultset =over 4 -=item Arguments: $target_namespace, $additional_base_class? +=item Arguments: $source_name -=item Return Value: $new_schema +=item Return Value: $resultset =back -For each L in the schema, this method creates a -class in the target namespace (e.g. $target_namespace::CD, -$target_namespace::Artist) that inherits from the corresponding classes -attached to the current schema. - -It also attaches a corresponding L object to the -new $schema object. If C<$additional_base_class> is given, the new composed -classes will inherit from first the corresponding classe from the current -schema then the base class. - -For example, for a schema with My::Schema::CD and My::Schema::Artist classes, - - $schema->compose_namespace('My::DB', 'Base::Class'); - print join (', ', @My::DB::CD::ISA) . "\n"; - print join (', ', @My::DB::Artist::ISA) ."\n"; - -will produce the output + my $rs = $schema->resultset('DVD'); - My::Schema::CD, Base::Class - My::Schema::Artist, Base::Class +Returns the L object for the registered source +name. =cut -sub compose_namespace { - my ($self, $target, $base) = @_; - my $schema = $self->clone; - { - no warnings qw/redefine/; - local *Class::C3::reinitialize = sub { }; - foreach my $moniker ($schema->sources) { - my $source = $schema->source($moniker); - my $target_class = "${target}::${moniker}"; - $self->inject_base( - $target_class => $source->result_class, ($base ? $base : ()) - ); - $source->result_class($target_class); - $target_class->result_source_instance($source) - if $target_class->can('result_source_instance'); - } - } - Class::C3->reinitialize(); - { - no strict 'refs'; - no warnings 'redefine'; - foreach my $meth (qw/class source resultset/) { - *{"${target}::${meth}"} = - sub { shift->schema->$meth(@_) }; - } - } - return $schema; -} - -sub setup_connection_class { - my ($class, $target, @info) = @_; - $class->inject_base($target => 'DBIx::Class::DB'); - #$target->load_components('DB'); - $target->connection(@info); +sub resultset { + my ($self, $moniker) = @_; + $self->throw_exception('resultset() expects a source name') + unless defined $moniker; + return $self->source($moniker)->resultset; } -=head2 storage_type +=head2 sources =over 4 -=item Arguments: $storage_type - -=item Return Value: $storage_type +=item Return Value: @source_names =back -Set the storage class that will be instantiated when L is called. -If the classname starts with C<::>, the prefix C is -assumed by L. Defaults to C<::DBI>, -which is L. + my @source_names = $schema->sources; -You want to use this to hardcoded subclasses of L -in cases where the appropriate subclass is not autodetected, such as when -dealing with MSSQL via L, in which case you'd set it to -C<::DBI::Sybase::MSSQL>. +Lists names of all the sources registered on this Schema object. -=head2 connection +=cut + +sub sources { return keys %{shift->source_registrations}; } + +=head2 source =over 4 -=item Arguments: @args +=item Arguments: $source_name -=item Return Value: $new_schema +=item Return Value: $result_source =back -Instantiates a new Storage object of type -L and passes the arguments to -$storage->connect_info. Sets the connection in-place on the schema. + my $source = $schema->source('Book'); -See L for DBI-specific syntax, -or L in general. +Returns the L object for the registered +source name. =cut -sub connection { - my ($self, @info) = @_; - return $self if !@info && $self->storage; - my $storage_class = $self->storage_type; - $storage_class = 'DBIx::Class::Storage'.$storage_class - if $storage_class =~ m/^::/; - eval "require ${storage_class};"; - $self->throw_exception( - "No arguments to load_classes and couldn't load ${storage_class} ($@)" - ) if $@; - my $storage = $storage_class->new($self); - $storage->connect_info(\@info); - $self->storage($storage); - return $self; +sub source { + my $self = shift; + + $self->throw_exception("source() expects a source name") + unless @_; + + my $moniker = shift; + + my $sreg = $self->source_registrations; + return $sreg->{$moniker} if exists $sreg->{$moniker}; + + # if we got here, they probably passed a full class name + my $mapped = $self->class_mappings->{$moniker}; + $self->throw_exception("Can't find source for ${moniker}") + unless $mapped && exists $sreg->{$mapped}; + return $sreg->{$mapped}; } -=head2 connect +=head2 class =over 4 -=item Arguments: @info +=item Arguments: $source_name -=item Return Value: $new_schema +=item Return Value: $classname =back -This is a convenience method. It is equivalent to calling -$schema->clone->connection(@info). See L and L for more -information. + my $class = $schema->class('CD'); + +Retrieves the Result class name for the given source name. =cut -sub connect { shift->clone->connection(@_) } +sub class { + my ($self, $moniker) = @_; + return $self->source($moniker)->result_class; +} =head2 txn_do @@ -733,6 +639,14 @@ See L for more information. This interface is preferred over using the individual methods L, L, and L below. +WARNING: If you are connected with C<< AutoCommit => 0 >> the transaction is +considered nested, and you will still need to call L to write your +changes when appropriate. You will also want to connect with C<< auto_savepoint => +1 >> to get partial rollback to work, if the storage driver for your database +supports it. + +Connecting with C<< AutoCommit => 1 >> is recommended. + =cut sub txn_do { @@ -746,7 +660,8 @@ sub txn_do { =head2 txn_scope_guard -Runs C on the schema's storage. +Runs C on the schema's storage. See +L. =cut @@ -763,7 +678,7 @@ sub txn_scope_guard { Begins a transaction (does nothing if AutoCommit is off). Equivalent to calling $schema->storage->txn_begin. See -L for more information. +L for more information. =cut @@ -779,7 +694,7 @@ sub txn_begin { =head2 txn_commit Commits the current transaction. Equivalent to calling -$schema->storage->txn_commit. See L +$schema->storage->txn_commit. See L for more information. =cut @@ -797,7 +712,7 @@ sub txn_commit { Rolls back the current transaction. Equivalent to calling $schema->storage->txn_rollback. See -L for more information. +L for more information. =cut @@ -810,195 +725,341 @@ sub txn_rollback { $self->storage->txn_rollback; } -=head2 svp_begin - -Creates a new savepoint (does nothing outside a transaction). -Equivalent to calling $schema->storage->svp_begin. See -L for more information. +=head2 storage -=cut + my $storage = $schema->storage; -sub svp_begin { - my ($self, $name) = @_; +Returns the L object for this Schema. Grab this +if you want to turn on SQL statement debugging at runtime, or set the +quote character. For the default storage, the documentation can be +found in L. - $self->storage or $self->throw_exception - ('svp_begin called on $schema without storage'); +=head2 populate - $self->storage->svp_begin($name); -} +=over 4 -=head2 svp_release +=item Arguments: $source_name, \@data; -Releases a savepoint (does nothing outside a transaction). -Equivalent to calling $schema->storage->svp_release. See -L for more information. +=item Return value: \@$objects | nothing -=cut +=back -sub svp_release { - my ($self, $name) = @_; +Pass this method a resultsource name, and an arrayref of +arrayrefs. The arrayrefs should contain a list of column names, +followed by one or many sets of matching data for the given columns. - $self->storage or $self->throw_exception - ('svp_release called on $schema without storage'); +In void context, C in L is used +to insert the data, as this is a fast method. However, insert_bulk currently +assumes that your datasets all contain the same type of values, using scalar +references in a column in one row, and not in another will probably not work. - $self->storage->svp_release($name); -} +Otherwise, each set of data is inserted into the database using +L, and a arrayref of the resulting row +objects is returned. -=head2 svp_rollback +e.g. -Rollback to a savepoint (does nothing outside a transaction). -Equivalent to calling $schema->storage->svp_rollback. See -L for more information. + $schema->populate('Artist', [ + [ qw/artistid name/ ], + [ 1, 'Popular Band' ], + [ 2, 'Indie Band' ], + ... + ]); -=cut +Since wantarray context is basically the same as looping over $rs->create(...) +you won't see any performance benefits and in this case the method is more for +convenience. Void context sends the column information directly to storage +using s bulk insert method. So the performance will be much better for +storages that support this method. -sub svp_rollback { - my ($self, $name) = @_; +Because of this difference in the way void context inserts rows into your +database you need to note how this will effect any loaded components that +override or augment insert. For example if you are using a component such +as L to populate your primary keys you MUST use +wantarray context if you want the PKs automatically created. - $self->storage or $self->throw_exception - ('svp_rollback called on $schema without storage'); +=cut - $self->storage->svp_rollback($name); +sub populate { + my ($self, $name, $data) = @_; + if(my $rs = $self->resultset($name)) { + if(defined wantarray) { + return $rs->populate($data); + } else { + $rs->populate($data); + } + } else { + $self->throw_exception("$name is not a resultset"); + } } -=head2 clone +=head2 connection =over 4 +=item Arguments: @args + =item Return Value: $new_schema =back -Clones the schema and its associated result_source objects and returns the -copy. +Similar to L except sets the storage object and connection +data in-place on the Schema class. You should probably be calling +L to get a proper Schema object instead. + +=head3 Overloading + +Overload C to change the behaviour of C. =cut -sub clone { - my ($self) = @_; - my $clone = { (ref $self ? %$self : ()) }; - bless $clone, (ref $self || $self); +sub connection { + my ($self, @info) = @_; + return $self if !@info && $self->storage; - foreach my $moniker ($self->sources) { - my $source = $self->source($moniker); - my $new = $source->new($source); - $clone->register_source($moniker => $new); + my ($storage_class, $args) = ref $self->storage_type ? + ($self->_normalize_storage_type($self->storage_type),{}) : ($self->storage_type, {}); + + $storage_class = 'DBIx::Class::Storage'.$storage_class + if $storage_class =~ m/^::/; + try { + $self->ensure_class_loaded ($storage_class); } - $clone->storage->set_schema($clone) if $clone->storage; - return $clone; + catch { + $self->throw_exception( + "Unable to load storage class ${storage_class}: $_" + ); + }; + my $storage = $storage_class->new($self=>$args); + $storage->connect_info(\@info); + $self->storage($storage); + return $self; } -=head2 populate +sub _normalize_storage_type { + my ($self, $storage_type) = @_; + if(ref $storage_type eq 'ARRAY') { + return @$storage_type; + } elsif(ref $storage_type eq 'HASH') { + return %$storage_type; + } else { + $self->throw_exception('Unsupported REFTYPE given: '. ref $storage_type); + } +} + +=head2 compose_namespace =over 4 -=item Arguments: $source_name, \@data; +=item Arguments: $target_namespace, $additional_base_class? + +=item Retur Value: $new_schema =back -Pass this method a resultsource name, and an arrayref of -arrayrefs. The arrayrefs should contain a list of column names, -followed by one or many sets of matching data for the given columns. +For each L in the schema, this method creates a +class in the target namespace (e.g. $target_namespace::CD, +$target_namespace::Artist) that inherits from the corresponding classes +attached to the current schema. -In void context, C in L is used -to insert the data, as this is a fast method. However, insert_bulk currently -assumes that your datasets all contain the same type of values, using scalar -references in a column in one row, and not in another will probably not work. +It also attaches a corresponding L object to the +new $schema object. If C<$additional_base_class> is given, the new composed +classes will inherit from first the corresponding class from the current +schema then the base class. -Otherwise, each set of data is inserted into the database using -L, and a arrayref of the resulting row -objects is returned. +For example, for a schema with My::Schema::CD and My::Schema::Artist classes, -i.e., + $schema->compose_namespace('My::DB', 'Base::Class'); + print join (', ', @My::DB::CD::ISA) . "\n"; + print join (', ', @My::DB::Artist::ISA) ."\n"; - $schema->populate('Artist', [ - [ qw/artistid name/ ], - [ 1, 'Popular Band' ], - [ 2, 'Indie Band' ], - ... - ]); - -Since wantarray context is basically the same as looping over $rs->create(...) -you won't see any performance benefits and in this case the method is more for -convenience. Void context sends the column information directly to storage -using s bulk insert method. So the performance will be much better for -storages that support this method. +will produce the output -Because of this difference in the way void context inserts rows into your -database you need to note how this will effect any loaded components that -override or augment insert. For example if you are using a component such -as L to populate your primary keys you MUST use -wantarray context if you want the PKs automatically created. + My::Schema::CD, Base::Class + My::Schema::Artist, Base::Class =cut -sub populate { - my ($self, $name, $data) = @_; - my $rs = $self->resultset($name); - my @names = @{shift(@$data)}; - if(defined wantarray) { - my @created; - foreach my $item (@$data) { - my %create; - @create{@names} = @$item; - push(@created, $rs->create(\%create)); +# this might be oversimplified +# sub compose_namespace { +# my ($self, $target, $base) = @_; + +# my $schema = $self->clone; +# foreach my $moniker ($schema->sources) { +# my $source = $schema->source($moniker); +# my $target_class = "${target}::${moniker}"; +# $self->inject_base( +# $target_class => $source->result_class, ($base ? $base : ()) +# ); +# $source->result_class($target_class); +# $target_class->result_source_instance($source) +# if $target_class->can('result_source_instance'); +# $schema->register_source($moniker, $source); +# } +# return $schema; +# } + +sub compose_namespace { + my ($self, $target, $base) = @_; + + my $schema = $self->clone; + + $schema->source_registrations({}); + + # the original class-mappings must remain - otherwise + # reverse_relationship_info will not work + #$schema->class_mappings({}); + + { + no warnings qw/redefine/; + local *Class::C3::reinitialize = sub { } if DBIx::Class::_ENV_::OLD_MRO; + use warnings qw/redefine/; + + no strict qw/refs/; + foreach my $moniker ($self->sources) { + my $orig_source = $self->source($moniker); + + my $target_class = "${target}::${moniker}"; + $self->inject_base($target_class, $orig_source->result_class, ($base || ()) ); + + # register_source examines result_class, and then returns us a clone + my $new_source = $schema->register_source($moniker, bless + { %$orig_source, result_class => $target_class }, + ref $orig_source, + ); + + if ($target_class->can('result_source_instance')) { + # give the class a schema-less source copy + $target_class->result_source_instance( bless + { %$new_source, schema => ref $new_source->{schema} || $new_source->{schema} }, + ref $new_source, + ); + } } - return @created; - } - my @results_to_create; - foreach my $datum (@$data) { - my %result_to_create; - foreach my $index (0..$#names) { - $result_to_create{$names[$index]} = $$datum[$index]; + + foreach my $meth (qw/class source resultset/) { + no warnings 'redefine'; + *{"${target}::${meth}"} = subname "${target}::${meth}" => + sub { shift->schema->$meth(@_) }; } - push @results_to_create, \%result_to_create; } - $rs->populate(\@results_to_create); + + Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO; + + return $schema; } -=head2 exception_action +sub setup_connection_class { + my ($class, $target, @info) = @_; + $class->inject_base($target => 'DBIx::Class::DB'); + #$target->load_components('DB'); + $target->connection(@info); +} -=over 4 +=head2 svp_begin -=item Arguments: $code_reference +Creates a new savepoint (does nothing outside a transaction). +Equivalent to calling $schema->storage->svp_begin. See +L for more information. -=back +=cut -If C is set for this class/object, L -will prefer to call this code reference with the exception as an argument, -rather than its normal C or C action. +sub svp_begin { + my ($self, $name) = @_; -Your subroutine should probably just wrap the error in the exception -object/class of your choosing and rethrow. If, against all sage advice, -you'd like your C to suppress a particular exception -completely, simply have it return true. + $self->storage or $self->throw_exception + ('svp_begin called on $schema without storage'); -Example: + $self->storage->svp_begin($name); +} - package My::Schema; - use base qw/DBIx::Class::Schema/; - use My::ExceptionClass; - __PACKAGE__->exception_action(sub { My::ExceptionClass->throw(@_) }); - __PACKAGE__->load_classes; +=head2 svp_release - # or: - my $schema_obj = My::Schema->connect( .... ); - $schema_obj->exception_action(sub { My::ExceptionClass->throw(@_) }); +Releases a savepoint (does nothing outside a transaction). +Equivalent to calling $schema->storage->svp_release. See +L for more information. - # suppress all exceptions, like a moron: - $schema_obj->exception_action(sub { 1 }); +=cut -=head2 stacktrace +sub svp_release { + my ($self, $name) = @_; + + $self->storage or $self->throw_exception + ('svp_release called on $schema without storage'); + + $self->storage->svp_release($name); +} + +=head2 svp_rollback + +Rollback to a savepoint (does nothing outside a transaction). +Equivalent to calling $schema->storage->svp_rollback. See +L for more information. + +=cut + +sub svp_rollback { + my ($self, $name) = @_; + + $self->storage or $self->throw_exception + ('svp_rollback called on $schema without storage'); + + $self->storage->svp_rollback($name); +} + +=head2 clone =over 4 -=item Arguments: boolean +=item Arguments: %attrs? + +=item Return Value: $new_schema =back -Whether L should include stack trace information. -Defaults to false normally, but defaults to true if C<$ENV{DBIC_TRACE}> -is true. +Clones the schema and its associated result_source objects and returns the +copy. The resulting copy will have the same attributes as the source schema, +except for those attributes explicitly overriden by the provided C<%attrs>. + +=cut + +sub clone { + my $self = shift; + + my $clone = { + (ref $self ? %$self : ()), + (@_ == 1 && ref $_[0] eq 'HASH' ? %{ $_[0] } : @_), + }; + bless $clone, (ref $self || $self); + + $clone->$_(undef) for qw/class_mappings source_registrations storage/; + + $clone->_copy_state_from($self); + + return $clone; +} + +# Needed in Schema::Loader - if you refactor, please make a compatibility shim +# -- Caelum +sub _copy_state_from { + my ($self, $from) = @_; + + $self->class_mappings({ %{$from->class_mappings} }); + $self->source_registrations({ %{$from->source_registrations} }); + + foreach my $moniker ($from->sources) { + my $source = $from->source($moniker); + my $new = $source->new($source); + # we use extra here as we want to leave the class_mappings as they are + # but overwrite the source_registrations entry with the new source + $self->register_extra_source($moniker => $new); + } + + if ($from->storage) { + $self->storage($from->storage); + $self->storage->set_schema($self); + } +} =head2 throw_exception @@ -1008,36 +1069,56 @@ is true. =back -Throws an exception. Defaults to using L to report errors from -user's perspective. See L for details on overriding +Throws an exception. Obeys the exemption rules of L to report +errors from outer-user's perspective. See L for details on overriding this method's behavior. If L is turned on, C's default behavior will provide a detailed stack trace. =cut +my $false_exception_action_warned; sub throw_exception { my $self = shift; - DBIx::Class::Exception->throw($_[0], $self->stacktrace) - if !$self->exception_action || !$self->exception_action->(@_); + if (my $act = $self->exception_action) { + if ($act->(@_)) { + DBIx::Class::Exception->throw( + "Invocation of the exception_action handler installed on $self did *not*" + .' result in an exception. DBIx::Class is unable to function without a reliable' + .' exception mechanism, ensure that exception_action does not hide exceptions' + ." (original error: $_[0])" + ); + } + elsif(! $false_exception_action_warned++) { + carp ( + "The exception_action handler installed on $self returned false instead" + .' of throwing an exception. This behavior has been deprecated, adjust your' + .' handler to always rethrow the supplied error.' + ); + } + } + + DBIx::Class::Exception->throw($_[0], $self->stacktrace); } =head2 deploy =over 4 -=item Arguments: $sqlt_args, $dir +=item Arguments: \%sqlt_args, $dir =back Attempts to deploy the schema to the current storage using L. -See L for a list of values for C<$sqlt_args>. The most -common value for this would be C<< { add_drop_table => 1, } >> to have the SQL -produced include a DROP TABLE statement for each table created. +See L for a list of values for C<\%sqlt_args>. +The most common value for this would be C<< { add_drop_table => 1 } >> +to have the SQL produced include a C statement for each table +created. For quoting purposes supply C and +C. -Additionally, the DBIx::Class parser accepts a C parameter as a hash -ref or an array ref, containing a list of source to deploy. If present, then +Additionally, the DBIx::Class parser accepts a C parameter as a hash +ref or an array ref, containing a list of source to deploy. If present, then only the sources listed will get deployed. Furthermore, you can use the C parser parameter to prevent the parser from creating an index for each FK. @@ -1054,66 +1135,41 @@ sub deploy { =over 4 -=item Arguments: $rdbms_type +=item Arguments: See L + +=item Return value: $listofstatements =back -Returns the SQL statements used by L and L. -C<$rdbms_type> provides the DBI database driver name for which the SQL -statements are produced. If not supplied, the type of the current schema storage -will be used. +A convenient shortcut to +C<< $self->storage->deployment_statements($self, @args) >>. +Returns the SQL statements used by L and +L. =cut sub deployment_statements { - my ($self, $rdbms_type) = @_; + my $self = shift; $self->throw_exception("Can't generate deployment statements without a storage") if not $self->storage; - $self->storage->deployment_statements($self, $rdbms_type); + $self->storage->deployment_statements($self, @_); } -=head2 create_ddl_dir (EXPERIMENTAL) +=head2 create_ddl_dir =over 4 -=item Arguments: \@databases, $version, $directory, $preversion, $sqlt_args +=item Arguments: See L =back -Creates an SQL file based on the Schema, for each of the specified -database types, in the given directory. Given a previous version number, -this will also create a file containing the ALTER TABLE statements to -transform the previous schema into the current one. Note that these -statements may contain DROP TABLE or DROP COLUMN statements that can -potentially destroy data. - -The file names are created using the C method below, please -override this method in your schema if you would like a different file -name format. For the ALTER file, the same format is used, replacing -$version in the name with "$preversion-$version". - -See L for details of $sqlt_args. - -If no arguments are passed, then the following default values are used: - -=over 4 - -=item databases - ['MySQL', 'SQLite', 'PostgreSQL'] - -=item version - $schema->VERSION - -=item directory - './' - -=item preversion - +A convenient shortcut to +C<< $self->storage->create_ddl_dir($self, @args) >>. -=back - -Note that this feature is currently EXPERIMENTAL and may not work correctly -across all databases, or fully handle complex relationships. - -WARNING: Please check all SQL files created, before applying them. +Creates an SQL file based on the Schema, for each of the specified +database types, in the given directory. =cut @@ -1124,12 +1180,14 @@ sub create_ddl_dir { $self->storage->create_ddl_dir($self, @_); } -=head2 ddl_filename (EXPERIMENTAL) +=head2 ddl_filename =over 4 =item Arguments: $database-type, $version, $directory, $preversion +=item Return value: $normalised_filename + =back my $filename = $table->ddl_filename($type, $version, $dir, $preversion) @@ -1141,71 +1199,348 @@ name format is: C<$dir$schema-$version-$type.sql>. You may override this method in your schema if you wish to use a different format. + WARNING + + Prior to DBIx::Class version 0.08100 this method had a different signature: + + my $filename = $table->ddl_filename($type, $dir, $version, $preversion) + + In recent versions variables $dir and $version were reversed in order to + bring the signature in line with other Schema/Storage methods. If you + really need to maintain backward compatibility, you can do the following + in any overriding methods: + + ($dir, $version) = ($version, $dir) if ($DBIx::Class::VERSION < 0.08100); + =cut sub ddl_filename { my ($self, $type, $version, $dir, $preversion) = @_; - my $filename = ref($self); - $filename =~ s/::/-/g; - $filename = File::Spec->catfile($dir, "$filename-$version-$type.sql"); - $filename =~ s/$version/$preversion-$version/ if($preversion); - - return $filename; -} + require File::Spec; -=head2 sqlt_deploy_hook($sqlt_schema) + $version = "$preversion-$version" if $preversion; -An optional sub which you can declare in your own Schema class that will get -passed the L object when you deploy the schema via -L or L. + my $class = blessed($self) || $self; + $class =~ s/::/-/g; -For an example of what you can do with this, see -L. + return File::Spec->catfile($dir, "$class-$version-$type.sql"); +} =head2 thaw -Provided as the recommened way of thawing schema objects. You can call +Provided as the recommended way of thawing schema objects. You can call C directly if you wish, but the thawed objects will not have a -reference to any schema, so are rather useless +reference to any schema, so are rather useless. =cut sub thaw { my ($self, $obj) = @_; local $DBIx::Class::ResultSourceHandle::thaw_schema = $self; + require Storable; return Storable::thaw($obj); } =head2 freeze -This doesn't actualy do anything more than call L, it is just -provided here for symetry. +This doesn't actually do anything more than call L, it is just +provided here for symmetry. =cut sub freeze { - return Storable::freeze($_[1]); + require Storable; + return Storable::nfreeze($_[1]); } =head2 dclone -Recommeneded way of dcloning objects. This is needed to properly maintain -references to the schema object (which itself is B cloned.) +=over 4 + +=item Arguments: $object + +=item Return Value: dcloned $object + +=back + +Recommended way of dcloning L and L +objects so their references to the schema object +(which itself is B cloned) are properly maintained. =cut sub dclone { my ($self, $obj) = @_; local $DBIx::Class::ResultSourceHandle::thaw_schema = $self; + require Storable; return Storable::dclone($obj); } +=head2 schema_version + +Returns the current schema class' $VERSION in a normalised way. + +=cut + +sub schema_version { + my ($self) = @_; + my $class = ref($self)||$self; + + # does -not- use $schema->VERSION + # since that varies in results depending on if version.pm is installed, and if + # so the perl or XS versions. If you want this to change, bug the version.pm + # author to make vpp and vxs behave the same. + + my $version; + { + no strict 'refs'; + $version = ${"${class}::VERSION"}; + } + return $version; +} + + +=head2 register_class + +=over 4 + +=item Arguments: $moniker, $component_class + +=back + +This method is called by L and L to install the found classes into your Schema. You should be using those instead of this one. + +You will only need this method if you have your Result classes in +files which are not named after the packages (or all in the same +file). You may also need it to register classes at runtime. + +Registers a class which isa DBIx::Class::ResultSourceProxy. Equivalent to +calling: + + $schema->register_source($moniker, $component_class->result_source_instance); + +=cut + +sub register_class { + my ($self, $moniker, $to_register) = @_; + $self->register_source($moniker => $to_register->result_source_instance); +} + +=head2 register_source + +=over 4 + +=item Arguments: $moniker, $result_source + +=back + +This method is called by L. + +Registers the L in the schema with the given +moniker. + +=cut + +sub register_source { shift->_register_source(@_) } + +=head2 unregister_source + +=over 4 + +=item Arguments: $moniker + +=back + +Removes the L from the schema for the given moniker. + +=cut + +sub unregister_source { shift->_unregister_source(@_) } + +=head2 register_extra_source + +=over 4 + +=item Arguments: $moniker, $result_source + +=back + +As L but should be used if the result class already +has a source and you want to register an extra one. + +=cut + +sub register_extra_source { shift->_register_source(@_, { extra => 1 }) } + +sub _register_source { + my ($self, $moniker, $source, $params) = @_; + + $source = $source->new({ %$source, source_name => $moniker }); + + $source->schema($self); + weaken $source->{schema} if ref($self); + + my %reg = %{$self->source_registrations}; + $reg{$moniker} = $source; + $self->source_registrations(\%reg); + + return $source if $params->{extra}; + + my $rs_class = $source->result_class; + if ($rs_class and my $rsrc = try { $rs_class->result_source_instance } ) { + my %map = %{$self->class_mappings}; + if ( + exists $map{$rs_class} + and + $map{$rs_class} ne $moniker + and + $rsrc ne $_[2] # orig_source + ) { + carp + "$rs_class already had a registered source which was replaced by this call. " + . 'Perhaps you wanted register_extra_source(), though it is more likely you did ' + . 'something wrong.' + ; + } + + $map{$rs_class} = $moniker; + $self->class_mappings(\%map); + } + + return $source; +} + +my $global_phase_destroy; +sub DESTROY { + return if $global_phase_destroy ||= in_global_destruction; + + my $self = shift; + my $srcs = $self->source_registrations; + + for my $moniker (keys %$srcs) { + # find first source that is not about to be GCed (someone other than $self + # holds a reference to it) and reattach to it, weakening our own link + # + # during global destruction (if we have not yet bailed out) this should throw + # which will serve as a signal to not try doing anything else + # however beware - on older perls the exception seems randomly untrappable + # due to some weird race condition during thread joining :((( + if (ref $srcs->{$moniker} and svref_2object($srcs->{$moniker})->REFCNT > 1) { + local $@; + eval { + $srcs->{$moniker}->schema($self); + weaken $srcs->{$moniker}; + 1; + } or do { + $global_phase_destroy = 1; + }; + + last; + } + } +} + +sub _unregister_source { + my ($self, $moniker) = @_; + my %reg = %{$self->source_registrations}; + + my $source = delete $reg{$moniker}; + $self->source_registrations(\%reg); + if ($source->result_class) { + my %map = %{$self->class_mappings}; + delete $map{$source->result_class}; + $self->class_mappings(\%map); + } +} + + +=head2 compose_connection (DEPRECATED) + +=over 4 + +=item Arguments: $target_namespace, @db_info + +=item Return Value: $new_schema + +=back + +DEPRECATED. You probably wanted compose_namespace. + +Actually, you probably just wanted to call connect. + +=begin hidden + +(hidden due to deprecation) + +Calls L to the target namespace, +calls L with @db_info on the new schema, +then injects the L component and a +resultset_instance classdata entry on all the new classes, in order to support +$target_namespaces::$class->search(...) method calls. + +This is primarily useful when you have a specific need for class method access +to a connection. In normal usage it is preferred to call +L and use the resulting schema object to operate +on L objects with L for +more information. + +=end hidden + +=cut + +sub compose_connection { + my ($self, $target, @info) = @_; + + carp_once "compose_connection deprecated as of 0.08000" + unless $INC{"DBIx/Class/CDBICompat.pm"}; + + my $base = 'DBIx::Class::ResultSetProxy'; + try { + eval "require ${base};" + } + catch { + $self->throw_exception + ("No arguments to load_classes and couldn't load ${base} ($_)") + }; + + if ($self eq $target) { + # Pathological case, largely caused by the docs on early C::M::DBIC::Plain + foreach my $moniker ($self->sources) { + my $source = $self->source($moniker); + my $class = $source->result_class; + $self->inject_base($class, $base); + $class->mk_classdata(resultset_instance => $source->resultset); + $class->mk_classdata(class_resolver => $self); + } + $self->connection(@info); + return $self; + } + + my $schema = $self->compose_namespace($target, $base); + { + no strict 'refs'; + my $name = join '::', $target, 'schema'; + *$name = subname $name, sub { $schema }; + } + + $schema->connection(@info); + foreach my $moniker ($schema->sources) { + my $source = $schema->source($moniker); + my $class = $source->result_class; + #warn "$moniker $class $source ".$source->storage; + $class->mk_classdata(result_source_instance => $source); + $class->mk_classdata(resultset_instance => $source->resultset); + $class->mk_classdata(class_resolver => $schema); + } + return $schema; +} + 1; -=head1 AUTHORS +=head1 AUTHOR AND CONTRIBUTORS -Matt S. Trout +See L and L in DBIx::Class =head1 LICENSE