X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema.pm;h=45dcd7e8146404b9de0505b84f02964c80de5c94;hb=d56e05c74844b8b22f4f66e378b6ef992045a7b5;hp=10296519b789dff7aa81659d490780c3ef2cb7ef;hpb=d7156e507aaffa832df977118f015e0833bc87ff;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Schema.pm b/lib/DBIx/Class/Schema.pm index 1029651..45dcd7e 100644 --- a/lib/DBIx/Class/Schema.pm +++ b/lib/DBIx/Class/Schema.pm @@ -2,14 +2,30 @@ package DBIx::Class::Schema; use strict; use warnings; -use DBIx::Class::DB; -use base qw/DBIx::Class/; +use base 'DBIx::Class'; -__PACKAGE__->load_components(qw/Exception/); -__PACKAGE__->mk_classdata('class_registrations' => {}); -__PACKAGE__->mk_classdata('storage_type' => 'DBI'); -__PACKAGE__->mk_classdata('storage'); +use DBIx::Class::Carp; +use Try::Tiny; +use Scalar::Util qw/weaken blessed/; +use DBIx::Class::_Util qw( + refcount quote_sub scope_guard + is_exception dbic_internal_try + fail_on_internal_call emit_loud_diag +); +use Devel::GlobalDestruction; +use namespace::clean; + +__PACKAGE__->mk_group_accessors( inherited => qw( storage exception_action ) ); +__PACKAGE__->mk_classaccessor('storage_type' => '::DBI'); +__PACKAGE__->mk_classaccessor('stacktrace' => $ENV{DBIC_TRACE} || 0); +__PACKAGE__->mk_classaccessor('default_resultset_attributes' => {}); + +# These two should have been private from the start but too late now +# Undocumented on purpose, hopefully it won't ever be necessary to +# screw with them +__PACKAGE__->mk_classaccessor('class_mappings' => {}); +__PACKAGE__->mk_classaccessor('source_registrations' => {}); =head1 NAME @@ -17,97 +33,326 @@ DBIx::Class::Schema - composable schemas =head1 SYNOPSIS -in My/Schema.pm + package Library::Schema; + use base qw/DBIx::Class::Schema/; - package My::Schema; + # load all Result classes in Library/Schema/Result/ + __PACKAGE__->load_namespaces(); - use base qw/DBIx::Class::Schema/; + package Library::Schema::Result::CD; + use base qw/DBIx::Class::Core/; - __PACKAGE__->load_classes(qw/Foo Bar Baz/); + __PACKAGE__->load_components(qw/InflateColumn::DateTime/); # for example + __PACKAGE__->table('cd'); -in My/Schema/Foo.pm + # Elsewhere in your code: + my $schema1 = Library::Schema->connect( + $dsn, + $user, + $password, + { AutoCommit => 1 }, + ); - package My::Schema::Foo; + my $schema2 = Library::Schema->connect($coderef_returning_dbh); - use base qw/DBIx::Class/; + # fetch objects using Library::Schema::Result::DVD + my $resultset = $schema1->resultset('DVD')->search( ... ); + my @dvd_objects = $schema2->resultset('DVD')->search( ... ); - __PACKAGE__->load_components(qw/PK::Auto::Pg Core/); # for example - __PACKAGE__->table('foo'); - ... +=head1 DESCRIPTION -in My/DB.pm +Creates database classes based on a schema. This is the recommended way to +use L and allows you to use more than one concurrent connection +with your classes. - use My::Schema; +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. - My::Schema->compose_connection('My::DB', $dsn, $user, $pass, $attrs); +=head1 SETUP METHODS -then in app code +=head2 load_namespaces - my @obj = My::DB::Foo->search({}); # My::DB::Foo isa My::Schema::Foo My::DB +=over 4 -=head1 DESCRIPTION +=item Arguments: %options? -Creates database classes based on a schema. This allows you to have more than -one concurrent connection using the same database classes, by making -subclasses under a new namespace for each connection. If you only need one -class, you should probably use L directly instead. +=back -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. + package MyApp::Schema; + __PACKAGE__->load_namespaces(); -=head1 METHODS + __PACKAGE__->load_namespaces( + result_namespace => 'Res', + resultset_namespace => 'RSet', + default_resultset_class => '+MyApp::Othernamespace::RSet', + ); + +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. + +ResultSet classes are associated with Result class of the same name. +For example, C will get the ResultSet class +C if it is present. + +Both Result and ResultSet namespaces are configurable via the +C and C options. + +Another option, C specifies a custom default +ResultSet class for Result classes with no corresponding ResultSet. + +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>. -=head2 register_class +=head3 Warnings -Registers the class in the schema's class_registrations. This is a hash -containing database classes, keyed by their monikers. It's used by -compose_connection to create/modify all the existing database classes. +You will be warned if ResultSet classes are discovered for which there +are no matching Result classes like this: + + load_namespaces found ResultSet class $classname with no corresponding Result class + +If a ResultSource instance is found to already have a ResultSet class set +using L to some +other class, you will be warned like this: + + We found ResultSet class '$rs_class' for '$result_class', but it seems + that you had already set '$result_class' to use '$rs_set' instead + +=head3 Examples + + # load My::Schema::Result::CD, My::Schema::Result::Artist, + # My::Schema::ResultSet::CD, etc... + My::Schema->load_namespaces; + + # 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', + ); + + # Put things in other namespaces + My::Schema->load_namespaces( + result_namespace => '+Some::Place::Results', + resultset_namespace => '+Another::Place::RSets', + ); + +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::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 register_class { - my ($class, $name, $to_register) = @_; - my %reg = %{$class->class_registrations}; - $reg{$name} = $to_register; - $class->class_registrations(\%reg); +# 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) = @_; + $name =~ s/^\+// or $name = "${class}::${name}"; + return $name; +} + +# 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 { + require Module::Find; + return map + { $_ =~ /(.+)/ } # untaint result + Module::Find::findallmod( $_[1] || ref $_[0] || $_[0] ) + ; } -=head2 registered_classes +# 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 ($me, $namespaces) = @_; -Simple read-only accessor for the schema's registered classes. See -register_class above if you want to modify it. + my %res; + for my $ns (@$namespaces) { + $res{ substr($_, length "${ns}::") } = $_ + for $me->_findallmod($ns); + } + + \%res; +} +# 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]; -=cut + return dbic_internal_try { + $rs_class->result_source + } catch { + $me->throw_exception ( + "Attempt to load_namespaces() class $rs_class failed - are you sure this is a real Result Class?: $_" + ); + }; +} + +sub load_namespaces { + my ($class, %args) = @_; + + 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}; + + $default_resultset_class = $class->_expand_relative_name($default_resultset_class) + if $default_resultset_class; + + $class->throw_exception('load_namespaces: unknown option(s): ' + . join(q{,}, map { qq{'$_'} } keys %args)) + if scalar keys %args; + + for my $arg ($result_namespace, $resultset_namespace) { + $arg = [ $arg ] if ( $arg and ! ref $arg ); + + $class->throw_exception('load_namespaces: namespace arguments must be ' + . 'a simple string or an arrayref') + if ref($arg) ne 'ARRAY'; + + $_ = $class->_expand_relative_name($_) for (@$arg); + } + + my $results_by_source_name = $class->_map_namespaces($result_namespace); + my $resultsets_by_source_name = $class->_map_namespaces($resultset_namespace); + + my @to_register; + { + no warnings qw/redefine/; + local *Class::C3::reinitialize = sub { } if DBIx::Class::_ENV_::OLD_MRO; + use warnings qw/redefine/; + + # ensure classes are loaded and attached in inheritance order + for my $result_class (values %$results_by_source_name) { + $class->ensure_class_loaded($result_class); + } + my %inh_idx; + my @source_names_by_subclass_last = sort { + + ($inh_idx{$a} ||= + scalar @{mro::get_linear_isa( $results_by_source_name->{$a} )} + ) + + <=> + + ($inh_idx{$b} ||= + scalar @{mro::get_linear_isa( $results_by_source_name->{$b} )} + ) + + } keys(%$results_by_source_name); + + foreach my $source_name (@source_names_by_subclass_last) { + my $result_class = $results_by_source_name->{$source_name}; + + my $preset_resultset_class = $class->_ns_get_rsrc_instance ($result_class)->resultset_class; + my $found_resultset_class = delete $resultsets_by_source_name->{$source_name}; + + if($preset_resultset_class && $preset_resultset_class ne 'DBIx::Class::ResultSet') { + if($found_resultset_class && $found_resultset_class ne $preset_resultset_class) { + carp "We found ResultSet class '$found_resultset_class' matching '$results_by_source_name->{$source_name}', but it seems " + . "that you had already set the '$results_by_source_name->{$source_name}' resultet to '$preset_resultset_class' instead"; + } + } + # elsif - there may be *no* default_resultset_class, in which case we fallback to + # DBIx::Class::Resultset and there is nothing to check + elsif($found_resultset_class ||= $default_resultset_class) { + $class->ensure_class_loaded($found_resultset_class); + if(!$found_resultset_class->isa("DBIx::Class::ResultSet")) { + carp "load_namespaces found ResultSet class '$found_resultset_class' that does not subclass DBIx::Class::ResultSet"; + } + + $class->_ns_get_rsrc_instance ($result_class)->resultset_class($found_resultset_class); + } + + my $source_name = $class->_ns_get_rsrc_instance ($result_class)->source_name || $source_name; + + push(@to_register, [ $source_name, $result_class ]); + } + } + + foreach (sort keys %$resultsets_by_source_name) { + carp "load_namespaces found ResultSet class '$resultsets_by_source_name->{$_}' " + .'with no corresponding Result class'; + } + + Class::C3->reinitialize if DBIx::Class::_ENV_::OLD_MRO; -sub registered_classes { - return values %{shift->class_registrations}; + $class->register_class(@$_) for (@to_register); + + return; } -=head2 load_classes [, (, ), { => []}] +=head2 load_classes + +=over 4 + +=item Arguments: @classes?, { $namespace => [ @classes ] }+ + +=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). -Uses L to find all classes under the database class' namespace, -or uses the classes you select. Then it loads the component (using L), -and registers them (using B); +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. -It is possible to comment out classes with a leading '#', 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 "no warnings 'qw';" 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, + # etc. (anything under the My::Schema namespace) + + # loads My::Schema::CD, My::Schema::Artist, Other::Namespace::Producer but + # not Other::Namespace::LinerNotes nor My::Schema::Track + My::Schema->load_classes(qw/ CD Artist #Track /, { + Other::Namespace => [qw/ Producer #LinerNotes /], + }); =cut sub load_classes { my ($class, @params) = @_; - + my %comps_for; - + if (@params) { foreach my $param (@params) { if (ref $param eq 'ARRAY') { # filter out commented entries my @modules = grep { $_ !~ /^#/ } @$param; - + push (@{$comps_for{$class}}, @modules); } elsif (ref $param eq 'HASH') { @@ -125,98 +370,1321 @@ sub load_classes { } } } else { - eval "require Module::Find;"; - $class->throw("No arguments to load_classes and couldn't load". - " Module::Find ($@)") if $@; - my @comp = map { substr $_, length "${class}::" } Module::Find::findallmod($class); + my @comp = map { substr $_, length "${class}::" } + $class->_findallmod($class); $comps_for{$class} = \@comp; } - foreach my $prefix (keys %comps_for) { - foreach my $comp (@{$comps_for{$prefix}||[]}) { - my $comp_class = "${prefix}::${comp}"; - eval "use $comp_class"; # If it fails, assume the user fixed it - $class->register_class($comp => $comp_class); + my @to_register; + { + no warnings qw/redefine/; + 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}"; + $class->ensure_class_loaded($comp_class); + + 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 if DBIx::Class::_ENV_::OLD_MRO; + + foreach my $to (@to_register) { + $class->register_class(@$to); + } +} + +=head2 storage_type + +=over 4 + +=item Arguments: $storage_type|{$storage_type, \%args} + +=item Return Value: $storage_type|{$storage_type, \%args} + +=item Default value: DBIx::Class::Storage::DBI + +=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. + +You want to use this to set subclasses of L +in cases where the appropriate subclass is not autodetected. + +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. + +=head2 default_resultset_attributes + +=over 4 + +=item Arguments: L<\%attrs|DBIx::Class::ResultSet/ATTRIBUTES> + +=item Return Value: L<\%attrs|DBIx::Class::ResultSet/ATTRIBUTES> + +=item Default value: None + +=back + +Like L stores a collection +of resultset attributes, to be used as defaults for B ResultSet +instance schema-wide. The same list of CAVEATS and WARNINGS applies, with +the extra downside of these defaults being practically inescapable: you will +B be able to derive a ResultSet instance with these attributes unset. + +Example: + + package My::Schema; + use base qw/DBIx::Class::Schema/; + __PACKAGE__->default_resultset_attributes( { software_limit => 1 } ); + +=head2 exception_action + +=over 4 + +=item Arguments: $code_reference + +=item Return Value: $code_reference + +=item Default value: None + +=back + +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. + +Your custom throw code B rethrow the exception, as L is +an integral part of DBIC's internal execution control flow. + +Example: + + package My::Schema; + use base qw/DBIx::Class::Schema/; + use My::ExceptionClass; + __PACKAGE__->exception_action(sub { My::ExceptionClass->throw(@_) }); + __PACKAGE__->load_classes; + + # or: + my $schema_obj = My::Schema->connect( .... ); + $schema_obj->exception_action(sub { My::ExceptionClass->throw(@_) }); + +=head2 stacktrace + +=over 4 + +=item Arguments: boolean + +=back + +Whether L should include stack trace information. +Defaults to false normally, but defaults to true if C<$ENV{DBIC_TRACE}> +is true. + +=head2 sqlt_deploy_hook + +=over + +=item Arguments: $sqlt_schema + +=back + +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. + +For an example of what you can do with this, see +L. + +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. + +=head1 METHODS + +=head2 connect + +=over 4 + +=item Arguments: @connectinfo + +=item Return Value: $new_schema + +=back + +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. + +See L for DBI-specific +syntax on the C<@connectinfo> argument, or L in +general. + +Note that C expects an arrayref of arguments, but +C does not. C wraps its arguments in an arrayref +before passing them to C. + +=head3 Overloading + +C is a convenience method. It is equivalent to calling +$schema->clone->connection(@connectinfo). To write your own overloaded +version, overload L instead. + +=cut + +sub connect { + DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call; + shift->clone->connection(@_); } -=head2 compose_connection <@db_info> +=head2 resultset -This is the most important method in this class. it takes a target namespace, -as well as dbh connection info, and creates a L class as -well as subclasses for each of your database classes in this namespace, using -this connection. +=over 4 -It will also setup a ->class method on the target class, which lets you -resolve database classes based on the schema component name, for example +=item Arguments: L<$source_name|DBIx::Class::ResultSource/source_name> - MyApp::DB->class('Foo') # returns MyApp::DB::Foo, - # which ISA MyApp::Schema::Foo +=item Return Value: L<$resultset|DBIx::Class::ResultSet> -This is the recommended API for accessing Schema generated classes, and -using it might give you instant advantages with future versions of DBIC. +=back -WARNING: Loading components into Schema classes after compose_connection -may not cause them to be seen by the classes in your target namespace due -to the dispatch table approach used by Class::C3. If you do this you may find -you need to call Class::C3->reinitialize() afterwards to get the behaviour -you expect. + my $rs = $schema->resultset('DVD'); + +Returns the L object for the registered source +name. =cut -sub compose_connection { - my ($class, $target, @info) = @_; - my $conn_class = "${target}::_db"; - $class->setup_connection_class($conn_class, @info); - $class->compose_namespace($target, $conn_class); +sub resultset { + my ($self, $source_name) = @_; + $self->throw_exception('resultset() expects a source name') + unless defined $source_name; + return $self->source($source_name)->resultset; } -sub compose_namespace { - my ($class, $target, $base) = @_; - my %reg = %{ $class->class_registrations }; - my %target; - my %map; - while (my ($comp, $comp_class) = each %reg) { - my $target_class = "${target}::${comp}"; - $class->inject_base($target_class, $comp_class, $base); - @map{$comp, $comp_class} = ($target_class, $target_class); - } - { - no strict 'refs'; - *{"${target}::class"} = - sub { - my ($class, $to_map) = @_; - return $map{$to_map}; - }; - *{"${target}::classes"} = sub { return \%map; }; - } - $base->class_resolver($target); +=head2 sources + +=over 4 + +=item Return Value: L<@source_names|DBIx::Class::ResultSource/source_name> + +=back + + my @source_names = $schema->sources; + +Lists names of all the sources registered on this Schema object. + +=cut + +sub sources { keys %{shift->source_registrations} } + +=head2 source + +=over 4 + +=item Arguments: L<$source_name|DBIx::Class::ResultSource/source_name> + +=item Return Value: L<$result_source|DBIx::Class::ResultSource> + +=back + + my $source = $schema->source('Book'); + +Returns the L object for the registered +source name. + +=cut + +sub source { + my ($self, $source_name) = @_; + + $self->throw_exception("source() expects a source name") + unless $source_name; + + my $source_registrations; + + my $rsrc = + ( $source_registrations = $self->source_registrations )->{$source_name} + || + # if we got here, they probably passed a full class name + $source_registrations->{ $self->class_mappings->{$source_name} || '' } + || + $self->throw_exception( "Can't find source for ${source_name}" ) + ; + + # DO NOT REMOVE: + # We need to prevent alterations of pre-existing $@ due to where this call + # sits in the overall stack ( *unless* of course there is an actual error + # to report ). set_mro does alter $@ (and yes - it *can* throw an exception) + # We do not use local because set_mro *can* throw an actual exception + # We do not use a try/catch either, as on one hand it would slow things + # down for no reason (we would always rethrow), but also because adding *any* + # try/catch block below will segfault various threading tests on older perls + # ( which in itself is a FIXME but ENOTIMETODIG ) + my $old_dollarat = $@; + + no strict 'refs'; + mro::set_mro($_, 'c3') for + grep + { + # some pseudo-sources do not have a result/resultset yet + defined $_ + and + ( + ( + ${"${_}::__INITIAL_MRO_UPON_DBIC_LOAD__"} + ||= mro::get_mro($_) + ) + ne + 'c3' + ) + } + map + { length ref $_ ? ref $_ : $_ } + ( $rsrc, $rsrc->result_class, $rsrc->resultset_class ) + ; + + # DO NOT REMOVE - see comment above + $@ = $old_dollarat; + + $rsrc; } -=head2 setup_connection_class <$target> <@info> +=head2 class + +=over 4 + +=item Arguments: L<$source_name|DBIx::Class::ResultSource/source_name> + +=item Return Value: $classname + +=back + + my $class = $schema->class('CD'); -Sets up a database connection class to inject between the schema -and the subclasses the schema creates. +Retrieves the Result class name for the given source name. =cut -sub setup_connection_class { - my ($class, $target, @info) = @_; - $class->inject_base($target => 'DBIx::Class::DB'); - #$target->load_components('DB'); - $target->connection(@info); +sub class { + return shift->source(shift)->result_class; } -1; +=head2 txn_do + +=over 4 + +=item Arguments: C<$coderef>, @coderef_args? -=head1 AUTHORS +=item Return Value: The return value of $coderef -Matt S. Trout +=back -=head1 LICENSE +Executes C<$coderef> with (optional) arguments C<@coderef_args> atomically, +returning its result (if any). Equivalent to calling $schema->storage->txn_do. +See L for more information. -You may distribute this code under the same terms as Perl itself. +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 { + my $self = shift; + + $self->storage or $self->throw_exception + ('txn_do called on $schema without storage'); + + $self->storage->txn_do(@_); +} + +=head2 txn_scope_guard + +Runs C on the schema's storage. See +L. + +=cut + +sub txn_scope_guard { + my $self = shift; + + $self->storage or $self->throw_exception + ('txn_scope_guard called on $schema without storage'); + + $self->storage->txn_scope_guard(@_); +} + +=head2 txn_begin + +Begins a transaction (does nothing if AutoCommit is off). Equivalent to +calling $schema->storage->txn_begin. See +L for more information. + +=cut + +sub txn_begin { + my $self = shift; + + $self->storage or $self->throw_exception + ('txn_begin called on $schema without storage'); + + $self->storage->txn_begin; +} + +=head2 txn_commit + +Commits the current transaction. Equivalent to calling +$schema->storage->txn_commit. See L +for more information. + +=cut + +sub txn_commit { + my $self = shift; + + $self->storage or $self->throw_exception + ('txn_commit called on $schema without storage'); + + $self->storage->txn_commit; +} + +=head2 txn_rollback + +Rolls back the current transaction. Equivalent to calling +$schema->storage->txn_rollback. See +L for more information. + +=cut + +sub txn_rollback { + my $self = shift; + + $self->storage or $self->throw_exception + ('txn_rollback called on $schema without storage'); + + $self->storage->txn_rollback; +} + +=head2 storage + + my $storage = $schema->storage; + +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. + +=head2 populate + +=over 4 + +=item Arguments: L<$source_name|DBIx::Class::ResultSource/source_name>, [ \@column_list, \@row_values+ ] | [ \%col_data+ ] + +=item Return Value: L<\@result_objects|DBIx::Class::Manual::ResultClass> (scalar context) | L<@result_objects|DBIx::Class::Manual::ResultClass> (list context) + +=back + +A convenience shortcut to L. Equivalent to: + + $schema->resultset($source_name)->populate([...]); + +=over 4 + +=item NOTE + +The context of this method call has an important effect on what is +submitted to storage. In void context data is fed directly to fastpath +insertion routines provided by the underlying storage (most often +L), bypassing the L and +L calls on the +L class, including any +augmentation of these methods provided by components. For example if you +are using something like L to create primary +keys for you, you will find that your PKs are empty. In this case you +will have to explicitly force scalar or list context in order to create +those values. + +=back =cut +sub populate { + DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call; + + my ($self, $name, $data) = @_; + my $rs = $self->resultset($name) + or $self->throw_exception("'$name' is not a resultset"); + + return $rs->populate($data); +} + +=head2 connection + +=over 4 + +=item Arguments: @args + +=item Return Value: $self + +=back + +Similar to L except sets the storage object and connection +data B on C<$self>. You should probably be calling +L to get a properly L Schema object instead. + +=head3 Overloading + +Overload C to change the behaviour of C. + +=cut + +sub connection { + my ($self, @info) = @_; + return $self if !@info && $self->storage; + + my ($storage_class, $args) = ref $self->storage_type + ? $self->_normalize_storage_type($self->storage_type) + : $self->storage_type + ; + + $storage_class =~ s/^::/DBIx::Class::Storage::/; + + dbic_internal_try { + $self->ensure_class_loaded ($storage_class); + } + 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; +} + +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: $target_namespace, $additional_base_class? + +=item Return Value: $new_schema + +=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 class 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::Schema::CD, Base::Class + My::Schema::Artist, Base::Class + +=cut + +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/; + + foreach my $source_name ($self->sources) { + my $orig_source = $self->source($source_name); + + my $target_class = "${target}::${source_name}"; + $self->inject_base($target_class, $orig_source->result_class, ($base || ()) ); + + $schema->register_source( + $source_name, + $orig_source->clone( + result_class => $target_class + ), + ); + } + + # Legacy stuff, not inserting INDIRECT assertions + quote_sub "${target}::${_}" => "shift->schema->$_(\@_)" + for qw(class source resultset); + } + + Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO; + + # Give each composed class yet another *schema-less* source copy + # this is used for the freeze/thaw cycle + # + # This is not covered by any tests directly, but is indirectly exercised + # in t/cdbi/sweet/08pager by re-setting the schema on an existing object + # FIXME - there is likely a much cheaper way to take care of this + for my $source_name ($self->sources) { + + my $target_class = "${target}::${source_name}"; + + $target_class->result_source_instance( + $self->source($source_name)->clone( + result_class => $target_class, + schema => ( ref $schema || $schema ), + ) + ); + } + + return $schema; +} + +# LEGACY: The intra-call to this was removed in 66d9ef6b and then +# the sub was de-documented way later in 249963d4. No way to be sure +# nothing on darkpan is calling it directly, so keeping as-is +sub setup_connection_class { + my ($class, $target, @info) = @_; + $class->inject_base($target => 'DBIx::Class::DB'); + #$target->load_components('DB'); + $target->connection(@info); +} + +=head2 svp_begin + +Creates a new savepoint (does nothing outside a transaction). +Equivalent to calling $schema->storage->svp_begin. See +L for more information. + +=cut + +sub svp_begin { + my ($self, $name) = @_; + + $self->storage or $self->throw_exception + ('svp_begin called on $schema without storage'); + + $self->storage->svp_begin($name); +} + +=head2 svp_release + +Releases a savepoint (does nothing outside a transaction). +Equivalent to calling $schema->storage->svp_release. See +L for more information. + +=cut + +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: %attrs? + +=item Return Value: $new_schema + +=back + +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 overridden 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} }); + + # 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( $_ => $from->source($_) ) + for $from->sources; + + if ($from->storage) { + $self->storage($from->storage); + $self->storage->set_schema($self); + } +} + +=head2 throw_exception + +=over 4 + +=item Arguments: $message + +=back + +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 + +sub throw_exception { + my ($self, @args) = @_; + + if ( + ! DBIx::Class::_Util::in_internal_try() + and + my $act = $self->exception_action + ) { + + my $guard_disarmed; + + my $guard = scope_guard { + return if $guard_disarmed; + emit_loud_diag( emit_dups => 1, msg => " + + !!! DBIx::Class INTERNAL PANIC !!! + +The exception_action() handler installed on '$self' +aborted the stacktrace below via a longjmp (either via Return::Multilevel or +plain goto, or Scope::Upper or something equally nefarious). There currently +is nothing safe DBIx::Class can do, aside from displaying this error. A future +version ( 0.082900, when available ) will reduce the cases in which the +handler is invoked, but this is neither a complete solution, nor can it do +anything for other software that might be affected by a similar problem. + + !!! FIX YOUR ERROR HANDLING !!! + +This guard was activated starting", + ); + }; + + dbic_internal_try { + # if it throws - good, we'll assign to @args in the end + # if it doesn't - do different things depending on RV truthiness + if( $act->(@args) ) { + $args[0] = ( + "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 your exception_action does not hide exceptions' + ." (original error: $args[0])" + ); + } + else { + carp_unique ( + "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' + ); + } + + 1; + } + catch { + # We call this to get the necessary warnings emitted and disregard the RV + # as it's definitely an exception if we got as far as this catch{} block + is_exception( + $args[0] = $_ + ); + }; + + # Done guarding against https://github.com/PerlDancer/Dancer2/issues/1125 + $guard_disarmed = 1; + } + + DBIx::Class::Exception->throw( $args[0], $self->stacktrace ); +} + +=head2 deploy + +=over 4 + +=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 C statement for each table +created. For quoting purposes supply 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 +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. + +=cut + +sub deploy { + my ($self, $sqltargs, $dir) = @_; + $self->throw_exception("Can't deploy without storage") unless $self->storage; + $self->storage->deploy($self, undef, $sqltargs, $dir); +} + +=head2 deployment_statements + +=over 4 + +=item Arguments: See L + +=item Return Value: $listofstatements + +=back + +A convenient shortcut to +C<< $self->storage->deployment_statements($self, @args) >>. +Returns the statements used by L and +L. + +=cut + +sub deployment_statements { + my $self = shift; + + $self->throw_exception("Can't generate deployment statements without a storage") + if not $self->storage; + + $self->storage->deployment_statements($self, @_); +} + +=head2 create_ddl_dir + +=over 4 + +=item Arguments: See L + +=back + +A convenient shortcut to +C<< $self->storage->create_ddl_dir($self, @args) >>. + +Creates an SQL file based on the Schema, for each of the specified +database types, in the given directory. + +=cut + +sub create_ddl_dir { + my $self = shift; + + $self->throw_exception("Can't create_ddl_dir without storage") unless $self->storage; + $self->storage->create_ddl_dir($self, @_); +} + +=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) + +This method is called by C to compose a file name out of +the supplied directory, database type and version number. The default file +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) = @_; + + $version = "$preversion-$version" if $preversion; + + my $class = blessed($self) || $self; + $class =~ s/::/-/g; + + return "$dir/$class-$version-$type.sql"; +} + +=head2 thaw + +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. + +=cut + +sub thaw { + my ($self, $obj) = @_; + local $DBIx::Class::ResultSourceHandle::thaw_schema = $self; + return Storable::thaw($obj); +} + +=head2 freeze + +This doesn't actually do anything beyond calling L, +it is just provided here for symmetry. + +=cut + +sub freeze { + return Storable::nfreeze($_[1]); +} + +=head2 dclone + +=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; + 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: $source_name, $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($source_name, $component_class->result_source); + +=cut + +sub register_class { + my ($self, $source_name, $to_register) = @_; + $self->register_source($source_name => $to_register->result_source); +} + +=head2 register_source + +=over 4 + +=item Arguments: $source_name, L<$result_source|DBIx::Class::ResultSource> + +=back + +This method is called by L. + +Registers the L in the schema with the given +source name. + +=cut + +sub register_source { shift->_register_source(@_) } + +=head2 unregister_source + +=over 4 + +=item Arguments: $source_name + +=back + +Removes the L from the schema for the given source name. + +=cut + +sub unregister_source { shift->_unregister_source(@_) } + +=head2 register_extra_source + +=over 4 + +=item Arguments: $source_name, L<$result_source|DBIx::Class::ResultSource> + +=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, $source_name, $supplied_rsrc, $params) = @_; + + my $derived_rsrc = $supplied_rsrc->clone({ + source_name => $source_name, + }); + + # Do not move into the clone-hashref above: there are things + # on CPAN that do hook 'sub schema' + # https://metacpan.org/source/LSAUNDERS/DBIx-Class-Preview-1.000003/lib/DBIx/Class/ResultSource/Table/Previewed.pm#L9-38 + $derived_rsrc->schema($self); + + weaken $derived_rsrc->{schema} + if length( my $schema_class = ref($self) ); + + my %reg = %{$self->source_registrations}; + $reg{$source_name} = $derived_rsrc; + $self->source_registrations(\%reg); + + return $derived_rsrc if $params->{extra}; + + my( $result_class, $result_class_level_rsrc ); + if ( + $result_class = $derived_rsrc->result_class + and + # There are known cases where $rs_class is *ONLY* an inflator, without + # any hint of a rsrc (e.g. DBIx::Class::KiokuDB::EntryProxy) + $result_class_level_rsrc = dbic_internal_try { $result_class->result_source_instance } + ) { + my %map = %{$self->class_mappings}; + + carp ( + "$result_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.' + ) if ( + exists $map{$result_class} + and + $map{$result_class} ne $source_name + and + $result_class_level_rsrc != $supplied_rsrc + ); + + $map{$result_class} = $source_name; + $self->class_mappings(\%map); + + + my $schema_class_level_rsrc; + if ( + # we are called on a schema instance, not on the class + length $schema_class + + and + + # the schema class also has a registration with the same name + $schema_class_level_rsrc = dbic_internal_try { $schema_class->source($source_name) } + + and + + # what we are registering on the schema instance *IS* derived + # from the class-level (top) rsrc... + ( grep { $_ == $derived_rsrc } $result_class_level_rsrc->__derived_instances ) + + and + + # ... while the schema-class-level has stale-markers + keys %{ $schema_class_level_rsrc->{__metadata_divergencies} || {} } + ) { + my $msg = + "The ResultSource instance you just registered on '$self' as " + . "'$source_name' seems to have no relation to $schema_class->" + . "source('$source_name') which in turn is marked stale (likely due " + . "to recent $result_class->... direct class calls). This is almost " + . "always a mistake: perhaps you forgot a cycle of " + . "$schema_class->unregister_source( '$source_name' ) / " + . "$schema_class->register_class( '$source_name' => '$result_class' )" + ; + + DBIx::Class::_ENV_::ASSERT_NO_ERRONEOUS_METAINSTANCE_USE + ? emit_loud_diag( msg => $msg, confess => 1 ) + : carp_unique($msg) + ; + } + } + + $derived_rsrc; +} + +my $global_phase_destroy; +sub DESTROY { + ### NO detected_reinvoked_destructor check + ### This code very much relies on being called multuple times + + return if $global_phase_destroy ||= in_global_destruction; + + my $self = shift; + my $srcs = $self->source_registrations; + + for my $source_name (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 (length ref $srcs->{$source_name} and refcount($srcs->{$source_name}) > 1) { + local $SIG{__DIE__} if $SIG{__DIE__}; + local $@ if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT; + eval { + $srcs->{$source_name}->schema($self); + weaken $srcs->{$source_name}; + 1; + } or do { + $global_phase_destroy = 1; + }; + + last; + } + } + + # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage + # collected before leaving this scope. Depending on the code above, this + # may very well be just a preventive measure guarding future modifications + undef; +} + +sub _unregister_source { + my ($self, $source_name) = @_; + my %reg = %{$self->source_registrations}; + + my $source = delete $reg{$source_name}; + $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"}; + + dbic_internal_try { + require DBIx::Class::ResultSetProxy; + } + catch { + $self->throw_exception + ("No arguments to load_classes and couldn't load DBIx::Class::ResultSetProxy ($_)") + }; + + if ($self eq $target) { + # Pathological case, largely caused by the docs on early C::M::DBIC::Plain + foreach my $source_name ($self->sources) { + my $source = $self->source($source_name); + my $class = $source->result_class; + $self->inject_base($class, 'DBIx::Class::ResultSetProxy'); + $class->mk_classaccessor(resultset_instance => $source->resultset); + $class->mk_classaccessor(class_resolver => $self); + } + $self->connection(@info); + return $self; + } + + my $schema = $self->compose_namespace($target, 'DBIx::Class::ResultSetProxy'); + quote_sub "${target}::schema", '$s', { '$s' => \$schema }; + + $schema->connection(@info); + foreach my $source_name ($schema->sources) { + my $source = $schema->source($source_name); + my $class = $source->result_class; + #warn "$source_name $class $source ".$source->storage; + + $class->mk_group_accessors( inherited => [ result_source_instance => '_result_source' ] ); + # explicit set-call, avoid mro update lag + $class->set_inherited( result_source_instance => $source ); + + $class->mk_classaccessor(resultset_instance => $source->resultset); + $class->mk_classaccessor(class_resolver => $schema); + } + return $schema; +} + +=head1 FURTHER QUESTIONS? + +Check the list of L. + +=head1 COPYRIGHT AND LICENSE + +This module is free software L +by the L. You can +redistribute it and/or modify it under the same terms as the +L. + +=cut + +1;