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/;
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:
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( ... );
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<DBIx::Class::ResultSource> 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);
- }
-}
+=head1 SETUP METHODS
-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
-
-=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<DBIx::Class::ResultSource> 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
-
-=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 storage
-
- my $storage = $schema->storage;
-
-Returns the L<DBIx::Class::Storage> object for this Schema.
-
-=head2 resultset
-
-=over 4
-
-=item Arguments: $moniker
-
-=item Return Value: $result_set
-
-=back
-
- my $rs = $schema->resultset('DVD');
-
-Returns the L<DBIx::Class::ResultSet> 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<Module::Find> to find all classes under
-the schema's namespace. Otherwise, this method loads the classes you specify
-(using L<use>), and registers them (using L</"register_class">).
-
-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<no warnings 'qw';> 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}};
+ __PACKAGE__->load_namespaces();
- 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;
- }
+ __PACKAGE__->load_namespaces(
+ result_namespace => 'Res',
+ resultset_namespace => 'RSet',
+ default_resultset_class => '+MyDB::Othernamespace::RSet',
+ );
- 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}";
- { # 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);
+With no arguments, this method uses L<Module::Find> to load all your
+Result classes from a sub-namespace F<Result> under your Schema class'
+namespace. Eg. With a Schema of I<MyDB::Schema> all files in
+I<MyDB::Schema::Result> are assumed to be Result classes.
- $comp = $comp_class->source_name || $comp;
-# $DB::single = 1;
- push(@to_register, [ $comp, $comp_class ]);
- }
- }
- }
- Class::C3->reinitialize;
+It also finds all ResultSet classes in the namespace F<ResultSet> 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.
- foreach my $to (@to_register) {
- $class->register_class(@$to);
- # if $class->can('result_source_instance');
- }
-}
+You will be warned if ResultSet classes are discovered for which there
+are no matching Result classes like this:
-=head2 load_namespaces
+ load_namespaces found ResultSet class $classname with no corresponding Result class
-=over 4
+If a Result class is found to already have a ResultSet class set using
+L</resultset_class> to some other class, you will be warned like this:
-=item Arguments: %options?
-
-=back
-
-This is an alternative to L</load_classes> 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<Result>, any
-corresponding ResultSet classes are underneath a sub-namespace of the schema
-called C<ResultSet>.
+ 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<result_namespace> and C<resultset_namespace>.
ResultSet class will have their C<resultset_class> set to
C<default_resultset_class>.
-C<load_namespaces> takes care of calling C<resultset_class> 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<+>.
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)
push(
@results_hash,
map { (substr($_, length "${namespace}::"), $_) }
- Module::Find::findallmod($namespace)
+ $class->_findallmod($namespace)
);
}
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 "
$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 ]);
}
}
return;
}
-=head2 compose_connection (DEPRECATED)
+=head2 load_classes
=over 4
-=item Arguments: $target_namespace, @db_info
-
-=item Return Value: $new_schema
+=item Arguments: @classes?, { $namespace => [ @classes ] }+
=back
-DEPRECATED. You probably wanted compose_namespace.
+Alternative method to L</load_namespaces> which you should look at
+using if you can.
-Actually, you probably just wanted to call connect.
+With no arguments, this method uses L<Module::Find> to find all classes under
+the schema's namespace. Otherwise, this method loads the classes you specify
+(using L<use>), and registers them (using L</"register_class">).
-=begin hidden
+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<no warnings 'qw';> before your load_classes call.
-(hidden due to deprecation)
+If any classes found do not appear to be Result class files, you will
+get the following warning:
-Calls L<DBIx::Class::Schema/"compose_namespace"> to the target namespace,
-calls L<DBIx::Class::Schema/connection> with @db_info on the new schema,
-then injects the L<DBix::Class::ResultSetProxy> component and a
-resultset_instance classdata entry on all the new classes, in order to support
-$target_namespaces::$class->search(...) method calls.
+ 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.
-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<DBIx::Class::Schema/connect> and use the resulting schema object to operate
-on L<DBIx::Class::ResultSet> objects with L<DBIx::Class::Schema/resultset> for
-more information.
+Example:
-=end hidden
+ 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
-{
- my $warn;
+sub load_classes {
+ my ($class, @params) = @_;
- sub compose_connection {
- my ($self, $target, @info) = @_;
+ my %comps_for;
- warn "compose_connection deprecated as of 0.08000"
- unless ($INC{"DBIx/Class/CDBICompat.pm"} || $warn++);
+ if (@params) {
+ foreach my $param (@params) {
+ if (ref $param eq 'ARRAY') {
+ # filter out commented entries
+ my @modules = grep { $_ !~ /^#/ } @$param;
- 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);
+ 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 !~ /^#/;
}
- $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);
+ } 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 ]);
+ }
}
- return $schema;
+ }
+ Class::C3->reinitialize;
+
+ foreach my $to (@to_register) {
+ $class->register_class(@$to);
+ # if $class->can('result_source_instance');
}
}
-=head2 compose_namespace
+=head2 storage_type
=over 4
-=item Arguments: $target_namespace, $additional_base_class?
+=item Arguments: $storage_type|{$storage_type, \%args}
-=item Return Value: $new_schema
+=item Return value: $storage_type|{$storage_type, \%args}
+
+=item Default value: DBIx::Class::Storage::DBI
=back
-For each L<DBIx::Class::ResultSource> 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.
+Set the storage class that will be instantiated when L</connect> is called.
+If the classname starts with C<::>, the prefix C<DBIx::Class::Storage> is
+assumed by L</connect>.
-It also attaches a corresponding L<DBIx::Class::ResultSource> 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.
+You want to use this to set subclasses of L<DBIx::Class::Storage::DBI>
+in cases where the appropriate subclass is not autodetected, such as
+when dealing with MSSQL via L<DBD::Sybase>, in which case you'd set it
+to C<::DBI::Sybase::MSSQL>.
-For example, for a schema with My::Schema::CD and My::Schema::Artist classes,
+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<DBIx::Class::Storage::DBI::Replicated> for an example of this.
- $schema->compose_namespace('My::DB', 'Base::Class');
- print join (', ', @My::DB::CD::ISA) . "\n";
- print join (', ', @My::DB::Artist::ISA) ."\n";
+=head2 exception_action
-will produce the output
+=over 4
- My::Schema::CD, Base::Class
- My::Schema::Artist, Base::Class
+=item Arguments: $code_reference
+
+=item Return value: $code_reference
+
+=item Default value: None
+
+=back
+
+If C<exception_action> is set for this class/object, L</throw_exception>
+will prefer to call this code reference with the exception as an argument,
+rather than L<DBIx::Class::Exception/throw>.
+
+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<exception_action> 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</throw_exception> 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<SQL::Translator::Schema> object when you deploy the schema via
+L</create_ddl_dir> or L</deploy>.
+
+For an example of what you can do with this, see
+L<DBIx::Class::Manual::Cookbook/Adding Indexes And Functions To Your SQL>.
+
+Note that sqlt_deploy_hook is called by L</deployment_statements>, which in turn
+is called before L</deploy>. Therefore the hook can be used only to manipulate
+the L<SQL::Translator::Schema> 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<SQL::Translator>, the currently suggested method is to overload L</deploy>
+and use L<dbh_do|DBIx::Class::Storage::DBI/dbh_do>.
+
+=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<DBIx::Class::Storage::DBI/"connect_info"> for DBI-specific
+syntax on the C<@connectinfo> argument, or L<DBIx::Class::Storage> in
+general.
+
+Note that C<connect_info> expects an arrayref of arguments, but
+C<connect> does not. C<connect> wraps it's arguments in an arrayref
+before passing them to C<connect_info>.
=cut
-sub compose_namespace {
- my ($self, $target, $base) = @_;
- my $schema = $self->clone;
- {
- 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);
- $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(@_) };
- }
- }
- return $schema;
-}
+sub connect { shift->clone->connection(@_) }
-=head2 setup_connection_class
+=head2 resultset
=over 4
-=item Arguments: $target, @info
+=item Arguments: $source_name
+
+=item Return Value: $resultset
=back
-Sets up a database connection class to inject between the schema and the
-subclasses that the schema creates.
+ my $rs = $schema->resultset('DVD');
+
+Returns the L<DBIx::Class::ResultSet> object for the registered source
+name.
=cut
-sub setup_connection_class {
- my ($class, $target, @info) = @_;
- $class->inject_base($target => 'DBIx::Class::DB');
- #$target->load_components('DB');
- $target->connection(@info);
+sub resultset {
+ my ($self, $moniker) = @_;
+ return $self->source($moniker)->resultset;
}
-=head2 storage_type
+=head2 sources
=over 4
-=item Arguments: $storage_type
-
-=item Return Value: $storage_type
+=item Return Value: @source_names
=back
-Set the storage class that will be instantiated when L</connect> is called.
-If the classname starts with C<::>, the prefix C<DBIx::Class::Storage> is
-assumed by L</connect>. Defaults to C<::DBI>,
-which is L<DBIx::Class::Storage::DBI>.
+ my @source_names = $schema->sources;
-You want to use this to hardcoded subclasses of L<DBIx::Class::Storage::DBI>
-in cases where the appropriate subclass is not autodetected, such as when
-dealing with MSSQL via L<DBD::Sybase>, in which case you'd set it to
-C<::DBI::Sybase::MSSQL>.
+Lists names of all the sources registered on this Schema object.
-=head2 connection
+=cut
+
+sub sources { return keys %{shift->source_registrations}; }
+
+=head2 source
=over 4
-=item Arguments: @args
+=item Arguments: $source_name
-=item Return Value: $new_schema
+=item Return Value: $result_source
=back
-Instantiates a new Storage object of type
-L<DBIx::Class::Schema/"storage_type"> and passes the arguments to
-$storage->connect_info. Sets the connection in-place on the schema.
+ my $source = $schema->source('Book');
-See L<DBIx::Class::Storage::DBI/"connect_info"> for DBI-specific syntax,
-or L<DBIx::Class::Storage> in general.
+Returns the L<DBIx::Class::ResultSource> object for the registered
+source name.
=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 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 connect
+=head2 class
=over 4
-=item Arguments: @info
+=item Arguments: $source_name
-=item Return Value: $new_schema
+=item Return Value: $classname
=back
-This is a convenience method. It is equivalent to calling
-$schema->clone->connection(@info). See L</connection> and L</clone> for more
-information.
+ my $class = $schema->class('CD');
+
+Retrieves the Result class name for the given source name.
=cut
-sub connect { shift->clone->connection(@_) }
+sub class {
+ my ($self, $moniker) = @_;
+ return $self->source($moniker)->result_class;
+}
=head2 txn_do
This interface is preferred over using the individual methods L</txn_begin>,
L</txn_commit>, and L</txn_rollback> below.
+WARNING: If you are connected with C<AutoCommit => 0> the transaction is
+considered nested, and you will still need to call L</txn_commit> to write your
+changes when appropriate. You will also want to connect with C<auto_savepoint =>
+1> to get partial rollback to work, if the storage driver for your database
+supports it.
+
+Connecting with C<AutoCommit => 1> is recommended.
+
=cut
sub txn_do {
$self->storage->txn_do(@_);
}
-=head2 txn_scope_guard
+=head2 txn_scope_guard (EXPERIMENTAL)
-Runs C<txn_scope_guard> on the schema's storage.
+Runs C<txn_scope_guard> on the schema's storage. See
+L<DBIx::Class::Storage/txn_scope_guard>.
=cut
$self->storage->txn_rollback;
}
-=head2 svp_begin
-
-Creates a new savepoint (does nothing outside a transaction).
-Equivalent to calling $schema->storage->svp_begin. See
-L<DBIx::Class::Storage::DBI/"svp_begin"> 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<DBIx::Class::Storage::DBI/"svp_release"> 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<DBIx::Class::Storage::DBI/"svp_rollback"> 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
+=head2 storage
-sub clone {
- my ($self) = @_;
- my $clone = { (ref $self ? %$self : ()) };
- bless $clone, (ref $self || $self);
+ my $storage = $schema->storage;
- 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;
-}
+Returns the L<DBIx::Class::Storage> 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<DBIx::Class::Storage::DBI>.
=head2 populate
=item Arguments: $source_name, \@data;
+=item Return value: \@$objects | nothing
+
=back
Pass this method a resultsource name, and an arrayref of
sub populate {
my ($self, $name, $data) = @_;
- my $rs = $self->resultset($name);
- my @names = @{shift(@$data)};
- if(defined wantarray) {
- my @created;
- foreach my $item (@$data) {
- my %create;
- @create{@names} = @$item;
- push(@created, $rs->create(\%create));
+ 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</connect> except sets the storage object and connection
+data in-place on the Schema class. You should probably be calling
+L</connect> to get a proper Schema object instead.
+
+
+=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<DBIx::Class::ResultSource> 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<DBIx::Class::ResultSource> 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
+
+# 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 $schema = $self->clone;
+ {
+ 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);
+ $target_class->result_source_instance($source)
+ if $target_class->can('result_source_instance');
+ $schema->register_source($moniker, $source);
}
- 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];
+# Class::C3->reinitialize();
+ {
+ no strict 'refs';
+ no warnings 'redefine';
+ foreach my $meth (qw/class source resultset/) {
+ *{"${target}::${meth}"} =
+ sub { shift->schema->$meth(@_) };
}
- push @results_to_create, \%result_to_create;
}
- $rs->populate(\@results_to_create);
+ return $schema;
+}
+
+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<DBIx::Class::Storage::DBI/"svp_begin"> 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 exception_action
+=head2 svp_release
+
+Releases a savepoint (does nothing outside a transaction).
+Equivalent to calling $schema->storage->svp_release. See
+L<DBIx::Class::Storage::DBI/"svp_release"> for more information.
+
+=cut
-=over 4
+sub svp_release {
+ my ($self, $name) = @_;
-=item Arguments: $code_reference
+ $self->storage or $self->throw_exception
+ ('svp_release called on $schema without storage');
-=back
+ $self->storage->svp_release($name);
+}
-If C<exception_action> is set for this class/object, L</throw_exception>
-will prefer to call this code reference with the exception as an argument,
-rather than its normal C<croak> or C<confess> action.
+=head2 svp_rollback
-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<exception_action> to suppress a particular exception
-completely, simply have it return true.
+Rollback to a savepoint (does nothing outside a transaction).
+Equivalent to calling $schema->storage->svp_rollback. See
+L<DBIx::Class::Storage::DBI/"svp_rollback"> for more information.
-Example:
+=cut
- package My::Schema;
- use base qw/DBIx::Class::Schema/;
- use My::ExceptionClass;
- __PACKAGE__->exception_action(sub { My::ExceptionClass->throw(@_) });
- __PACKAGE__->load_classes;
+sub svp_rollback {
+ my ($self, $name) = @_;
- # or:
- my $schema_obj = My::Schema->connect( .... );
- $schema_obj->exception_action(sub { My::ExceptionClass->throw(@_) });
+ $self->storage or $self->throw_exception
+ ('svp_rollback called on $schema without storage');
- # suppress all exceptions, like a moron:
- $schema_obj->exception_action(sub { 1 });
+ $self->storage->svp_rollback($name);
+}
-=head2 stacktrace
+=head2 clone
=over 4
-=item Arguments: boolean
+=item Return Value: $new_schema
=back
-Whether L</throw_exception> should include stack trace information.
-Defaults to false normally, but defaults to true if C<$ENV{DBIC_TRACE}>
-is true.
+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
See L<SQL::Translator/METHODS> 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.
+produced include a DROP TABLE statement for each table created. For quoting
+purposes use C<producer_options> value with C<quote_table_names> and
+C<quote_field_names>.
Additionally, the DBIx::Class parser accepts a C<sources> parameter as a hash
ref or an array ref, containing a list of source to deploy. If present, then
=over 4
-=item Arguments: $rdbms_type
+=item Arguments: $rdbms_type, $sqlt_args, $dir
+
+=item Return value: $listofstatements
=back
-Returns the SQL statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
-C<$rdbms_type> provides the DBI database driver name for which the SQL
-statements are produced. If not supplied, the type of the current schema storage
-will be used.
+A convenient shortcut to storage->deployment_statements(). Returns the
+SQL statements used by L</deploy> and
+L<DBIx::Class::Schema::Storage/deploy>. 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</deploy>.
=cut
sub deployment_statements {
- my ($self, $rdbms_type) = @_;
+ my $self = shift;
$self->throw_exception("Can't generate deployment statements without a storage")
if not $self->storage;
- $self->storage->deployment_statements($self, $rdbms_type);
+ $self->storage->deployment_statements($self, @_);
}
=head2 create_ddl_dir (EXPERIMENTAL)
=item databases - ['MySQL', 'SQLite', 'PostgreSQL']
-=item version - $schema->VERSION
+=item version - $schema->schema_version
=item directory - './'
$self->storage->create_ddl_dir($self, @_);
}
-=head2 ddl_filename (EXPERIMENTAL)
+=head2 ddl_filename
=over 4
-=item Arguments: $directory, $database-type, $version, $preversion
+=item Arguments: $database-type, $version, $directory, $preversion
+
+=item Return value: $normalised_filename
=back
- my $filename = $table->ddl_filename($type, $dir, $version, $preversion)
+ my $filename = $table->ddl_filename($type, $version, $dir, $preversion)
This method is called by C<create_ddl_dir> to compose a file name out of
the supplied directory, database type and version number. The default file
=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);
+ my ($self, $type, $version, $dir, $preversion) = @_;
- return $filename;
+ 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 sqlt_deploy_hook($sqlt_schema)
-
-An optional sub which you can declare in your own Schema class that will get
-passed the L<SQL::Translator::Schema> object when you deploy the schema via
-L</create_ddl_dir> or L</deploy>.
-
-For an example of what you can do with this, see
-L<DBIx::Class::Manual::Cookbook/Adding Indexes And Functions To Your SQL>.
-
=head2 thaw
-Provided as the recommened way of thawing schema objects. You can call
+Provided as the recommended way of thawing schema objects. You can call
C<Storable::thaw> directly if you wish, but the thawed objects will not have a
reference to any schema, so are rather useless
return Storable::dclone($obj);
}
+=head2 schema_version
+
+Returns the current schema class' $VERSION in a normalised way.
+
+=cut
+
+sub schema_version {
+ my ($self) = @_;
+ my $class = ref($self)||$self;
+
+ # 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"};
+ }
+ return $version;
+}
+
+
+=head2 register_class
+
+=over 4
+
+=item Arguments: $moniker, $component_class
+
+=back
+
+This method is called by L</load_namespaces> and L</load_classes> to install the found classes into your Schema. You should be using those instead of this one.
+
+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.
+
+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
+
+This method is called by L</register_class>.
+
+Registers the L<DBIx::Class::ResultSource> in the schema with the given
+moniker.
+
+=cut
+
+sub register_source {
+ my $self = shift;
+
+ $self->_register_source(@_);
+}
+
+=head2 register_extra_source
+
+=over 4
+
+=item Arguments: $moniker, $result_source
+
+=back
+
+As L</register_source> but should be used if the result class already
+has a source and you want to register an extra one.
+
+=cut
+
+sub register_extra_source {
+ my $self = shift;
+
+ $self->_register_source(@_, { extra => 1 });
+}
+
+sub _register_source {
+ my ($self, $moniker, $source, $params) = @_;
+
+ $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);
+ return if ($params->{extra});
+
+ 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);
+ }
+}
+
+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 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<DBIx::Class::Schema/"compose_namespace"> to the target namespace,
+calls L<DBIx::Class::Schema/connection> with @db_info on the new schema,
+then injects the L<DBix::Class::ResultSetProxy> 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<DBIx::Class::Schema/connect> and use the resulting schema object to operate
+on L<DBIx::Class::ResultSet> objects with L<DBIx::Class::Schema/resultset> 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';
+ 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;
=head1 AUTHORS
projects / dbsrgits/DBIx-Class.git / blobdiff