X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultSource.pm;h=e3c2b80cfaa01024ca10a480a8b67bb113bf6237;hb=e9188247f020a63ab8b6280c9dcdcb0df5b5f0c1;hp=75b1487585d0d23a7f7455e51b14c2f9df4ffe3f;hpb=0f6e30eee38ebbf4e1b636cdfbea06333741685a;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/ResultSource.pm b/lib/DBIx/Class/ResultSource.pm index 75b1487..e3c2b80 100644 --- a/lib/DBIx/Class/ResultSource.pm +++ b/lib/DBIx/Class/ResultSource.pm @@ -4,19 +4,21 @@ use strict; use warnings; use DBIx::Class::ResultSet; +use DBIx::Class::ResultSourceHandle; use Carp::Clan qw/^DBIx::Class/; use Storable; use base qw/DBIx::Class/; -__PACKAGE__->load_components(qw/AccessorGroup/); __PACKAGE__->mk_group_accessors('simple' => qw/_ordered_columns _columns _primaries _unique_constraints name resultset_attributes - schema from _relationships column_info_from_storage source_name/); + schema from _relationships column_info_from_storage source_info/); -__PACKAGE__->mk_group_accessors('component_class' => qw/resultset_class +__PACKAGE__->mk_group_accessors('inherited' => qw/resultset_class result_class/); +__PACKAGE__->mk_group_ro_accessors('simple' => qw/source_name/); + =head1 NAME DBIx::Class::ResultSource - Result source object @@ -46,9 +48,7 @@ sub new { my ($class, $attrs) = @_; $class = ref $class if ref $class; - my $new = { %{$attrs || {}}, _resultset => undef }; - bless $new, $class; - + my $new = bless { %{$attrs || {}} }, $class; $new->{resultset_class} ||= 'DBIx::Class::ResultSet'; $new->{resultset_attributes} = { %{$new->{resultset_attributes} || {}} }; $new->{_ordered_columns} = [ @{$new->{_ordered_columns}||[]}]; @@ -61,6 +61,17 @@ sub new { =pod +=head2 source_info + +Stores a hashref of per-source metadata. No specific key names +have yet been standardized, the examples below are purely hypothetical +and don't actually accomplish anything on their own: + + __PACKAGE__->source_info({ + "_tablespace" => 'fast_disk_array_3', + "_engine" => 'InnoDB', + }); + =head2 add_columns $table->add_columns(qw/col1 col2 col3/); @@ -96,29 +107,31 @@ whatever your database supports. =item size The length of your column, if it is a column type that can have a size -restriction. This is currently not used by DBIx::Class. +restriction. This is currently only used by L. =item is_nullable Set this to a true value for a columns that is allowed to contain -NULL values. This is currently not used by DBIx::Class. +NULL values. This is currently only used by L. =item is_auto_increment Set this to a true value for a column whose value is somehow automatically set. This is used to determine which columns to empty -when cloning objects using C. +when cloning objects using C. It is also used by +L. =item is_foreign_key Set this to a true value for a column that contains a key from a -foreign table. This is currently not used by DBIx::Class. +foreign table. This is currently only used by +L. =item default_value Set this to the default value which will be inserted into a column by the database. Can contain either a value or a function. This is -currently not used by DBIx::Class. +currently only used by L. =item sequence @@ -127,6 +140,14 @@ generate a new key value. If not specified, L will attempt to retrieve the name of the sequence from the database automatically. +=item extras + +This is used by L and L +to add extra non-generic data to the column. For example: C<< extras +=> { unsigned => 1} >> is used by the MySQL producer to set an integer +column to unsigned. For more details, see +L. + =back =head2 add_column @@ -189,8 +210,8 @@ sub column_info { and $self->schema and $self->storage ) { $self->{_columns_info_loaded}++; - my $info; - my $lc_info; + my $info = {}; + my $lc_info = {}; # eval for the case of storage without table eval { $info = $self->storage->columns_info_for( $self->from ) }; unless ($@) { @@ -198,21 +219,23 @@ sub column_info { $lc_info->{lc $realcol} = $info->{$realcol}; } foreach my $col ( keys %{$self->_columns} ) { - $self->_columns->{$col} = { %{ $self->_columns->{$col}}, %{$info->{$col} || $lc_info->{lc $col}} }; + $self->_columns->{$col} = { + %{ $self->_columns->{$col} }, + %{ $info->{$col} || $lc_info->{lc $col} || {} } + }; } } } return $self->_columns->{$column}; } -=head2 load_column_info_from_storage +=head2 column_info_from_storage Enables the on-demand automatic loading of the above column -metadata from storage as neccesary. - -=cut +metadata from storage as neccesary. This is *deprecated*, and +should not be used. It will be removed before 1.0. -sub load_column_info_from_storage { shift->column_info_from_storage(1) } + __PACKAGE__->column_info_from_storage(1); =head2 columns @@ -920,12 +943,20 @@ but is cached from then on unless resultset_class changes. =head2 resultset_class +` package My::ResultSetClass; + use base 'DBIx::Class::ResultSet'; + ... + + $source->resultset_class('My::ResultSet::Class'); + Set the class of the resultset, this is useful if you want to create your own resultset methods. Create your own class derived from -L, and set it here. +L, and set it here. =head2 resultset_attributes + $source->resultset_attributes({ order_by => [ 'id' ] }); + Specify here any attributes you wish to pass to your specialised resultset. =cut @@ -937,12 +968,6 @@ sub resultset { 'call it on the schema instead.' ) if scalar @_; - # disabled until we can figure out a way to do it without consistency issues - # - #return $self->{_resultset} - # if ref $self->{_resultset} eq $self->resultset_class; - #return $self->{_resultset} = - return $self->resultset_class->new( $self, $self->{resultset_attributes} ); @@ -968,6 +993,20 @@ its class name. # from your schema... $schema->resultset('Books')->find(1); +=head2 handle + +Obtain a new handle to this source. Returns an instance of a +L. + +=cut + +sub handle { + return new DBIx::Class::ResultSourceHandle({ + schema => $_[0]->schema, + source_moniker => $_[0]->source_name + }); +} + =head2 throw_exception See L.