[Bast-commits] r4913 - DBIx-Class/0.08/trunk/lib/DBIx/Class
castaway at dev.catalyst.perl.org
castaway at dev.catalyst.perl.org
Sat Oct 11 18:07:01 BST 2008
Author: castaway
Date: 2008-10-11 18:07:00 +0100 (Sat, 11 Oct 2008)
New Revision: 4913
Modified:
DBIx-Class/0.08/trunk/lib/DBIx/Class/Schema.pm
Log:
Modernised and rearranged docs massively into a saner order.
Modified: DBIx-Class/0.08/trunk/lib/DBIx/Class/Schema.pm
===================================================================
--- DBIx-Class/0.08/trunk/lib/DBIx/Class/Schema.pm 2008-10-11 14:56:14 UTC (rev 4912)
+++ DBIx-Class/0.08/trunk/lib/DBIx/Class/Schema.pm 2008-10-11 17:07:00 UTC (rev 4913)
@@ -29,12 +29,12 @@
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:
@@ -47,7 +47,7 @@
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( ... );
@@ -61,195 +61,186 @@
carefully, as DBIx::Class does things a little differently. Note in
particular which module inherits off which.
-=head1 METHODS
+=head1 SETUP METHODS
-=head2 register_class
+=head2 load_namespaces
=over 4
-=item Arguments: $moniker, $component_class
+=item Arguments: %options?
=back
-Registers a class which isa DBIx::Class::ResultSourceProxy. Equivalent to
-calling:
+ __PACKAGE__->load_namespaces();
- $schema->register_source($moniker, $component_class->result_source_instance);
+ __PACKAGE__->load_namespaces(
+ result_namespace => 'Res',
+ resultset_namespace => 'RSet',
+ default_resultset_class => '+MyDB::Othernamespace::RSet',
+ );
-=cut
+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.
-sub register_class {
- my ($self, $moniker, $to_register) = @_;
- $self->register_source($moniker => $to_register->result_source_instance);
-}
+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.
-=head2 register_source
+You will be warned if ResulSet classes are discovered for which there
+are no matching Result classes like this:
-=over 4
+ load_namespaces found ResultSet class $classname with no corresponding Result class
-=item Arguments: $moniker, $result_source
+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:
-=back
+ We found ResultSet class '$rs_class' for '$result', but it seems
+ that you had already set '$result' to use '$rs_set' instead
-Registers the L<DBIx::Class::ResultSource> in the schema with the given
-moniker.
+Both of the sub-namespaces are configurable if you don't like the defaults,
+via the options C<result_namespace> and C<resultset_namespace>.
-=cut
+If (and only if) you specify the option C<default_resultset_class>, any found
+Result classes for which we do not find a corresponding
+ResultSet class will have their C<resultset_class> set to
+C<default_resultset_class>.
-sub register_source {
- my $self = shift;
+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<+>.
- $self->_register_source(@_);
-}
+Examples:
-=head2 register_extra_source
+ # load My::Schema::Result::CD, My::Schema::Result::Artist,
+ # My::Schema::ResultSet::CD, etc...
+ My::Schema->load_namespaces;
-=over 4
+ # 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',
+ );
-=item Arguments: $moniker, $result_source
+ # Put things in other namespaces
+ My::Schema->load_namespaces(
+ result_namespace => '+Some::Place::Results',
+ resultset_namespace => '+Another::Place::RSets',
+ );
-=back
+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.
-As L</register_source> but should be used if the result class already
-has a source and you want to register an extra one.
+ 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 register_extra_source {
- my $self = shift;
-
- $self->_register_source(@_, { extra => 1 });
+# 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;
}
-sub _register_source {
- my ($self, $moniker, $source, $params) = @_;
+# 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) = @_;
- %$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);
+ my @results_hash;
+ foreach my $namespace (@namespaces) {
+ push(
+ @results_hash,
+ map { (substr($_, length "${namespace}::"), $_) }
+ Module::Find::findallmod($namespace)
+ );
}
-}
-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);
- }
+ @results_hash;
}
-=head2 class
+sub load_namespaces {
+ my ($class, %args) = @_;
-=over 4
+ 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};
-=item Arguments: $moniker
+ $class->throw_exception('load_namespaces: unknown option(s): '
+ . join(q{,}, map { qq{'$_'} } keys %args))
+ if scalar keys %args;
-=item Return Value: $classname
+ $default_resultset_class
+ = $class->_expand_relative_name($default_resultset_class);
-=back
+ for my $arg ($result_namespace, $resultset_namespace) {
+ $arg = [ $arg ] if !ref($arg) && $arg;
-Retrieves the result class name for the given moniker. For example:
+ $class->throw_exception('load_namespaces: namespace arguments must be '
+ . 'a simple string or an arrayref')
+ if ref($arg) ne 'ARRAY';
- my $class = $schema->class('CD');
+ $_ = $class->_expand_relative_name($_) for (@$arg);
+ }
-=cut
+ my %results = $class->_map_namespaces(@$result_namespace);
+ my %resultsets = $class->_map_namespaces(@$resultset_namespace);
-sub class {
- my ($self, $moniker) = @_;
- return $self->source($moniker)->result_class;
-}
+ my @to_register;
+ {
+ no warnings 'redefine';
+ local *Class::C3::reinitialize = sub { };
+ use warnings 'redefine';
-=head2 source
+ 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;
-=over 4
+ 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);
+ }
-=item Arguments: $moniker
+ push(@to_register, [ $result_class->source_name, $result_class ]);
+ }
+ }
-=item Return Value: $result_source
+ foreach (sort keys %resultsets) {
+ warn "load_namespaces found ResultSet class $_ with no "
+ . 'corresponding Result class';
+ }
-=back
+ Class::C3->reinitialize;
+ $class->register_class(@$_) for (@to_register);
- 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};
+ return;
}
-=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
=over 4
@@ -258,6 +249,9 @@
=back
+Alternative method to L</load_namespaces> which you should look at
+using if you can.
+
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">).
@@ -266,6 +260,13 @@
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.
+If any classes found do not appear to be Result class files, you will
+get the following warning:
+
+ 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.
+
Example:
My::Schema->load_classes(); # loads My::Schema::CD, My::Schema::Artist,
@@ -347,428 +348,208 @@
}
}
-=head2 load_namespaces
+=head2 storage_type
=over 4
-=item Arguments: %options?
+=item Arguments: $storage_type|{$storage_type, \%args}
-=back
+=item Return value: $storage_type|{$storage_type, \%args}
-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>.
+=item Default value: DBIx::Class::Storage::DBI
-Both of the sub-namespaces are configurable if you don't like the defaults,
-via the options C<result_namespace> and C<resultset_namespace>.
+=back
-If (and only if) you specify the option C<default_resultset_class>, any found
-Result classes for which we do not find a corresponding
-ResultSet class will have their C<resultset_class> set to
-C<default_resultset_class>.
+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>.
-C<load_namespaces> takes care of calling C<resultset_class> for you where
-neccessary if you didn't do it for yourself.
+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>.
-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<+>.
+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.
-Examples:
+=head2 exception_action
- # load My::Schema::Result::CD, My::Schema::Result::Artist,
- # My::Schema::ResultSet::CD, etc...
- My::Schema->load_namespaces;
+=over 4
- # 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',
- );
+=item Arguments: $code_reference
- # Put things in other namespaces
- My::Schema->load_namespaces(
- result_namespace => '+Some::Place::Results',
- resultset_namespace => '+Another::Place::RSets',
- );
+=item Return value: $code_reference
-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.
+=item Default value: None
- 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' ],
- );
+=back
-=cut
+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>.
-# 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;
-}
+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.
-# 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) = @_;
+Example:
- my @results_hash;
- foreach my $namespace (@namespaces) {
- push(
- @results_hash,
- map { (substr($_, length "${namespace}::"), $_) }
- Module::Find::findallmod($namespace)
- );
- }
+ package My::Schema;
+ use base qw/DBIx::Class::Schema/;
+ use My::ExceptionClass;
+ __PACKAGE__->exception_action(sub { My::ExceptionClass->throw(@_) });
+ __PACKAGE__->load_classes;
- @results_hash;
-}
+ # or:
+ my $schema_obj = My::Schema->connect( .... );
+ $schema_obj->exception_action(sub { My::ExceptionClass->throw(@_) });
-sub load_namespaces {
- my ($class, %args) = @_;
+ # suppress all exceptions, like a moron:
+ $schema_obj->exception_action(sub { 1 });
- 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};
+=head2 stacktrace
- $class->throw_exception('load_namespaces: unknown option(s): '
- . join(q{,}, map { qq{'$_'} } keys %args))
- if scalar keys %args;
+=over 4
- $default_resultset_class
- = $class->_expand_relative_name($default_resultset_class);
+=item Arguments: boolean
- for my $arg ($result_namespace, $resultset_namespace) {
- $arg = [ $arg ] if !ref($arg) && $arg;
+=back
- $class->throw_exception('load_namespaces: namespace arguments must be '
- . 'a simple string or an arrayref')
- if ref($arg) ne 'ARRAY';
+Whether L</throw_exception> should include stack trace information.
+Defaults to false normally, but defaults to true if C<$ENV{DBIC_TRACE}>
+is true.
- $_ = $class->_expand_relative_name($_) for (@$arg);
- }
+=head2 sqlt_deploy_hook
- my %results = $class->_map_namespaces(@$result_namespace);
- my %resultsets = $class->_map_namespaces(@$resultset_namespace);
+=over
- my @to_register;
- {
- no warnings 'redefine';
- local *Class::C3::reinitialize = sub { };
- use warnings 'redefine';
+=item Arguments: $sqlt_schema
- 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;
+=back
- 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);
- }
+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>.
- push(@to_register, [ $result_class->source_name, $result_class ]);
- }
- }
+For an example of what you can do with this, see
+L<DBIx::Class::Manual::Cookbook/Adding Indexes And Functions To Your SQL>.
- foreach (sort keys %resultsets) {
- warn "load_namespaces found ResultSet class $_ with no "
- . 'corresponding Result class';
- }
+=head1 METHODS
- Class::C3->reinitialize;
- $class->register_class(@$_) for (@to_register);
+=head2 connect
- return;
-}
-
-=head2 compose_connection (DEPRECATED)
-
=over 4
-=item Arguments: $target_namespace, @db_info
+=item Arguments: @connectinfo
=item Return Value: $new_schema
=back
-DEPRECATED. You probably wanted compose_namespace.
+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.
-Actually, you probably just wanted to call connect.
+See L<DBIx::Class::Storage::DBI/"connect_info"> for DBI-specific
+syntax on the C>@connectinfo> argument, or L<DBIx::Class::Storage> in
+general.
-=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 connect { shift->clone->connection(@_) }
- sub compose_connection {
- my ($self, $target, @info) = @_;
+=head2 resultset
- 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;
- }
-}
-
-=head2 compose_namespace
-
=over 4
-=item Arguments: $target_namespace, $additional_base_class?
+=item Arguments: $source_name
-=item Return Value: $new_schema
+=item Return Value: $resultset
=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.
+ my $rs = $schema->resultset('DVD');
-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.
+Returns the L<DBIx::Class::ResultSet> object for the registered source
+name.
-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);
- }
- }
-# 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 resultset {
+ my ($self, $moniker) = @_;
+ return $self->source($moniker)->resultset;
}
-sub setup_connection_class {
- my ($class, $target, @info) = @_;
- $class->inject_base($target => 'DBIx::Class::DB');
- #$target->load_components('DB');
- $target->connection(@info);
-}
+=head2 sources
-=head2 storage_type
-
=over 4
-=item Arguments: $storage_type|{$storage_type, \%args}
+=item Return Value: @source_names
-=item Return Value: $storage_type|{$storage_type, \%args}
-
=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.
-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.
+=cut
-See L<DBIx::Class::Storage::DBI::Replicated> for an example of this.
+sub sources { return keys %{shift->source_registrations}; }
-=head2 connection
+=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, $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 source {
+ my ($self, $moniker) = @_;
+ my $sreg = $self->source_registrations;
+ return $sreg->{$moniker} if exists $sreg->{$moniker};
-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);
- }
+ # 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
@@ -865,94 +646,23 @@
$self->storage->txn_rollback;
}
-=head2 svp_begin
+=head2 storage
-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.
+ my $storage = $schema->storage;
-=cut
+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>.
-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
-
-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 populate
=over 4
=item Arguments: $source_name, \@data;
+=item Return value: \@$objects | nothing
+
=back
Pass this method a resultsource name, and an arrayref of
@@ -1015,50 +725,224 @@
$rs->populate(\@results_to_create);
}
-=head2 exception_action
+=head2 connection
=over 4
-=item Arguments: $code_reference
+=item Arguments: @args
+=item Return Value: $new_schema
+
=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 its normal C<croak> or C<confess> action.
+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.
-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:
+=cut
- package My::Schema;
- use base qw/DBIx::Class::Schema/;
- use My::ExceptionClass;
- __PACKAGE__->exception_action(sub { My::ExceptionClass->throw(@_) });
- __PACKAGE__->load_classes;
+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;
+}
- # or:
- my $schema_obj = My::Schema->connect( .... );
- $schema_obj->exception_action(sub { My::ExceptionClass->throw(@_) });
+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);
+ }
+}
- # suppress all exceptions, like a moron:
- $schema_obj->exception_action(sub { 1 });
+=head2 compose_namespace
-=head2 stacktrace
+=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);
+ }
+ }
+# 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 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 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 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
=over 4
@@ -1115,13 +999,17 @@
=item Arguments: $rdbms_type, $sqlt_args, $dir
+=item Return value: $listofstatements
+
=back
-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>.
+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
@@ -1190,6 +1078,8 @@
=item Arguments: $database-type, $version, $directory, $preversion
+=item Return value: $normalised_filename
+
=back
my $filename = $table->ddl_filename($type, $version, $dir, $preversion)
@@ -1214,18 +1104,9 @@
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
@@ -1263,7 +1144,7 @@
=head2 schema_version
-Returns the current schema class' $VERSION
+Returns the current schema class' $VERSION in a normalised way.
=cut
@@ -1284,6 +1165,192 @@
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
More information about the Bast-commits
mailing list