X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema.pm;h=efabcf41a26ee7129e3fa990ac9b27ba855fb2c5;hb=772547820db1ef7538e36902bd728c6afc11bde8;hp=554a0a4adaba2caca6fd0fcbaf673b25984acfad;hpb=a62cf8d4bbd7df7082e0fab3d52a45afeeb64293;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Schema.pm b/lib/DBIx/Class/Schema.pm index 554a0a4..efabcf4 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 = Library::Schema->connect($coderef_returning_dbh); - my $schema2 = My::Schema->connect( ... ); - - # 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 @@ -61,7 +61,7 @@ particular which module inherits off which. Registers a class which isa ResultSourceProxy; equivalent to calling - $schema->register_source($moniker, $class->result_source_instance); + $schema->register_source($moniker, $component_class->result_source_instance); =cut @@ -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 @@ -196,33 +196,44 @@ sub load_classes { $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 - if ($@) { - die $@ unless $@ =~ /Can't locate/; + 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}"; + eval "use $comp_class"; # If it fails, assume the user fixed it + if ($@) { + $comp_class =~ s/::/\//g; + die $@ unless $@ =~ /Can't locate.+$comp_class\.pm\sin\s\@INC/; + warn $@ if $@; + } + push(@to_register, [ $comp, $comp_class ]); } - $class->register_class($comp => $comp_class); - # if $class->can('result_source_instance'); } } + Class::C3->reinitialize; + + foreach my $to (@to_register) { + $class->register_class(@$to); + # if $class->can('result_source_instance'); + } } =head2 compose_connection =head3 Arguments: <@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. +This method 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. 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 + Library::Model::DB->class('Book') # returns Library::Model::Book, + # which ISA Library::Schema::Book This is the recommended API for accessing Schema generated classes, and using it might give you instant advantages with future versions of DBIC. @@ -273,20 +284,33 @@ sub compose_connection { return $schema; } +=head2 compose_namespace + +=head3 Arguments: + +Translates namespace into the specified namespace. + +=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/) { @@ -325,6 +349,7 @@ 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/^::/; @@ -373,31 +398,32 @@ sub txn_rollback { shift->storage->txn_rollback } =head2 txn_do -=head3 Arguments: , [@coderef_args] +=head3 Arguments: <$coderef>, [@coderef_args] -Executes with (optional) arguments <@coderef_args> transactionally, -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. +Executes C<$coderef> with (optional) arguments C<@coderef_args> +transactionally, 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. 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 ($@) { @@ -406,20 +432,23 @@ For example, die "something terrible has happened!"; } else { deal_with_failed_transaction(); - die $error; } } -Nested transactions should work as expected (i.e. only the outermost -transaction will issue a txn_commit on the Schema's storage) +Nested transactions work as expected (i.e. only the outermost +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 sub txn_do { my ($self, $coderef, @args) = @_; - ref $self or $self->throw_exception('Cannot execute txn_do as a '. - 'class method'); + ref $self or $self->throw_exception + ('Cannot execute txn_do as a class method'); + ref $coderef eq 'CODE' or $self->throw_exception + ('$coderef must be a CODE reference'); my (@return_values, $return_value); @@ -428,12 +457,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; }; @@ -487,10 +522,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' ], ... ]); @@ -500,11 +535,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 @@ -518,6 +555,21 @@ sub throw_exception { croak @_; } +=head2 deploy (EXPERIMENTAL) + +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, $sqltargs) = @_; + $self->throw_exception("Can't deploy without storage") unless $self->storage; + $self->storage->deploy($self, undef, $sqltargs); +} + 1; =head1 AUTHORS