X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema.pm;h=1b55afa1b5771f2a89a16492656d99b48d097ec3;hb=8292706e66edd1a95b3af7796aa013285fc842ef;hp=eb3246c69966b4852275cd992148b31e9ea4984e;hpb=429bd4f15b0ea80aef96873a9db11801538eb3ee;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Schema.pm b/lib/DBIx/Class/Schema.pm index eb3246c..1b55afa 100644 --- a/lib/DBIx/Class/Schema.pm +++ b/lib/DBIx/Class/Schema.pm @@ -3,11 +3,16 @@ package DBIx::Class::Schema; use strict; use warnings; -use base qw/Class::Data::Inheritable/; +use Carp qw/croak/; +use UNIVERSAL::require; + use base qw/DBIx::Class/; -__PACKAGE__->load_components(qw/Exception Componentised/); -__PACKAGE__->mk_classdata('class_registrations' => {}); +__PACKAGE__->load_components(qw/Exception/); +__PACKAGE__->mk_classdata('class_mappings' => {}); +__PACKAGE__->mk_classdata('source_registrations' => {}); +__PACKAGE__->mk_classdata('storage_type' => 'DBI'); +__PACKAGE__->mk_classdata('storage'); =head1 NAME @@ -15,131 +20,257 @@ DBIx::Class::Schema - composable schemas =head1 SYNOPSIS - in My/Schema.pm - package My::Schema; - use base qw/DBIx::Class::Schema/; - + + # load My::Schema::Foo, My::Schema::Bar, My::Schema::Baz __PACKAGE__->load_classes(qw/Foo Bar Baz/); - in My/Schema/Foo.pm - package My::Schema::Foo; - - use base qw/DBIx::Class::Core/; - + use base qw/DBIx::Class/; + __PACKAGE__->load_components(qw/PK::Auto::Pg Core/); # for example __PACKAGE__->table('foo'); - ... - - in My/DB.pm - - use My::Schema; - My::Schema->compose_connection('My::DB', $dsn, $user, $pass, $attrs); + my $schema1 = My::Schema->connect( + $dsn, + $user, + $password, + $attrs + ); - then in app code + my $schema2 = My::Schema->connect( ... ); - my @obj = My::DB::Foo->search({}); # My::DB::Foo isa My::Schema::Foo My::DB + # fetch objects using My::Schema::Foo + my $resultset = $schema1->resultset('Foo')->search( ... ); + my @objects = $schema2->resultset('Foo')->search( ... ); =head1 DESCRIPTION -Creates database classes based on a schema. This allows you to have more than -one concurrent connection using the same database classes, by making -subclasses under a new namespace for each connection. If you only need one -class, you should probably use L directly instead. +Creates database classes based on a schema. This is the recommended way to +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 +particular which module inherits off which. =head1 METHODS -=over 4 +=head2 register_class -=item register_class +Registers a class which isa ResultSourceInstance; equivalent to calling -Registers the class in the schema's class_registrations. This is a hash -containing database classes, keyed by their monikers. It's used by -compose_connection to create/modify all the existing database classes. + $schema->register_source($moniker, $class->result_source_instance); =cut sub register_class { - my ($class, $name, $to_register) = @_; - my %reg = %{$class->class_registrations}; - $reg{$name} = $to_register; - $class->class_registrations(\%reg); + my ($self, $moniker, $to_register) = @_; + $self->register_source($moniker => $to_register->result_source_instance); } -=item registered_classes +=head2 register_source + +Registers the result source in the schema with the given moniker + +=cut + +sub register_source { + my ($self, $moniker, $source) = @_; + my %reg = %{$self->source_registrations}; + $reg{$moniker} = $source; + $self->source_registrations(\%reg); + $source->schema($self); + if ($source->result_class) { + my %map = %{$self->class_mappings}; + $map{$source->result_class} = $moniker; + $self->class_mappings(\%map); + } +} + +=head2 class + + my $class = $schema->class('Foo'); + +Retrieves the result class name for a given result source + +=cut + +sub class { + my ($self, $moniker) = @_; + return $self->source($moniker)->result_class; +} + +=head2 source + + my $source = $schema->source('Foo'); + +Returns the result source object for the registered name + +=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}; + croak "Can't find source for ${moniker}" + unless $mapped && exists $sreg->{$mapped}; + return $sreg->{$mapped}; +} + +=head2 sources + + my @source_monikers = $schema->sources; + +Returns the source monikers of all source registrations on this schema -Simple read-only accessor for the schema's registered classes. See -register_class above if you want to modify it. +=cut + +sub sources { return keys %{shift->source_registrations}; } + +=head2 resultset + my $rs = $schema->resultset('Foo'); + +Returns the resultset for the registered moniker =cut -sub registered_classes { - return values %{shift->class_registrations}; +sub resultset { + my ($self, $moniker) = @_; + return $self->source($moniker)->resultset; } -=item load_classes [} +=head2 load_classes [, (, ), { => []}] 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); +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. + =cut sub load_classes { - my $class = shift; - my @comp = grep { $_ !~ /^#/ } @_; - unless (@comp) { + 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}}; + + push (@{$comps_for{$comp}}, @modules); + } + } + else { + # filter out commented entries + push (@{$comps_for{$class}}, $param) if $param !~ /^#/; + } + } + } else { eval "require Module::Find;"; $class->throw("No arguments to load_classes and couldn't load". " Module::Find ($@)") if $@; - @comp = map { substr $_, length "${class}::" } - Module::Find::findallmod($class); + my @comp = map { substr $_, length "${class}::" } Module::Find::findallmod($class); + $comps_for{$class} = \@comp; } - foreach my $comp (@comp) { - my $comp_class = "${class}::${comp}"; - eval "use $comp_class"; # If it fails, assume the user fixed it - $class->register_class($comp => $comp_class); + + foreach my $prefix (keys %comps_for) { + foreach my $comp (@{$comps_for{$prefix}||[]}) { + my $comp_class = "${prefix}::${comp}"; + eval "use $comp_class"; # If it fails, assume the user fixed it + if ($@) { + die $@ unless $@ =~ /Can't locate/; + } + $class->register_class($comp => $comp_class); + } } } -=item compose_connection <@db_info> +=head2 compose_connection <@db_info> This is the most important method in this class. it takes a target namespace, as well as dbh connection info, and creates a L class as well as subclasses for each of your database classes in this namespace, using this connection. +It will also setup a ->class method on the target class, which lets you +resolve database classes based on the schema component name, for example + + MyApp::DB->class('Foo') # returns MyApp::DB::Foo, + # which ISA MyApp::Schema::Foo + +This is the recommended API for accessing Schema generated classes, and +using it might give you instant advantages with future versions of DBIC. + +WARNING: Loading components into Schema classes after compose_connection +may not cause them to be seen by the classes in your target namespace due +to the dispatch table approach used by Class::C3. If you do this you may find +you need to call Class::C3->reinitialize() afterwards to get the behaviour +you expect. + =cut sub compose_connection { - my ($class, $target, @info) = @_; - my $conn_class = "${target}::_db"; - $class->setup_connection_class($conn_class, @info); - my %reg = %{ $class->class_registrations }; + my ($self, $target, @info) = @_; + my $base = 'DBIx::Class::ResultSetInstance'; + $base->require; + my $schema = $self->compose_namespace($target, $base); + $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; +} + +sub compose_namespace { + my ($self, $target, $base) = @_; + my %reg = %{ $self->source_registrations }; my %target; my %map; - while (my ($comp, $comp_class) = each %reg) { - my $target_class = "${target}::${comp}"; - $class->inject_base($target_class, $conn_class, $comp_class); - $target_class->table($comp_class->table); - @map{$comp, $comp_class} = ($target_class, $target_class); + my $schema = $self->clone; + foreach my $moniker ($schema->sources) { + my $source = $schema->source($moniker); + my $target_class = "${target}::${moniker}"; + $self->inject_base( + $target_class => $source->result_class, ($base ? $base : ()) + ); + $source->result_class($target_class); } { no strict 'refs'; - *{"${target}::class"} = - sub { - my ($class, $to_map) = @_; - return $map{$to_map}; - }; - *{"${target}::classes"} = sub { return \%map; }; + *{"${target}::schema"} = + sub { $schema }; + foreach my $meth (qw/class source resultset/) { + *{"${target}::${meth}"} = + sub { shift->schema->$meth(@_) }; + } } - $conn_class->class_resolver($target); + return $schema; } -=item setup_connection_class <$target> <@info> +=head2 setup_connection_class <$target> <@info> Sets up a database connection class to inject between the schema and the subclasses the schema creates. @@ -148,14 +279,56 @@ and the subclasses the schema creates. sub setup_connection_class { my ($class, $target, @info) = @_; - $class->inject_base($target => 'DBIx::Class'); - $target->load_components('DB'); + $class->inject_base($target => 'DBIx::Class::DB'); + #$target->load_components('DB'); $target->connection(@info); } -1; +=head2 connection(@args) -=back +Instantiates a new Storage object of type storage_type and passes the +arguments to $storage->connection_info. Sets the connection in-place on +the schema. + +=cut + +sub connection { + my ($self, @info) = @_; + my $storage_class = 'DBIx::Class::Storage::'.$self->storage_type; + $storage_class->require; + my $storage = $storage_class->new; + $storage->connect_info(\@info); + $self->storage($storage); + return $self; +} + +=head2 connect(@info) + +Conveneience method, equivalent to $schema->clone->connection(@info) + +=cut + +sub connect { shift->clone->connection(@_) }; + +=head2 clone + +Clones the schema and its associated result_source objects and returns the +copy. + +=cut + +sub clone { + my ($self) = @_; + my $clone = bless({ (ref $self ? %$self : ()) }, ref $self || $self); + foreach my $moniker ($self->sources) { + my $source = $self->source($moniker); + my $new = $source->new($source); + $clone->register_source($moniker => $new); + } + return $clone; +} + +1; =head1 AUTHORS