X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema.pm;h=4254b1e2ba90efd6518363919cec883994efea16;hb=6936e902c1291c14c8e73f9c9f016e5212ad4083;hp=ee4b936387f3fa9017efb50f09bbd6c9d5583acb;hpb=382a78385abc2213ea09b3f6c6732694bf522e63;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Schema.pm b/lib/DBIx/Class/Schema.pm index ee4b936..4254b1e 100644 --- a/lib/DBIx/Class/Schema.pm +++ b/lib/DBIx/Class/Schema.pm @@ -3,8 +3,11 @@ package DBIx::Class::Schema; use strict; use warnings; +use DBIx::Class::Exception; use Carp::Clan qw/^DBIx::Class/; use Scalar::Util qw/weaken/; +use File::Spec; +use Sub::Name (); require Module::Find; use base qw/DBIx::Class/; @@ -14,6 +17,8 @@ __PACKAGE__->mk_classdata('source_registrations' => {}); __PACKAGE__->mk_classdata('storage_type' => '::DBI'); __PACKAGE__->mk_classdata('storage'); __PACKAGE__->mk_classdata('exception_action'); +__PACKAGE__->mk_classdata('stacktrace' => $ENV{DBIC_TRACE} || 0); +__PACKAGE__->mk_classdata('default_resultset_attributes' => {}); =head1 NAME @@ -24,12 +29,12 @@ 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; + package Library::Schema::Result::CD; use base qw/DBIx::Class/; - __PACKAGE__->load_components(qw/PK::Auto Core/); # for example + __PACKAGE__->load_components(qw/Core/); # for example __PACKAGE__->table('cd'); # Elsewhere in your code: @@ -42,7 +47,7 @@ DBIx::Class::Schema - composable schemas 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( ... ); @@ -56,239 +61,44 @@ 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 register_class - -=over 4 - -=item Arguments: $moniker, $component_class - -=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 - -=back - -Registers the L in the schema with the given -moniker. - -=cut - -sub register_source { - my ($self, $moniker, $source) = @_; - my %reg = %{$self->source_registrations}; - $reg{$moniker} = $source; - $self->source_registrations(\%reg); - $source->schema($self); - weaken($source->{schema}) if ref($self); - if ($source->result_class) { - my %map = %{$self->class_mappings}; - $map{$source->result_class} = $moniker; - $self->class_mappings(\%map); - } -} - -=head2 class - -=over 4 - -=item Arguments: $moniker - -=item Return Value: $classname - -=back - -Retrieves the result class name for the given moniker. For example: - - my $class = $schema->class('CD'); - -=cut - -sub class { - my ($self, $moniker) = @_; - return $self->source($moniker)->result_class; -} - -=head2 source - -=over 4 - -=item Arguments: $moniker - -=item Return Value: $result_source - -=back - - my $source = $schema->source('Book'); - -Returns the L object for the registered moniker. - -=cut - -sub source { - my ($self, $moniker) = @_; - 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 sources - -=over 4 +=head1 SETUP METHODS -=item Return Value: @source_monikers - -=back - -Returns the source monikers of all source registrations on this schema. -For example: - - my @source_monikers = $schema->sources; - -=cut - -sub sources { return keys %{shift->source_registrations}; } - -=head2 resultset - -=over 4 - -=item Arguments: $moniker - -=item Return Value: $result_set - -=back - - my $rs = $schema->resultset('DVD'); - -Returns the L object for the registered moniker. - -=cut - -sub resultset { - my ($self, $moniker) = @_; - return $self->source($moniker)->resultset; -} - -=head2 load_classes +=head2 load_namespaces =over 4 -=item Arguments: @classes?, { $namespace => [ @classes ] }+ +=item Arguments: %options? =back -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). - -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. - -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') { - # more than one namespace possible - for my $comp ( keys %$param ) { - # filter out commented entries - my @modules = grep { $_ !~ /^#/ } @{$param->{$comp}}; - - push (@{$comps_for{$comp}}, @modules); - } - } - else { - # filter out commented entries - push (@{$comps_for{$class}}, $param) if $param !~ /^#/; - } - } - } else { - my @comp = map { substr $_, length "${class}::" } - Module::Find::findallmod($class); - $comps_for{$class} = \@comp; - } - - my @to_register; - { - no warnings qw/redefine/; - local *Class::C3::reinitialize = sub { }; - foreach my $prefix (keys %comps_for) { - foreach my $comp (@{$comps_for{$prefix}||[]}) { - my $comp_class = "${prefix}::${comp}"; - $class->ensure_class_loaded($comp_class); - $comp_class->source_name($comp) unless $comp_class->source_name; + __PACKAGE__->load_namespaces(); - push(@to_register, [ $comp_class->source_name, $comp_class ]); - } - } - } - Class::C3->reinitialize; + __PACKAGE__->load_namespaces( + result_namespace => 'Res', + resultset_namespace => 'RSet', + default_resultset_class => '+MyDB::Othernamespace::RSet', + ); - foreach my $to (@to_register) { - $class->register_class(@$to); - # if $class->can('result_source_instance'); - } -} +With no arguments, this method uses L to load all your +Result classes from a sub-namespace F under your Schema class' +namespace. Eg. With a Schema of I all files in +I are assumed to be Result classes. -=head2 load_namespaces +It also finds all ResultSet classes in the namespace F and +loads them into the appropriate Result classes using for you. The +matching is done by assuming the package name of the ResultSet class +is the same as that of the Result class. -=over 4 +You will be warned if ResultSet classes are discovered for which there +are no matching Result classes like this: -=item Arguments: %options? + load_namespaces found ResultSet class $classname with no corresponding Result class -=back +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: -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. + We found ResultSet class '$rs_class' for '$result', but it seems + that you had already set '$result' to use '$rs_set' instead Both of the sub-namespaces are configurable if you don't like the defaults, via the options C and C. @@ -298,9 +108,6 @@ Result classes for which we do not find a corresponding ResultSet class will have their C set to C. -C takes care of calling C for you where -neccessary if you didn't do it for yourself. - 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<+>. @@ -350,6 +157,21 @@ sub _expand_relative_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 { + my $proto = shift; + my $ns = shift || ref $proto || $proto; + + my @mods = Module::Find::findallmod($ns); + + # try to untaint module names. 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 + return map { $_ =~ m/^( (?:\w+::)* \w+ )$/x ? $1 : $_ } @mods; +} + # returns a hash of $shortname => $fullname for every package # found in the given namespaces ($shortname is with the $fullname's # namespace stripped off) @@ -361,7 +183,7 @@ sub _map_namespaces { push( @results_hash, map { (substr($_, length "${namespace}::"), $_) } - Module::Find::findallmod($namespace) + $class->_findallmod($namespace) ); } @@ -401,13 +223,16 @@ sub load_namespaces { local *Class::C3::reinitialize = sub { }; use warnings 'redefine'; - foreach my $result (keys %results) { + # ensure classes are loaded and fetch properly sorted classes + $class->ensure_class_loaded($_) foreach(values %results); + my @subclass_last = sort { $results{$a}->isa($results{$b}) } keys(%results); + + foreach my $result (@subclass_last) { my $result_class = $results{$result}; - $class->ensure_class_loaded($result_class); - $result_class->source_name($result) unless $result_class->source_name; 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 " @@ -419,7 +244,9 @@ sub load_namespaces { $result_class->resultset_class($rs_class); } - push(@to_register, [ $result_class->source_name, $result_class ]); + my $source_name = $result_class->source_name || $result; + + push(@to_register, [ $source_name, $result_class ]); } } @@ -434,78 +261,556 @@ sub load_namespaces { return; } -=head2 compose_connection +=head2 load_classes =over 4 -=item Arguments: $target_namespace, @db_info - -=item Return Value: $new_schema +=item Arguments: @classes?, { $namespace => [ @classes ] }+ =back -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. +Alternative method to L which you should look at +using if you can. -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. +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). -=cut +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. -sub compose_connection { - my ($self, $target, @info) = @_; - my $base = 'DBIx::Class::ResultSetProxy'; - eval "require ${base};"; - $self->throw_exception - ("No arguments to load_classes and couldn't load ${base} ($@)") - if $@; +If any classes found do not appear to be Result class files, you will +get the following warning: - 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; - } + 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. - my $schema = $self->compose_namespace($target, $base); - { - no strict 'refs'; - *{"${target}::schema"} = sub { $schema }; - } +Example: - $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; -} + My::Schema->load_classes(); # loads My::Schema::CD, My::Schema::Artist, + # etc. (anything under the My::Schema namespace) -=head2 compose_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 /], + }); -=over 4 +=cut -=item Arguments: $target_namespace, $additional_base_class? +sub load_classes { + my ($class, @params) = @_; -=item Return Value: $new_schema + my %comps_for; -=back + 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') { + # more than one namespace possible + for my $comp ( keys %$param ) { + # filter out commented entries + my @modules = grep { $_ !~ /^#/ } @{$param->{$comp}}; + + push (@{$comps_for{$comp}}, @modules); + } + } + else { + # filter out commented entries + push (@{$comps_for{$class}}, $param) if $param !~ /^#/; + } + } + } else { + my @comp = map { substr $_, length "${class}::" } + $class->_findallmod; + $comps_for{$class} = \@comp; + } + + my @to_register; + { + no warnings qw/redefine/; + local *Class::C3::reinitialize = sub { }; + 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 ) { + warn "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; + + foreach my $to (@to_register) { + $class->register_class(@$to); + # if $class->can('result_source_instance'); + } +} + +=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, such as +when dealing with MSSQL via L, in which case you'd set it +to C<::DBI::Sybase::MSSQL>. + +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 exception_action + +=over 4 + +=item Arguments: $code_reference + +=item Return value: $code_reference + +=item Default value: None + +=back + +If C is set for this class/object, L +will prefer to call this code reference with the exception as an argument, +rather than L. + +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. + +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(@_) }); + + # suppress all exceptions, like a moron: + $schema_obj->exception_action(sub { 1 }); + +=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 it's 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 { shift->clone->connection(@_) } + +=head2 resultset + +=over 4 + +=item Arguments: $source_name + +=item Return Value: $resultset + +=back + + my $rs = $schema->resultset('DVD'); + +Returns the L object for the registered source +name. + +=cut + +sub resultset { + my ($self, $moniker) = @_; + return $self->source($moniker)->resultset; +} + +=head2 sources + +=over 4 + +=item Return Value: @source_names + +=back + + my @source_names = $schema->sources; + +Lists names of all the sources registered on this Schema object. + +=cut + +sub sources { return keys %{shift->source_registrations}; } + +=head2 source + +=over 4 + +=item Arguments: $source_name + +=item Return Value: $result_source + +=back + + my $source = $schema->source('Book'); + +Returns the L object for the registered +source name. + +=cut + +sub source { + my ($self, $moniker) = @_; + 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 class + +=over 4 + +=item Arguments: $source_name + +=item Return Value: $classname + +=back + + my $class = $schema->class('CD'); + +Retrieves the Result class name for the given source name. + +=cut + +sub class { + my ($self, $moniker) = @_; + return $self->source($moniker)->result_class; +} + +=head2 txn_do + +=over 4 + +=item Arguments: C<$coderef>, @coderef_args? + +=item Return Value: The return value of $coderef + +=back + +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. + +This interface is preferred over using the individual methods L, +L, and L below. + +WARNING: If you are connected with C 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 +1> to get partial rollback to work, if the storage driver for your database +supports it. + +Connecting with C 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: $source_name, \@data; + +=item Return value: \@$objects | nothing + +=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. + +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. + +Otherwise, each set of data is inserted into the database using +L, and a arrayref of the resulting row +objects is returned. + +i.e., + + $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. + +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. + +=cut + +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 connection + +=over 4 + +=item Arguments: @args + +=item Return Value: $new_schema + +=back + +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 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 = '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=>$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 Retur Value: $new_schema + +=back For each L in the schema, this method creates a class in the target namespace (e.g. $target_namespace::CD, @@ -530,15 +835,31 @@ will produce the output =cut +# 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 %reg = %{ $self->source_registrations }; - my %target; - my %map; my $schema = $self->clone; { no warnings qw/redefine/; - local *Class::C3::reinitialize = sub { }; +# local *Class::C3::reinitialize = sub { }; foreach my $moniker ($schema->sources) { my $source = $schema->source($moniker); my $target_class = "${target}::${moniker}"; @@ -548,11 +869,13 @@ sub compose_namespace { $source->result_class($target_class); $target_class->result_source_instance($source) if $target_class->can('result_source_instance'); + $schema->register_source($moniker, $source); } } - Class::C3->reinitialize(); +# Class::C3->reinitialize(); { no strict 'refs'; + no warnings 'redefine'; foreach my $meth (qw/class source resultset/) { *{"${target}::${meth}"} = sub { shift->schema->$meth(@_) }; @@ -561,337 +884,503 @@ sub compose_namespace { return $schema; } -=head2 setup_connection_class +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 Return Value: $new_schema + +=back + +Clones the schema and its associated result_source objects and returns the +copy. + +=cut + +sub clone { + my ($self) = @_; + my $clone = { (ref $self ? %$self : ()) }; + bless $clone, (ref $self || $self); + + $clone->class_mappings({ %{$clone->class_mappings} }); + $clone->source_registrations({ %{$clone->source_registrations} }); + foreach my $moniker ($self->sources) { + my $source = $self->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 + $clone->register_extra_source($moniker => $new); + } + $clone->storage->set_schema($clone) if $clone->storage; + return $clone; +} + +=head2 throw_exception =over 4 -=item Arguments: $target, @info +=item Arguments: $message =back -Sets up a database connection class to inject between the schema and the -subclasses that the schema creates. +Throws an exception. Defaults to using L to report errors from +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 setup_connection_class { - my ($class, $target, @info) = @_; - $class->inject_base($target => 'DBIx::Class::DB'); - #$target->load_components('DB'); - $target->connection(@info); +sub throw_exception { + my $self = shift; + + DBIx::Class::Exception->throw($_[0], $self->stacktrace) + if !$self->exception_action || !$self->exception_action->(@_); } -=head2 connection +=head2 deploy =over 4 -=item Arguments: @args - -=item Return Value: $new_schema +=item Arguments: $sqlt_args, $dir =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. +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. For quoting +purposes use C value with C and +C. -See L for DBI-specific syntax, -or L in general. +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 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 deploy { + my ($self, $sqltargs, $dir) = @_; + $self->throw_exception("Can't deploy without storage") unless $self->storage; + $self->storage->deploy($self, undef, $sqltargs, $dir); } -=head2 connect +=head2 deployment_statements =over 4 -=item Arguments: @info +=item Arguments: $rdbms_type, $sqlt_args, $dir -=item Return Value: $new_schema +=item Return value: $listofstatements =back -This is a convenience method. It is equivalent to calling -$schema->clone->connection(@info). See L and L for more -information. +A convenient shortcut to storage->deployment_statements(). Returns the +SQL statements used by L and +L. C<$rdbms_type> provides the +(optional) SQLT (not DBI) database driver name for which the SQL +statements are produced. If not supplied, the type is determined by +interrogating the current connection. The other two arguments are +identical to those of L. =cut -sub connect { shift->clone->connection(@_) } +sub deployment_statements { + my $self = shift; -=head2 txn_do + $self->throw_exception("Can't generate deployment statements without a storage") + if not $self->storage; -=over 4 + $self->storage->deployment_statements($self, @_); +} -=item Arguments: C<$coderef>, @coderef_args? +=head2 create_ddl_dir (EXPERIMENTAL) -=item Return Value: The return value of $coderef +=over 4 + +=item Arguments: \@databases, $version, $directory, $preversion, $sqlt_args =back -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. +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. -This interface is preferred over using the individual methods L, -L, and L below. +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". -=cut +See L for details of $sqlt_args. -sub txn_do { - my $self = shift; +If no arguments are passed, then the following default values are used: - $self->storage or $self->throw_exception - ('txn_do called on $schema without storage'); +=over 4 - $self->storage->txn_do(@_); -} +=item databases - ['MySQL', 'SQLite', 'PostgreSQL'] -=head2 txn_begin +=item version - $schema->schema_version -Begins a transaction (does nothing if AutoCommit is off). Equivalent to -calling $schema->storage->txn_begin. See -L for more information. +=item directory - './' + +=item preversion - + +=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. =cut -sub txn_begin { +sub create_ddl_dir { my $self = shift; - $self->storage or $self->throw_exception - ('txn_begin called on $schema without storage'); - - $self->storage->txn_begin; + $self->throw_exception("Can't create_ddl_dir without storage") unless $self->storage; + $self->storage->create_ddl_dir($self, @_); } -=head2 txn_commit +=head2 ddl_filename -Commits the current transaction. Equivalent to calling -$schema->storage->txn_commit. See L -for more information. +=over 4 -=cut +=item Arguments: $database-type, $version, $directory, $preversion -sub txn_commit { - my $self = shift; +=item Return value: $normalised_filename - $self->storage or $self->throw_exception - ('txn_commit called on $schema without storage'); +=back - $self->storage->txn_commit; + 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. + +=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; } -=head2 txn_rollback +=head2 thaw -Rolls back the current transaction. Equivalent to calling -$schema->storage->txn_rollback. See -L for more information. +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 txn_rollback { - my $self = shift; +sub thaw { + my ($self, $obj) = @_; + local $DBIx::Class::ResultSourceHandle::thaw_schema = $self; + return Storable::thaw($obj); +} - $self->storage or $self->throw_exception - ('txn_rollback called on $schema without storage'); +=head2 freeze - $self->storage->txn_rollback; +This doesn't actualy do anything more than call L, it is just +provided here for symetry. + +=cut + +sub freeze { + return Storable::freeze($_[1]); } -=head2 clone +=head2 dclone -=over 4 +Recommeneded way of dcloning objects. This is needed to properly maintain +references to the schema object (which itself is B cloned.) -=item Return Value: $new_schema +=cut -=back +sub dclone { + my ($self, $obj) = @_; + local $DBIx::Class::ResultSourceHandle::thaw_schema = $self; + return Storable::dclone($obj); +} -Clones the schema and its associated result_source objects and returns the -copy. +=head2 schema_version + +Returns the current schema class' $VERSION in a normalised way. =cut -sub clone { +sub schema_version { my ($self) = @_; - my $clone = { (ref $self ? %$self : ()) }; - bless $clone, (ref $self || $self); + my $class = ref($self)||$self; - foreach my $moniker ($self->sources) { - my $source = $self->source($moniker); - my $new = $source->new($source); - $clone->register_source($moniker => $new); + # 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"}; } - $clone->storage->set_schema($clone) if $clone->storage; - return $clone; + return $version; } -=head2 populate + +=head2 register_class =over 4 -=item Arguments: $moniker, \@data; +=item Arguments: $moniker, $component_class =back -Populates the source registered with the given moniker with the supplied data. -@data should be a list of listrefs -- the first containing column names, the -second matching values. +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. -i.e., +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. - $schema->populate('Artist', [ - [ qw/artistid name/ ], - [ 1, 'Popular Band' ], - [ 2, 'Indie Band' ], - ... - ]); +Registers a class which isa DBIx::Class::ResultSourceProxy. Equivalent to +calling: + + $schema->register_source($moniker, $component_class->result_source_instance); =cut -sub populate { - my ($self, $name, $data) = @_; - my $rs = $self->resultset($name); - my @names = @{shift(@$data)}; - my @created; - foreach my $item (@$data) { - my %create; - @create{@names} = @$item; - push(@created, $rs->create(\%create)); - } - return @created; +sub register_class { + my ($self, $moniker, $to_register) = @_; + $self->register_source($moniker => $to_register->result_source_instance); } -=head2 exception_action +=head2 register_source =over 4 -=item Arguments: $code_reference +=item Arguments: $moniker, $result_source =back -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 action. - -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. +This method is called by L. -Example: +Registers the L in the schema with the given +moniker. - package My::Schema; - use base qw/DBIx::Class::Schema/; - use My::ExceptionClass; - __PACKAGE__->exception_action(sub { My::ExceptionClass->throw(@_) }); - __PACKAGE__->load_classes; +=cut - # or: - my $schema_obj = My::Schema->connect( .... ); - $schema_obj->exception_action(sub { My::ExceptionClass->throw(@_) }); +sub register_source { + my $self = shift; - # suppress all exceptions, like a moron: - $schema_obj->exception_action(sub { 1 }); + $self->_register_source(@_); +} -=head2 throw_exception +=head2 register_extra_source =over 4 -=item Arguments: $message +=item Arguments: $moniker, $result_source =back -Throws an exception. Defaults to using L to report errors from -user's perspective. See L for details on overriding -this method's behavior. +As L but should be used if the result class already +has a source and you want to register an extra one. =cut -sub throw_exception { +sub register_extra_source { my $self = shift; - croak @_ if !$self->exception_action || !$self->exception_action->(@_); -} - -=head2 deploy (EXPERIMENTAL) -=over 4 + $self->_register_source(@_, { extra => 1 }); +} -=item Arguments: $sqlt_args, $dir +sub _register_source { + my ($self, $moniker, $source, $params) = @_; -=back + $source = $source->new({ %$source, source_name => $moniker }); -Attempts to deploy the schema to the current storage using L. + my %reg = %{$self->source_registrations}; + $reg{$moniker} = $source; + $self->source_registrations(\%reg); -Note that this feature is currently EXPERIMENTAL and may not work correctly -across all databases, or fully handle complex relationships. + $source->schema($self); + weaken($source->{schema}) if ref($self); + return if ($params->{extra}); -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. + if ($source->result_class) { + my %map = %{$self->class_mappings}; + if (exists $map{$source->result_class}) { + warn $source->result_class . ' already has a source, use register_extra_source for additional sources'; + } + $map{$source->result_class} = $moniker; + $self->class_mappings(\%map); + } +} -=cut +sub _unregister_source { + my ($self, $moniker) = @_; + my %reg = %{$self->source_registrations}; -sub deploy { - my ($self, $sqltargs, $dir) = @_; - $self->throw_exception("Can't deploy without storage") unless $self->storage; - $self->storage->deploy($self, undef, $sqltargs, $dir); + 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 create_ddl_dir (EXPERIMENTAL) + +=head2 compose_connection (DEPRECATED) =over 4 -=item Arguments: \@databases, $version, $directory, $sqlt_args +=item Arguments: $target_namespace, @db_info -=back +=item Return Value: $new_schema -Creates an SQL file based on the Schema, for each of the specified -database types, in the given directory. +=back -Note that this feature is currently EXPERIMENTAL and may not work correctly -across all databases, or fully handle complex relationships. +DEPRECATED. You probably wanted compose_namespace. -=cut +Actually, you probably just wanted to call connect. -sub create_ddl_dir { - my $self = shift; +=begin hidden - $self->throw_exception("Can't create_ddl_dir without storage") unless $self->storage; - $self->storage->create_ddl_dir($self, @_); -} +(hidden due to deprecation) -=head2 ddl_filename (EXPERIMENTAL) +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. - my $filename = $table->ddl_filename($type, $dir, $version) +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. -Creates a filename for a SQL file based on the table class name. Not -intended for direct end user use. +=end hidden =cut -sub ddl_filename { - my ($self, $type, $dir, $version) = @_; - - my $filename = ref($self); - $filename =~ s/::/-/; - $filename = "$dir$filename-$version-$type.sql"; - - return $filename; +{ + 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'; + my $name = join '::', $target, 'schema'; + *$name = Sub::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;