X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema.pm;h=fc28f790a918ce139721658e2c76eafe2e29796f;hb=3f34147465dbc402336f143fce45c98fc178beb1;hp=65c235c2cb2d3a09fbcc40a437c2d0eb9624e5f1;hpb=e6efde04063f1374151f9f76ef1e7c23a045e91e;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Schema.pm b/lib/DBIx/Class/Schema.pm index 65c235c..fc28f79 100644 --- a/lib/DBIx/Class/Schema.pm +++ b/lib/DBIx/Class/Schema.pm @@ -18,30 +18,30 @@ DBIx::Class::Schema - composable schemas =head1 SYNOPSIS - package My::Schema; + package Library::Schema; use base qw/DBIx::Class::Schema/; - # load My::Schema::Foo, My::Schema::Bar, My::Schema::Baz - __PACKAGE__->load_classes(qw/Foo Bar Baz/); + # load Library::Schema::CD, Library::Schema::Book, Library::Schema::DVD + __PACKAGE__->load_classes(qw/CD Book DVD/); - package My::Schema::Foo; + package Library::Schema::CD; use base qw/DBIx::Class/; - __PACKAGE__->load_components(qw/PK::Auto::Pg Core/); # for example - __PACKAGE__->table('foo'); + __PACKAGE__->load_components(qw/PK::Auto Core/); # for example + __PACKAGE__->table('cd'); # Elsewhere in your code: - my $schema1 = My::Schema->connect( + my $schema1 = Library::Schema->connect( $dsn, $user, $password, - $attrs + { AutoCommit => 0 }, ); - my $schema2 = My::Schema->connect($coderef_returning_dbh); + my $schema2 = Library::Schema->connect($coderef_returning_dbh); - # fetch objects using My::Schema::Foo - my $resultset = $schema1->resultset('Foo')->search( ... ); - my @objects = $schema2->resultset('Foo')->search( ... ); + # fetch objects using Library::Schema::DVD + my $resultset = $schema1->resultset('DVD')->search( ... ); + my @dvd_objects = $schema2->resultset('DVD')->search( ... ); =head1 DESCRIPTION @@ -93,7 +93,7 @@ sub register_source { =head2 class - my $class = $schema->class('Foo'); + my $class = $schema->class('CD'); Retrieves the result class name for a given result source @@ -106,7 +106,7 @@ sub class { =head2 source - my $source = $schema->source('Foo'); + my $source = $schema->source('Book'); Returns the result source object for the registered name @@ -136,7 +136,7 @@ sub sources { return keys %{shift->source_registrations}; } =head2 resultset - my $rs = $schema->resultset('Foo'); + my $rs = $schema->resultset('DVD'); Returns the resultset for the registered moniker @@ -149,7 +149,7 @@ sub resultset { =head2 load_classes -=head3 Arguments: [, (, ), { => []}] +=head3 Arguments: @classes?, { $namespace => [ $class+ ] }+ Uses L to find all classes under the database class' namespace, or uses the classes you select. Then it loads the component (using L), @@ -190,9 +190,11 @@ sub load_classes { } } else { eval "require Module::Find;"; - $class->throw_exception("No arguments to load_classes and couldn't load". - " Module::Find ($@)") if $@; - my @comp = map { substr $_, length "${class}::" } Module::Find::findallmod($class); + $class->throw_exception( + "No arguments to load_classes and couldn't load Module::Find ($@)" + ) if $@; + my @comp = map { substr $_, length "${class}::" } + Module::Find::findallmod($class); $comps_for{$class} = \@comp; } @@ -205,7 +207,9 @@ sub load_classes { my $comp_class = "${prefix}::${comp}"; eval "use $comp_class"; # If it fails, assume the user fixed it if ($@) { - die $@ unless $@ =~ /Can't locate/; + $comp_class =~ s/::/\//g; + die $@ unless $@ =~ /Can't locate.+$comp_class\.pm\sin\s\@INC/; + warn $@ if $@; } push(@to_register, [ $comp, $comp_class ]); } @@ -221,27 +225,16 @@ sub load_classes { =head2 compose_connection -=head3 Arguments: <@db_info> +=head3 Arguments: $target_ns, @db_info -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. +=head3 Return value: $new_schema -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 - - MyApp::DB->class('Foo') # returns MyApp::DB::Foo, - # which ISA MyApp::Schema::Foo - -This is the recommended API for accessing Schema generated classes, and -using it might give you instant advantages with future versions of DBIC. - -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. +Calls compose_namespace to the $target_ns, calls ->connection(@db_info) on +the new schema, then injects the ResultSetProxy component and a +resultset_instance classdata entry on all the new classes in order to support +$target_ns::Class->search(...) method calls. Primarily useful when you have +a specific need for classmethod access to a connection - in normal usage +->connect is preferred. =cut @@ -249,8 +242,9 @@ 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 $@; + $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 @@ -283,20 +277,40 @@ sub compose_connection { return $schema; } +=head2 compose_namespace + +=head3 Arguments: $target_ns, $additional_base_class? + +=head3 Return value: $new_schema + +For each result source in the schema, creates a class in the target +namespace (e.g. $target_ns::CD, $target_ns::Artist) inheriting from the +corresponding classes attached to the current schema and a result source +to match attached to the new $schema object. If an additional base class is +given, injects this immediately behind the corresponding classes from the +current schema in the created classes' @ISA. + +=cut + sub compose_namespace { my ($self, $target, $base) = @_; my %reg = %{ $self->source_registrations }; my %target; my %map; 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); + { + no warnings qw/redefine/; + local *Class::C3::reinitialize = sub { }; + foreach my $moniker ($schema->sources) { + my $source = $schema->source($moniker); + my $target_class = "${target}::${moniker}"; + $self->inject_base( + $target_class => $source->result_class, ($base ? $base : ()) + ); + $source->result_class($target_class); + } } + Class::C3->reinitialize(); { no strict 'refs'; foreach my $meth (qw/class source resultset/) { @@ -335,12 +349,14 @@ the schema. 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 $@; + $self->throw_exception( + "No arguments to load_classes and couldn't load ${storage_class} ($@)" + ) if $@; my $storage = $storage_class->new; $storage->connect_info(\@info); $self->storage($storage); @@ -383,7 +399,7 @@ sub txn_rollback { shift->storage->txn_rollback } =head2 txn_do -=head3 Arguments: <$coderef>, [@coderef_args] +=head3 Arguments: $coderef, @coderef_args? Executes C<$coderef> with (optional) arguments C<@coderef_args> transactionally, returning its result (if any). If an exception is @@ -393,22 +409,22 @@ includes a "Rollback failed" message. For example, - my $foo = $schema->resultset('foo')->find(1); + my $author_rs = $schema->resultset('Author')->find(1); my $coderef = sub { - my ($foo, @bars) = @_; + my ($author, @titles) = @_; # If any one of these fails, the entire transaction fails - $foo->create_related('bars', { - col => $_ - }) foreach (@bars); + $author->create_related('books', { + title => $_ + }) foreach (@titles); - return $foo->bars; + return $author->books; }; my $rs; eval { - $rs = $schema->txn_do($coderef, $foo, qw/foo bar baz/); + $rs = $schema->txn_do($coderef, $author_rs, qw/Night Day It/); }; if ($@) { @@ -417,12 +433,13 @@ For example, die "something terrible has happened!"; } else { deal_with_failed_transaction(); - die $error; } } Nested transactions work as expected (i.e. only the outermost -transaction will issue a txn_commit on the Schema's storage) +transaction will issue a txn_commit on the Schema's storage), and +txn_do() can be called in void, scalar and list context and it will +behave as expected. =cut @@ -441,12 +458,18 @@ sub txn_do { my $wantarray = wantarray; # Need to save this since it's reset in eval{} eval { - # Need to differentiate between scalar/list context to allow for returning - # a list in scalar context to get the size of the list + # 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); - } else { + } elsif (defined $wantarray) { + # scalar context $return_value = $coderef->(@args); + } else { + # void context + $coderef->(@args); } $self->txn_commit; }; @@ -464,8 +487,9 @@ sub txn_do { $self->throw_exception($error) # propagate nested rollback if $rollback_error =~ /$exception_class/; - $self->throw_exception("Transaction aborted: $error. Rollback failed: ". - $rollback_error); + $self->throw_exception( + "Transaction aborted: $error. Rollback failed: ${rollback_error}" + ); } else { $self->throw_exception($error); # txn failed but rollback succeeded } @@ -500,10 +524,10 @@ 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 - i.e. - $schema->populate('Foo', [ - [ qw/foo_id foo_string/ ], - [ 1, 'One' ], - [ 2, 'Two' ], + $schema->populate('Artist', [ + [ qw/artistid name/ ], + [ 1, 'Popular Band' ], + [ 2, 'Indie Band' ], ... ]); @@ -513,11 +537,13 @@ 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; - $rs->create(\%create); + push(@created, $rs->create(\%create)); } + return @created; } =head2 throw_exception @@ -531,16 +557,19 @@ sub throw_exception { croak @_; } -=head2 deploy +=head2 deploy (EXPERIMENTAL) -Attempts to deploy the schema to the current storage +Attempts to deploy the schema to the current storage using SQL::Translator. + +Note that this feature is currently EXPERIMENTAL and may not work correctly +across all databases, or fully handle complex relationships. =cut sub deploy { - my ($self) = shift; + my ($self, $sqltargs) = @_; $self->throw_exception("Can't deploy without storage") unless $self->storage; - $self->storage->deploy($self); + $self->storage->deploy($self, undef, $sqltargs); } 1;