X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema.pm;h=4478d6fa3775e038b225d52d87d3c7004d7d306a;hb=1c32fcf0404c47e7cd43de68c9a93792b0d1598a;hp=0b92c116d5fd51a62430c003cc169b6199b42f8c;hpb=7a58f051d9b201fd50c1ee43c0ca9602523ca66b;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Schema.pm b/lib/DBIx/Class/Schema.pm index 0b92c11..4478d6f 100644 --- a/lib/DBIx/Class/Schema.pm +++ b/lib/DBIx/Class/Schema.pm @@ -5,6 +5,7 @@ use warnings; use Carp::Clan qw/^DBIx::Class/; use Scalar::Util qw/weaken/; +use File::Spec; require Module::Find; use base qw/DBIx::Class/; @@ -93,10 +94,15 @@ moniker. sub register_source { my ($self, $moniker, $source) = @_; + + %$source = %{ $source->new( { %$source, source_name => $moniker }) }; + 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}; @@ -105,6 +111,19 @@ sub register_source { } } +sub _unregister_source { + my ($self, $moniker) = @_; + my %reg = %{$self->source_registrations}; + + my $source = delete $reg{$moniker}; + $self->source_registrations(\%reg); + if ($source->result_class) { + my %map = %{$self->class_mappings}; + delete $map{$source->result_class}; + $self->class_mappings(\%map); + } +} + =head2 class =over 4 @@ -171,6 +190,12 @@ For example: sub sources { return keys %{shift->source_registrations}; } +=head2 storage + + my $storage = $schema->storage; + +Returns the L object for this Schema. + =head2 resultset =over 4 @@ -261,10 +286,18 @@ sub load_classes { foreach my $prefix (keys %comps_for) { foreach my $comp (@{$comps_for{$prefix}||[]}) { my $comp_class = "${prefix}::${comp}"; + { # try to untaint module name. mods where this fails + # are left alone so we don't have to change the old behavior + no locale; # localized \w doesn't untaint expression + if ( $comp_class =~ m/^( (?:\w+::)* \w+ )$/x ) { + $comp_class = $1; + } + } $class->ensure_class_loaded($comp_class); - $comp_class->source_name($comp) unless $comp_class->source_name; - push(@to_register, [ $comp_class->source_name, $comp_class ]); + $comp = $comp_class->source_name || $comp; +# $DB::single = 1; + push(@to_register, [ $comp, $comp_class ]); } } } @@ -285,23 +318,21 @@ sub load_classes { =back This is an alternative to L above which assumes an alternative -layout for automatic class loading. It assumes that all source-definition -classes are underneath a sub-namespace of the schema called C, any +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, and any corresponding Result classes are underneath a -sub-namespace of the schema called C. +called C. -All of those sub-namespaces are configurable if you don't like the defaults, -via the options C, C, and -C, respectively. +Both of the sub-namespaces are configurable if you don't like the defaults, +via the options C and C. If (and only if) you specify the option C, any found -source-definition classes for which we do not find a corresponding +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 and/or -C for you where neccessary if you didn't do it for yourself. +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 @@ -309,34 +340,34 @@ it with a literal C<+>. Examples: - # load My::Schema::Source::CD, My::Schema::Source::Artist, + # load My::Schema::Result::CD, My::Schema::Result::Artist, # My::Schema::ResultSet::CD, etc... My::Schema->load_namespaces; - # Override everything... + # 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( - source_namespace => 'Srcs', + result_namespace => 'Res', resultset_namespace => 'RSets', - result_namespace => 'Results', default_resultset_class => 'RSetBase', ); - # In the above, if there is a My::Schema::Srcs::Foo, but no matching - # My::Schema::RSets::Foo, then the Foo source will have its - # resultset_class set to My::Schema::RSetBase # Put things in other namespaces My::Schema->load_namespaces( - source_namespace => '+Some::Place::Sources', + result_namespace => '+Some::Place::Results', resultset_namespace => '+Another::Place::RSets', ); If you'd like to use multiple namespaces of each type, simply use an arrayref -of namespaces for that option. In the case that the same source-definition -(or resultset, or result) class exists in multiple namespaces, the latter -entries in your list of namespaces will override earlier ones. +of namespaces for that option. In the case that the same result +(or resultset) class exists in multiple namespaces, the latter entries in +your list of namespaces will override earlier ones. My::Schema->load_namespaces( - source_namespace => [ 'Sources_C', 'Sources_B', 'Sources_A' ], + # 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' ], ); @@ -373,9 +404,8 @@ sub _map_namespaces { sub load_namespaces { my ($class, %args) = @_; - my $source_namespace = delete $args{source_namespace} || 'Source'; - my $resultset_namespace = delete $args{resultset_namespace} || 'ResultSet'; 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}; $class->throw_exception('load_namespaces: unknown option(s): ' @@ -385,7 +415,7 @@ sub load_namespaces { $default_resultset_class = $class->_expand_relative_name($default_resultset_class); - for my $arg ($source_namespace, $resultset_namespace, $result_namespace) { + for my $arg ($result_namespace, $resultset_namespace) { $arg = [ $arg ] if !ref($arg) && $arg; $class->throw_exception('load_namespaces: namespace arguments must be ' @@ -395,9 +425,8 @@ sub load_namespaces { $_ = $class->_expand_relative_name($_) for (@$arg); } - my %sources = $class->_map_namespaces(@$source_namespace); - my %resultsets = $class->_map_namespaces(@$resultset_namespace); my %results = $class->_map_namespaces(@$result_namespace); + my %resultsets = $class->_map_namespaces(@$resultset_namespace); my @to_register; { @@ -405,49 +434,31 @@ sub load_namespaces { local *Class::C3::reinitialize = sub { }; use warnings 'redefine'; - foreach my $source (keys %sources) { - my $source_class = $sources{$source}; - $class->ensure_class_loaded($source_class); - $source_class->source_name($source) unless $source_class->source_name; + foreach my $result (keys %results) { + my $result_class = $results{$result}; + $class->ensure_class_loaded($result_class); + $result_class->source_name($result) unless $result_class->source_name; - my $rs_class = delete $resultsets{$source}; - my $rs_set = $source_class->resultset_class; + 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 '$source', but it seems " - . "that you had already set '$source' to use '$rs_set' instead"; + warn "We found ResultSet class '$rs_class' for '$result', but it seems " + . "that you had already set '$result' to use '$rs_set' instead"; } } elsif($rs_class ||= $default_resultset_class) { $class->ensure_class_loaded($rs_class); - $source_class->resultset_class($rs_class); + $result_class->resultset_class($rs_class); } - my $r_class = delete $results{$source}; - if($r_class) { - my $r_set = $source_class->result_class; - if(!$r_set || $r_set eq $sources{$source}) { - $class->ensure_class_loaded($r_class); - $source_class->result_class($r_class); - } - elsif($r_set ne $r_class) { - warn "We found Result class '$r_class' for '$source', but it seems " - . "that you had already set '$source' to use '$r_set' instead"; - } - } - - push(@to_register, [ $source_class->source_name, $source_class ]); + push(@to_register, [ $result_class->source_name, $result_class ]); } } foreach (sort keys %resultsets) { warn "load_namespaces found ResultSet class $_ with no " - . 'corresponding source-definition class'; - } - - foreach (sort keys %results) { - warn "load_namespaces found Result class $_ with no " - . 'corresponding source-definition class'; + . 'corresponding Result class'; } Class::C3->reinitialize; @@ -456,7 +467,7 @@ sub load_namespaces { return; } -=head2 compose_connection +=head2 compose_connection (DEPRECATED) =over 4 @@ -466,6 +477,12 @@ sub load_namespaces { =back +DEPRECATED. You probably wanted compose_namespace. + +Actually, you probably just wanted to call connect. + +=for 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 @@ -480,43 +497,50 @@ more information. =cut -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 ($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 $warn; + + sub compose_connection { + my ($self, $target, @info) = @_; + + warn "compose_connection deprecated as of 0.08000" unless $warn++; + + my $base = 'DBIx::Class::ResultSetProxy'; + eval "require ${base};"; + $self->throw_exception + ("No arguments to load_classes and couldn't load ${base} ($@)") + if $@; + + if ($self eq $target) { + # Pathological case, largely caused by the docs on early C::M::DBIC::Plain + foreach my $moniker ($self->sources) { + my $source = $self->source($moniker); + my $class = $source->result_class; + $self->inject_base($class, $base); + $class->mk_classdata(resultset_instance => $source->resultset); + $class->mk_classdata(class_resolver => $self); + } + $self->connection(@info); + return $self; + } + + my $schema = $self->compose_namespace($target, $base); + { + no strict 'refs'; + *{"${target}::schema"} = sub { $schema }; + } + + $schema->connection(@info); + foreach my $moniker ($schema->sources) { + my $source = $schema->source($moniker); my $class = $source->result_class; - $self->inject_base($class, $base); + #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 => $self); + $class->mk_classdata(class_resolver => $schema); } - $self->connection(@info); - return $self; + return $schema; } - - my $schema = $self->compose_namespace($target, $base); - { - no strict 'refs'; - *{"${target}::schema"} = sub { $schema }; - } - - $schema->connection(@info); - foreach my $moniker ($schema->sources) { - my $source = $schema->source($moniker); - my $class = $source->result_class; - #warn "$moniker $class $source ".$source->storage; - $class->mk_classdata(result_source_instance => $source); - $class->mk_classdata(resultset_instance => $source->resultset); - $class->mk_classdata(class_resolver => $schema); - } - return $schema; } =head2 compose_namespace @@ -603,6 +627,26 @@ sub setup_connection_class { $target->connection(@info); } +=head2 storage_type + +=over 4 + +=item Arguments: $storage_type + +=item Return Value: $storage_type + +=back + +Set the storage class that will be instantiated when L is called. +If the classname starts with C<::>, the prefix C is +assumed by L. Defaults to C<::DBI>, +which is L. + +You want to use this to hardcoded subclasses of L +in cases where the appropriate subclass is not autodetected, such as when +dealing with MSSQL via L, in which case you'd set it to +C<::DBI::Sybase::MSSQL>. + =head2 connection =over 4 @@ -615,8 +659,10 @@ sub setup_connection_class { Instantiates a new Storage object of type L and passes the arguments to -$storage->connect_info. Sets the connection in-place on the schema. See -L for more information. +$storage->connect_info. Sets the connection in-place on the schema. + +See L for DBI-specific syntax, +or L in general. =cut @@ -633,6 +679,7 @@ sub connection { my $storage = $storage_class->new($self); $storage->connect_info(\@info); $self->storage($storage); + $self->on_connect() if($self->can('on_connect')); return $self; } @@ -654,138 +701,83 @@ information. sub connect { shift->clone->connection(@_) } -=head2 txn_begin - -Begins a transaction (does nothing if AutoCommit is off). Equivalent to -calling $schema->storage->txn_begin. See -L for more information. +=head2 txn_do -=cut +=over 4 -sub txn_begin { shift->storage->txn_begin } +=item Arguments: C<$coderef>, @coderef_args? -=head2 txn_commit +=item Return Value: The return value of $coderef -Commits the current transaction. Equivalent to calling -$schema->storage->txn_commit. See L -for more information. +=back -=cut +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. -sub txn_commit { shift->storage->txn_commit } +This interface is preferred over using the individual methods L, +L, and L below. -=head2 txn_rollback +=cut -Rolls back the current transaction. Equivalent to calling -$schema->storage->txn_rollback. See -L for more information. +sub txn_do { + my $self = shift; -=cut + $self->storage or $self->throw_exception + ('txn_do called on $schema without storage'); -sub txn_rollback { shift->storage->txn_rollback } + $self->storage->txn_do(@_); +} -=head2 txn_do +=head2 txn_begin -=over 4 +Begins a transaction (does nothing if AutoCommit is off). Equivalent to +calling $schema->storage->txn_begin. See +L for more information. -=item Arguments: C<$coderef>, @coderef_args? +=cut -=item Return Value: The return value of $coderef +sub txn_begin { + my $self = shift; -=back + $self->storage or $self->throw_exception + ('txn_begin called on $schema without storage'); -Executes C<$coderef> with (optional) arguments C<@coderef_args> atomically, -returning its result (if any). If an exception is caught, a rollback is issued -and the exception is rethrown. If the rollback fails, (i.e. throws an -exception) an exception is thrown that includes a "Rollback failed" message. + $self->storage->txn_begin; +} -For example, +=head2 txn_commit - my $author_rs = $schema->resultset('Author')->find(1); - my @titles = qw/Night Day It/; +Commits the current transaction. Equivalent to calling +$schema->storage->txn_commit. See L +for more information. - my $coderef = sub { - # If any one of these fails, the entire transaction fails - $author_rs->create_related('books', { - title => $_ - }) foreach (@titles); +=cut - return $author->books; - }; +sub txn_commit { + my $self = shift; - my $rs; - eval { - $rs = $schema->txn_do($coderef); - }; + $self->storage or $self->throw_exception + ('txn_commit called on $schema without storage'); - if ($@) { # Transaction failed - die "something terrible has happened!" # - if ($@ =~ /Rollback failed/); # Rollback failed + $self->storage->txn_commit; +} - deal_with_failed_transaction(); - } +=head2 txn_rollback -In a nested transaction (calling txn_do() from within a txn_do() coderef) only -the outermost transaction will issue a L on -the Schema's storage, and txn_do() can be called in void, scalar and list -context and it will behave as expected. +Rolls back the current transaction. Equivalent to calling +$schema->storage->txn_rollback. See +L for more information. =cut -sub txn_do { - my ($self, $coderef, @args) = @_; +sub txn_rollback { + my $self = shift; $self->storage or $self->throw_exception - ('txn_do called on $schema without storage'); - ref $coderef eq 'CODE' or $self->throw_exception - ('$coderef must be a CODE reference'); - - my (@return_values, $return_value); - - $self->txn_begin; # If this throws an exception, no rollback is needed - - my $wantarray = wantarray; # Need to save this since the context - # inside the eval{} block is independent - # of the context that called txn_do() - eval { - - # Need to differentiate between scalar/list context to allow for - # returning a list in scalar context to get the size of the list - if ($wantarray) { - # list context - @return_values = $coderef->(@args); - } elsif (defined $wantarray) { - # scalar context - $return_value = $coderef->(@args); - } else { - # void context - $coderef->(@args); - } - $self->txn_commit; - }; - - if ($@) { - my $error = $@; - - eval { - $self->txn_rollback; - }; - - if ($@) { - my $rollback_error = $@; - my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION"; - $self->throw_exception($error) # propagate nested rollback - if $rollback_error =~ /$exception_class/; - - $self->throw_exception( - "Transaction aborted: $error. Rollback failed: ${rollback_error}" - ); - } else { - $self->throw_exception($error); # txn failed but rollback succeeded - } - } + ('txn_rollback called on $schema without storage'); - return $wantarray ? @return_values : $return_value; + $self->storage->txn_rollback; } =head2 clone @@ -803,7 +795,9 @@ copy. sub clone { my ($self) = @_; - my $clone = bless({ (ref $self ? %$self : ()) }, ref $self || $self); + my $clone = { (ref $self ? %$self : ()) }; + bless $clone, (ref $self || $self); + foreach my $moniker ($self->sources) { my $source = $self->source($moniker); my $new = $source->new($source); @@ -817,13 +811,22 @@ sub clone { =over 4 -=item Arguments: $moniker, \@data; +=item Arguments: $source_name, \@data; =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. +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., @@ -840,13 +843,16 @@ 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)); + if(defined wantarray) { + my @created; + foreach my $item (@$data) { + my %create; + @create{@names} = @$item; + push(@created, $rs->create(\%create)); + } + return @created; } - return @created; + $self->storage->insert_bulk($self->source($name), \@names, $data); } =head2 exception_action @@ -904,45 +910,74 @@ sub throw_exception { =over 4 -=item Arguments: $sqlt_args +=item Arguments: $sqlt_args, $dir =back Attempts to deploy the schema to the current storage using L. Note that this feature is currently EXPERIMENTAL and may not work correctly -across all databases, or fully handle complex relationships. +across all databases, or fully handle complex relationships. Saying that, it +has been used successfully by many people, including the core dev team. 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. +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. + =cut sub deploy { - my ($self, $sqltargs) = @_; + my ($self, $sqltargs, $dir) = @_; $self->throw_exception("Can't deploy without storage") unless $self->storage; - $self->storage->deploy($self, undef, $sqltargs); + $self->storage->deploy($self, undef, $sqltargs, $dir); } =head2 create_ddl_dir (EXPERIMENTAL) =over 4 -=item Arguments: \@databases, $version, $directory, $sqlt_args +=item Arguments: \@databases, $version, $directory, $preversion, $sqlt_args =back Creates an SQL file based on the Schema, for each of the specified -database types, in the given directory. +database types, in the given directory. Given a previous version number, +this will also create a file containing the ALTER TABLE statements to +transform the previous schema into the current one. Note that these +statements may contain DROP TABLE or DROP COLUMN statements that can +potentially destroy data. + +The file names are created using the C method below, please +override this method in your schema if you would like a different file +name format. For the ALTER file, the same format is used, replacing +$version in the name with "$preversion-$version". + +If no arguments are passed, then the following default values are used: + +=over 4 + +=item databases - ['MySQL', 'SQLite', 'PostgreSQL'] + +=item version - $schema->VERSION + +=item directory - './' + +=item preversion - + +=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 create_ddl_dir -{ +sub create_ddl_dir { my $self = shift; $self->throw_exception("Can't create_ddl_dir without storage") unless $self->storage; @@ -951,20 +986,30 @@ sub create_ddl_dir =head2 ddl_filename (EXPERIMENTAL) - my $filename = $table->ddl_filename($type, $dir, $version) +=over 4 + +=item Arguments: $directory, $database-type, $version, $preversion + +=back -Creates a filename for a SQL file based on the table class name. Not -intended for direct end user use. + my $filename = $table->ddl_filename($type, $dir, $version, $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, $dir, $version) = @_; +sub ddl_filename { + my ($self, $type, $dir, $version, $pversion) = @_; my $filename = ref($self); $filename =~ s/::/-/; - $filename = "$dir$filename-$version-$type.sql"; + $filename = File::Spec->catfile($dir, "$filename-$version-$type.sql"); + $filename =~ s/$version/$pversion-$version/ if($pversion); return $filename; } @@ -980,4 +1025,3 @@ Matt S. Trout You may distribute this code under the same terms as Perl itself. =cut -