X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits%2FDBIx-Class.git;a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema.pm;h=09edb9b21bfb57c23e4d8342a9bfe060e3c39db0;hp=7df9d5f4c9ec2e2884240b8b9934200ceda5fe2c;hb=4146e3dae3771b13b83eb1ba124ba74287f83dcd;hpb=eeb342281b10acf6f60b6e5f5f62d365c314a5aa diff --git a/lib/DBIx/Class/Schema.pm b/lib/DBIx/Class/Schema.pm index 7df9d5f..09edb9b 100644 --- a/lib/DBIx/Class/Schema.pm +++ b/lib/DBIx/Class/Schema.pm @@ -3,7 +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; +require Module::Find; use base qw/DBIx::Class/; @@ -11,6 +15,9 @@ __PACKAGE__->mk_classdata('class_mappings' => {}); __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 @@ -18,30 +25,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/); - package My::Schema::Foo; + # load Library::Schema::CD, Library::Schema::Book, Library::Schema::DVD + __PACKAGE__->load_classes(qw/CD Book DVD/); + + 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); - # fetch objects using My::Schema::Foo - my $resultset = $schema1->resultset('Foo')->search( ... ); - my @objects = $schema2->resultset('Foo')->search( ... ); + my $schema2 = Library::Schema->connect($coderef_returning_dbh); + + # fetch objects using Library::Schema::DVD + my $resultset = $schema1->resultset('DVD')->search( ... ); + my @dvd_objects = $schema2->resultset('DVD')->search( ... ); =head1 DESCRIPTION @@ -50,16 +57,21 @@ use L and allows you to use more than one concurrent connection with your classes. NB: If you're used to L it's worth reading the L -carefully as DBIx::Class does things a little differently. Note in +carefully, as DBIx::Class does things a little differently. Note in particular which module inherits off which. =head1 METHODS =head2 register_class -=head3 Arguments: +=over 4 + +=item Arguments: $moniker, $component_class -Registers a class which isa ResultSourceProxy; equivalent to calling +=back + +Registers a class which isa DBIx::Class::ResultSourceProxy. Equivalent to +calling: $schema->register_source($moniker, $component_class->result_source_instance); @@ -72,30 +84,62 @@ sub register_class { =head2 register_source -=head3 Arguments: +=over 4 + +=item Arguments: $moniker, $result_source -Registers the result source in the schema with the given moniker +=back + +Registers the L in the schema with the given +moniker. =cut 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}; $map{$source->result_class} = $moniker; $self->class_mappings(\%map); } -} +} + +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 - my $class = $schema->class('Foo'); +=over 4 -Retrieves the result class name for a given result source +=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 @@ -106,9 +150,17 @@ sub class { =head2 source - my $source = $schema->source('Foo'); +=over 4 + +=item Arguments: $moniker + +=item Return Value: $result_source + +=back + + my $source = $schema->source('Book'); -Returns the result source object for the registered name +Returns the L object for the registered moniker. =cut @@ -126,19 +178,40 @@ sub source { =head2 sources - my @source_monikers = $schema->sources; +=over 4 + +=item Return Value: @source_monikers + +=back + +Returns the source monikers of all source registrations on this schema. +For example: -Returns the source monikers of all source registrations on this schema + my @source_monikers = $schema->sources; =cut sub sources { return keys %{shift->source_registrations}; } +=head2 storage + + my $storage = $schema->storage; + +Returns the L object for this Schema. + =head2 resultset - my $rs = $schema->resultset('Foo'); +=over 4 -Returns the resultset for the registered moniker +=item Arguments: $moniker + +=item Return Value: $result_set + +=back + + my $rs = $schema->resultset('DVD'); + +Returns the L object for the registered moniker. =cut @@ -149,29 +222,44 @@ sub resultset { =head2 load_classes -=head3 Arguments: [, (, ), { => []}] +=over 4 + +=item Arguments: @classes?, { $namespace => [ @classes ] }+ + +=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: -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); + My::Schema->load_classes(); # loads My::Schema::CD, My::Schema::Artist, + # etc. (anything under the My::Schema namespace) -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. + # 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') { @@ -189,10 +277,8 @@ 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); + my @comp = map { substr $_, length "${class}::" } + Module::Find::findallmod($class); $comps_for{$class} = \@comp; } @@ -203,12 +289,17 @@ sub load_classes { 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 $@; + { # 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 = $comp_class->source_name || $comp; +# $DB::single = 1; push(@to_register, [ $comp, $comp_class ]); } } @@ -221,75 +312,280 @@ sub load_classes { } } -=head2 compose_connection +=head2 load_namespaces + +=over 4 + +=item Arguments: %options? -=head3 Arguments: <@db_info> +=back -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 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. -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 +Both of the sub-namespaces are configurable if you don't like the defaults, +via the options C and C. - MyApp::DB->class('Foo') # returns MyApp::DB::Foo, - # which ISA MyApp::Schema::Foo +If (and only if) you specify the option C, any found +Result classes for which we do not find a corresponding +ResultSet class will have their C set to +C. -This is the recommended API for accessing Schema generated classes, and -using it might give you instant advantages with future versions of DBIC. +C takes care of calling C for you where +neccessary if you didn't do it for yourself. -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. +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<+>. + +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', + ); + +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 result +(or resultset) class exists in multiple namespaces, the latter entries in +your 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 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 $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; +# 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) = @_; + return if !$name; + $name = $class . '::' . $name if ! ($name =~ s/^\+//); + return $name; +} + +# 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 ($class, @namespaces) = @_; + + my @results_hash; + foreach my $namespace (@namespaces) { + push( + @results_hash, + map { (substr($_, length "${namespace}::"), $_) } + Module::Find::findallmod($namespace) + ); + } + + @results_hash; +} + +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}; + + $class->throw_exception('load_namespaces: unknown option(s): ' + . join(q{,}, map { qq{'$_'} } keys %args)) + if scalar keys %args; + + $default_resultset_class + = $class->_expand_relative_name($default_resultset_class); + + for my $arg ($result_namespace, $resultset_namespace) { + $arg = [ $arg ] if !ref($arg) && $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 $schema = $self->compose_namespace($target, $base); + my %results = $class->_map_namespaces(@$result_namespace); + my %resultsets = $class->_map_namespaces(@$resultset_namespace); + + my @to_register; { - no strict 'refs'; - *{"${target}::schema"} = sub { $schema }; + no warnings 'redefine'; + local *Class::C3::reinitialize = sub { }; + use warnings 'redefine'; + + 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{$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 " + . "that you had already set '$result' to use '$rs_set' instead"; + } + } + elsif($rs_class ||= $default_resultset_class) { + $class->ensure_class_loaded($rs_class); + $result_class->resultset_class($rs_class); + } + + push(@to_register, [ $result_class->source_name, $result_class ]); + } } - $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); + foreach (sort keys %resultsets) { + warn "load_namespaces found ResultSet class $_ with no " + . 'corresponding Result class'; + } + + Class::C3->reinitialize; + $class->register_class(@$_) for (@to_register); + + return; +} + +=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 + +{ + 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'; + *{"${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; } - return $schema; } +=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 classe 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 %reg = %{ $self->source_registrations }; - my %target; - my %map; my $schema = $self->clone; { no warnings qw/redefine/; @@ -301,11 +597,14 @@ sub compose_namespace { $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'); } } Class::C3->reinitialize(); { no strict 'refs'; + no warnings 'redefine'; foreach my $meth (qw/class source resultset/) { *{"${target}::${meth}"} = sub { shift->schema->$meth(@_) }; @@ -316,10 +615,14 @@ sub compose_namespace { =head2 setup_connection_class -=head3 Arguments: <$target> <@info> +=over 4 + +=item Arguments: $target, @info -Sets up a database connection class to inject between the schema -and the subclasses the schema creates. +=back + +Sets up a database connection class to inject between the schema and the +subclasses that the schema creates. =cut @@ -330,13 +633,42 @@ 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 -=head3 Arguments: (@args) +=over 4 + +=item Arguments: @args -Instantiates a new Storage object of type storage_type and passes the -arguments to $storage->connect_info. Sets the connection in-place on -the schema. +=item Return Value: $new_schema + +=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. + +See L for DBI-specific syntax, +or L in general. =cut @@ -347,9 +679,10 @@ sub connection { $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->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; @@ -357,139 +690,109 @@ sub connection { =head2 connect -=head3 Arguments: (@info) - -Conveneience method, equivalent to $schema->clone->connection(@info) +=over 4 -=cut +=item Arguments: @info -sub connect { shift->clone->connection(@_) } +=item Return Value: $new_schema -=head2 txn_begin +=back -Begins a transaction (does nothing if AutoCommit is off). +This is a convenience method. It is equivalent to calling +$schema->clone->connection(@info). See L and L for more +information. =cut -sub txn_begin { shift->storage->txn_begin } +sub connect { shift->clone->connection(@_) } -=head2 txn_commit +=head2 txn_do -Commits the current transaction. +=over 4 -=cut +=item Arguments: C<$coderef>, @coderef_args? -sub txn_commit { shift->storage->txn_commit } +=item Return Value: The return value of $coderef -=head2 txn_rollback +=back -Rolls back the current transaction. +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. -=cut +This interface is preferred over using the individual methods L, +L, and L below. -sub txn_rollback { shift->storage->txn_rollback } +=cut -=head2 txn_do +sub txn_do { + my $self = shift; -=head3 Arguments: <$coderef>, [@coderef_args] + $self->storage or $self->throw_exception + ('txn_do called on $schema without storage'); -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. + $self->storage->txn_do(@_); +} -For example, +=head2 txn_begin - my $foo = $schema->resultset('foo')->find(1); +Begins a transaction (does nothing if AutoCommit is off). Equivalent to +calling $schema->storage->txn_begin. See +L for more information. - my $coderef = sub { - my ($foo, @bars) = @_; +=cut - # If any one of these fails, the entire transaction fails - $foo->create_related('bars', { - col => $_ - }) foreach (@bars); +sub txn_begin { + my $self = shift; - return $foo->bars; - }; + $self->storage or $self->throw_exception + ('txn_begin called on $schema without storage'); - my $rs; - eval { - $rs = $schema->txn_do($coderef, $foo, qw/foo bar baz/); - }; + $self->storage->txn_begin; +} - if ($@) { - my $error = $@; - if ($error =~ /Rollback failed/) { - die "something terrible has happened!"; - } else { - deal_with_failed_transaction(); - die $error; - } - } +=head2 txn_commit -Nested transactions work as expected (i.e. only the outermost -transaction will issue a txn_commit on the Schema's storage) +Commits the current transaction. Equivalent to calling +$schema->storage->txn_commit. See L +for more information. =cut -sub txn_do { - my ($self, $coderef, @args) = @_; +sub txn_commit { + my $self = shift; - 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'); + $self->storage or $self->throw_exception + ('txn_commit called on $schema without storage'); - my (@return_values, $return_value); + $self->storage->txn_commit; +} - $self->txn_begin; # If this throws an exception, no rollback is needed +=head2 txn_rollback - my $wantarray = wantarray; # Need to save this since it's reset in eval{} +Rolls back the current transaction. Equivalent to calling +$schema->storage->txn_rollback. See +L for more information. - eval { - # Need to differentiate between scalar/list context to allow for returning - # a list in scalar context to get the size of the list +=cut - 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 - } - } +sub txn_rollback { + my $self = shift; + + $self->storage or $self->throw_exception + ('txn_rollback called on $schema without storage'); - return $wantarray ? @return_values : $return_value; + $self->storage->txn_rollback; } =head2 clone +=over 4 + +=item Return Value: $new_schema + +=back + Clones the schema and its associated result_source objects and returns the copy. @@ -497,29 +800,59 @@ 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); $clone->register_source($moniker => $new); } + $clone->storage->set_schema($clone) if $clone->storage; return $clone; } =head2 populate -=head3 Arguments: ($moniker, \@data); +=over 4 + +=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 - i.e. +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. - $schema->populate('Foo', [ - [ qw/foo_id foo_string/ ], - [ 1, 'One' ], - [ 2, 'Two' ], +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 @@ -527,36 +860,241 @@ 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; + } + my @results_to_create; + foreach my $datum (@$data) { + my %result_to_create; + foreach my $index (0..$#names) { + $result_to_create{$names[$index]} = $$datum[$index]; + } + push @results_to_create, \%result_to_create; } - return @created; + $rs->populate(\@results_to_create); } +=head2 exception_action + +=over 4 + +=item Arguments: $code_reference + +=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 C or C 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. + +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 throw_exception -Defaults to using Carp::Clan to report errors from user perspective. +=over 4 + +=item Arguments: $message + +=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. If L is turned on, C's +default behavior will provide a detailed stack trace. =cut sub throw_exception { - my ($self) = shift; - croak @_; + my $self = shift; + + DBIx::Class::Exception->throw($_[0], $self->stacktrace) + if !$self->exception_action || !$self->exception_action->(@_); } =head2 deploy -Attempts to deploy the schema to the current storage +=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 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, $preversion, $sqlt_args + +=back + +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. + +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 { + 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 (EXPERIMENTAL) + +=over 4 + +=item Arguments: $directory, $database-type, $version, $preversion + +=back + + 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, $pversion) = @_; + + my $filename = ref($self); + $filename =~ s/::/-/g; + $filename = File::Spec->catfile($dir, "$filename-$version-$type.sql"); + $filename =~ s/$version/$pversion-$version/ if($pversion); + + return $filename; +} + +=head2 sqlt_deploy_hook($sqlt_schema) + +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. + +=head2 thaw + +Provided as the recommened 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 actualy do anything more than call L, it is just +provided here for symetry. + +=cut + +sub freeze { + return Storable::freeze($_[1]); +} + +=head2 dclone + +Recommeneded way of dcloning objects. This is needed to properly maintain +references to the schema object (which itself is B cloned.) + +=cut + +sub dclone { + my ($self, $obj) = @_; + local $DBIx::Class::ResultSourceHandle::thaw_schema = $self; + return Storable::dclone($obj); } 1; @@ -570,4 +1108,3 @@ Matt S. Trout You may distribute this code under the same terms as Perl itself. =cut -