1 package DBIx::Class::ResultSource;
6 use base qw/DBIx::Class::ResultSource::RowParser DBIx::Class/;
8 use DBIx::Class::ResultSet;
9 use DBIx::Class::ResultSourceHandle;
11 use DBIx::Class::Carp;
12 use DBIx::Class::_Util qw( UNRESOLVABLE_CONDITION dbic_internal_try );
13 use SQL::Abstract 'is_literal_value';
14 use Devel::GlobalDestruction;
15 use Scalar::Util qw/blessed weaken isweak/;
19 __PACKAGE__->mk_group_accessors(simple => qw/
20 source_name name source_info
21 _ordered_columns _columns _primaries _unique_constraints
22 _relationships resultset_attributes
23 column_info_from_storage
26 __PACKAGE__->mk_group_accessors(component_class => qw/
31 __PACKAGE__->mk_classdata( sqlt_deploy_callback => 'default_sqlt_deploy_hook' );
35 DBIx::Class::ResultSource - Result source object
39 # Create a table based result source, in a result class.
41 package MyApp::Schema::Result::Artist;
42 use base qw/DBIx::Class::Core/;
44 __PACKAGE__->table('artist');
45 __PACKAGE__->add_columns(qw/ artistid name /);
46 __PACKAGE__->set_primary_key('artistid');
47 __PACKAGE__->has_many(cds => 'MyApp::Schema::Result::CD');
51 # Create a query (view) based result source, in a result class
52 package MyApp::Schema::Result::Year2000CDs;
53 use base qw/DBIx::Class::Core/;
55 __PACKAGE__->load_components('InflateColumn::DateTime');
56 __PACKAGE__->table_class('DBIx::Class::ResultSource::View');
58 __PACKAGE__->table('year2000cds');
59 __PACKAGE__->result_source_instance->is_virtual(1);
60 __PACKAGE__->result_source_instance->view_definition(
61 "SELECT cdid, artist, title FROM cd WHERE year ='2000'"
67 A ResultSource is an object that represents a source of data for querying.
69 This class is a base class for various specialised types of result
70 sources, for example L<DBIx::Class::ResultSource::Table>. Table is the
71 default result source type, so one is created for you when defining a
72 result class as described in the synopsis above.
74 More specifically, the L<DBIx::Class::Core> base class pulls in the
75 L<DBIx::Class::ResultSourceProxy::Table> component, which defines
76 the L<table|DBIx::Class::ResultSourceProxy::Table/table> method.
77 When called, C<table> creates and stores an instance of
78 L<DBIx::Class::ResultSource::Table>. Luckily, to use tables as result
79 sources, you don't need to remember any of this.
81 Result sources representing select queries, or views, can also be
82 created, see L<DBIx::Class::ResultSource::View> for full details.
84 =head2 Finding result source objects
86 As mentioned above, a result source instance is created and stored for
88 L<Result Class|DBIx::Class::Manual::Glossary/Result Class>.
90 You can retrieve the result source at runtime in the following ways:
94 =item From a Schema object:
96 $schema->source($source_name);
98 =item From a Result object:
100 $result->result_source;
102 =item From a ResultSet object:
114 $class->new({attribute_name => value});
116 Creates a new ResultSource object. Not normally called directly by end users.
121 my ($class, $attrs) = @_;
122 $class = ref $class if ref $class;
124 my $new = bless { %{$attrs || {}} }, $class;
125 $new->{resultset_class} ||= 'DBIx::Class::ResultSet';
126 $new->{resultset_attributes} = { %{$new->{resultset_attributes} || {}} };
127 $new->{_ordered_columns} = [ @{$new->{_ordered_columns}||[]}];
128 $new->{_columns} = { %{$new->{_columns}||{}} };
129 $new->{_relationships} = { %{$new->{_relationships}||{}} };
130 $new->{name} ||= "!!NAME NOT SET!!";
131 $new->{_columns_info_loaded} ||= 0;
141 =item Arguments: @columns
143 =item Return Value: L<$result_source|/new>
147 $source->add_columns(qw/col1 col2 col3/);
149 $source->add_columns('col1' => \%col1_info, 'col2' => \%col2_info, ...);
151 $source->add_columns(
152 'col1' => { data_type => 'integer', is_nullable => 1, ... },
153 'col2' => { data_type => 'text', is_auto_increment => 1, ... },
156 Adds columns to the result source. If supplied colname => hashref
157 pairs, uses the hashref as the L</column_info> for that column. Repeated
158 calls of this method will add more columns, not replace them.
160 The column names given will be created as accessor methods on your
161 L<Result|DBIx::Class::Manual::ResultClass> objects. You can change the name of the accessor
162 by supplying an L</accessor> in the column_info hash.
164 If a column name beginning with a plus sign ('+col1') is provided, the
165 attributes provided will be merged with any existing attributes for the
166 column, with the new attributes taking precedence in the case that an
167 attribute already exists. Using this without a hashref
168 (C<< $source->add_columns(qw/+col1 +col2/) >>) is legal, but useless --
169 it does the same thing it would do without the plus.
171 The contents of the column_info are not set in stone. The following
172 keys are currently recognised/used by DBIx::Class:
178 { accessor => '_name' }
180 # example use, replace standard accessor with one of your own:
182 my ($self, $value) = @_;
184 die "Name cannot contain digits!" if($value =~ /\d/);
185 $self->_name($value);
187 return $self->_name();
190 Use this to set the name of the accessor method for this column. If unset,
191 the name of the column will be used.
195 { data_type => 'integer' }
197 This contains the column type. It is automatically filled if you use the
198 L<SQL::Translator::Producer::DBIx::Class::File> producer, or the
199 L<DBIx::Class::Schema::Loader> module.
201 Currently there is no standard set of values for the data_type. Use
202 whatever your database supports.
208 The length of your column, if it is a column type that can have a size
209 restriction. This is currently only used to create tables from your
210 schema, see L<DBIx::Class::Schema/deploy>.
214 For decimal or float values you can specify an ArrayRef in order to
215 control precision, assuming your database's
216 L<SQL::Translator::Producer> supports it.
222 Set this to a true value for a column that is allowed to contain NULL
223 values, default is false. This is currently only used to create tables
224 from your schema, see L<DBIx::Class::Schema/deploy>.
226 =item is_auto_increment
228 { is_auto_increment => 1 }
230 Set this to a true value for a column whose value is somehow
231 automatically set, defaults to false. This is used to determine which
232 columns to empty when cloning objects using
233 L<DBIx::Class::Row/copy>. It is also used by
234 L<DBIx::Class::Schema/deploy>.
240 Set this to a true or false value (not C<undef>) to explicitly specify
241 if this column contains numeric data. This controls how set_column
242 decides whether to consider a column dirty after an update: if
243 C<is_numeric> is true a numeric comparison C<< != >> will take place
244 instead of the usual C<eq>
246 If not specified the storage class will attempt to figure this out on
247 first access to the column, based on the column C<data_type>. The
248 result will be cached in this attribute.
252 { is_foreign_key => 1 }
254 Set this to a true value for a column that contains a key from a
255 foreign table, defaults to false. This is currently only used to
256 create tables from your schema, see L<DBIx::Class::Schema/deploy>.
260 { default_value => \'now()' }
262 Set this to the default value which will be inserted into a column by
263 the database. Can contain either a value or a function (use a
264 reference to a scalar e.g. C<\'now()'> if you want a function). This
265 is currently only used to create tables from your schema, see
266 L<DBIx::Class::Schema/deploy>.
268 See the note on L<DBIx::Class::Row/new> for more information about possible
269 issues related to db-side default values.
273 { sequence => 'my_table_seq' }
275 Set this on a primary key column to the name of the sequence used to
276 generate a new key value. If not specified, L<DBIx::Class::PK::Auto>
277 will attempt to retrieve the name of the sequence from the database
280 =item retrieve_on_insert
282 { retrieve_on_insert => 1 }
284 For every column where this is set to true, DBIC will retrieve the RDBMS-side
285 value upon a new row insertion (normally only the autoincrement PK is
286 retrieved on insert). C<INSERT ... RETURNING> is used automatically if
287 supported by the underlying storage, otherwise an extra SELECT statement is
288 executed to retrieve the missing data.
292 { auto_nextval => 1 }
294 Set this to a true value for a column whose value is retrieved automatically
295 from a sequence or function (if supported by your Storage driver.) For a
296 sequence, if you do not use a trigger to get the nextval, you have to set the
297 L</sequence> value as well.
299 Also set this for MSSQL columns with the 'uniqueidentifier'
300 L<data_type|DBIx::Class::ResultSource/data_type> whose values you want to
301 automatically generate using C<NEWID()>, unless they are a primary key in which
302 case this will be done anyway.
306 This is used by L<DBIx::Class::Schema/deploy> and L<SQL::Translator>
307 to add extra non-generic data to the column. For example: C<< extra
308 => { unsigned => 1} >> is used by the MySQL producer to set an integer
309 column to unsigned. For more details, see
310 L<SQL::Translator::Producer::MySQL>.
318 =item Arguments: $colname, \%columninfo?
320 =item Return Value: 1/0 (true/false)
324 $source->add_column('col' => \%info);
326 Add a single column and optional column info. Uses the same column
327 info keys as L</add_columns>.
332 my ($self, @cols) = @_;
333 $self->_ordered_columns(\@cols) unless $self->_ordered_columns;
336 my $columns = $self->_columns;
337 while (my $col = shift @cols) {
338 my $column_info = {};
339 if ($col =~ s/^\+//) {
340 $column_info = $self->column_info($col);
343 # If next entry is { ... } use that for the column info, if not
344 # use an empty hashref
346 my $new_info = shift(@cols);
347 %$column_info = (%$column_info, %$new_info);
349 push(@added, $col) unless exists $columns->{$col};
350 $columns->{$col} = $column_info;
352 push @{ $self->_ordered_columns }, @added;
356 sub add_column { shift->add_columns(@_); } # DO NOT CHANGE THIS TO GLOB
362 =item Arguments: $colname
364 =item Return Value: 1/0 (true/false)
368 if ($source->has_column($colname)) { ... }
370 Returns true if the source has a column of this name, false otherwise.
375 my ($self, $column) = @_;
376 return exists $self->_columns->{$column};
383 =item Arguments: $colname
385 =item Return Value: Hashref of info
389 my $info = $source->column_info($col);
391 Returns the column metadata hashref for a column, as originally passed
392 to L</add_columns>. See L</add_columns> above for information on the
393 contents of the hashref.
398 my ($self, $column) = @_;
399 $self->throw_exception("No such column $column")
400 unless exists $self->_columns->{$column};
402 if ( ! $self->_columns->{$column}{data_type}
403 and ! $self->{_columns_info_loaded}
404 and $self->column_info_from_storage
405 and my $stor = dbic_internal_try { $self->storage } )
407 $self->{_columns_info_loaded}++;
409 # try for the case of storage without table
411 my $info = $stor->columns_info_for( $self->from );
413 { (lc $_) => $info->{$_} }
417 foreach my $col ( keys %{$self->_columns} ) {
418 $self->_columns->{$col} = {
419 %{ $self->_columns->{$col} },
420 %{ $info->{$col} || $lc_info->{lc $col} || {} }
426 return $self->_columns->{$column};
433 =item Arguments: none
435 =item Return Value: Ordered list of column names
439 my @column_names = $source->columns;
441 Returns all column names in the order they were declared to L</add_columns>.
447 $self->throw_exception(
448 "columns() is a read-only accessor, did you mean add_columns()?"
450 return @{$self->{_ordered_columns}||[]};
457 =item Arguments: \@colnames ?
459 =item Return Value: Hashref of column name/info pairs
463 my $columns_info = $source->columns_info;
465 Like L</column_info> but returns information for the requested columns. If
466 the optional column-list arrayref is omitted it returns info on all columns
467 currently defined on the ResultSource via L</add_columns>.
472 my ($self, $columns) = @_;
474 my $colinfo = $self->_columns;
477 ! $self->{_columns_info_loaded}
479 $self->column_info_from_storage
481 grep { ! $_->{data_type} } values %$colinfo
483 my $stor = dbic_internal_try { $self->storage }
485 $self->{_columns_info_loaded}++;
487 # try for the case of storage without table
489 my $info = $stor->columns_info_for( $self->from );
491 { (lc $_) => $info->{$_} }
495 foreach my $col ( keys %$colinfo ) {
497 %{ $colinfo->{$col} },
498 %{ $info->{$col} || $lc_info->{lc $col} || {} }
508 if (my $inf = $colinfo->{$_}) {
512 $self->throw_exception( sprintf (
513 "No such column '%s' on source '%s'",
515 $self->source_name || $self->name || 'Unknown source...?',
527 =head2 remove_columns
531 =item Arguments: @colnames
533 =item Return Value: not defined
537 $source->remove_columns(qw/col1 col2 col3/);
539 Removes the given list of columns by name, from the result source.
541 B<Warning>: Removing a column that is also used in the sources primary
542 key, or in one of the sources unique constraints, B<will> result in a
543 broken result source.
549 =item Arguments: $colname
551 =item Return Value: not defined
555 $source->remove_column('col');
557 Remove a single column by name from the result source, similar to
560 B<Warning>: Removing a column that is also used in the sources primary
561 key, or in one of the sources unique constraints, B<will> result in a
562 broken result source.
567 my ($self, @to_remove) = @_;
569 my $columns = $self->_columns
574 delete $columns->{$_};
578 $self->_ordered_columns([ grep { not $to_remove{$_} } @{$self->_ordered_columns} ]);
581 sub remove_column { shift->remove_columns(@_); } # DO NOT CHANGE THIS TO GLOB
583 =head2 set_primary_key
587 =item Arguments: @cols
589 =item Return Value: not defined
593 Defines one or more columns as primary key for this source. Must be
594 called after L</add_columns>.
596 Additionally, defines a L<unique constraint|/add_unique_constraint>
599 Note: you normally do want to define a primary key on your sources
600 B<even if the underlying database table does not have a primary key>.
602 L<DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
607 sub set_primary_key {
608 my ($self, @cols) = @_;
610 my $colinfo = $self->columns_info(\@cols);
611 for my $col (@cols) {
612 carp_unique(sprintf (
613 "Primary key of source '%s' includes the column '%s' which has its "
614 . "'is_nullable' attribute set to true. This is a mistake and will cause "
615 . 'various Result-object operations to fail',
616 $self->source_name || $self->name || 'Unknown source...?',
618 )) if $colinfo->{$col}{is_nullable};
621 $self->_primaries(\@cols);
623 $self->add_unique_constraint(primary => \@cols);
626 =head2 primary_columns
630 =item Arguments: none
632 =item Return Value: Ordered list of primary column names
636 Read-only accessor which returns the list of primary keys, supplied by
641 sub primary_columns {
642 return @{shift->_primaries||[]};
645 # a helper method that will automatically die with a descriptive message if
646 # no pk is defined on the source in question. For internal use to save
647 # on if @pks... boilerplate
648 sub _pri_cols_or_die {
650 my @pcols = $self->primary_columns
651 or $self->throw_exception (sprintf(
652 "Operation requires a primary key to be declared on '%s' via set_primary_key",
653 # source_name is set only after schema-registration
654 $self->source_name || $self->result_class || $self->name || 'Unknown source...?',
659 # same as above but mandating single-column PK (used by relationship condition
661 sub _single_pri_col_or_die {
663 my ($pri, @too_many) = $self->_pri_cols_or_die;
665 $self->throw_exception( sprintf(
666 "Operation requires a single-column primary key declared on '%s'",
667 $self->source_name || $self->result_class || $self->name || 'Unknown source...?',
675 Manually define the correct sequence for your table, to avoid the overhead
676 associated with looking up the sequence automatically. The supplied sequence
677 will be applied to the L</column_info> of each L<primary_key|/set_primary_key>
681 =item Arguments: $sequence_name
683 =item Return Value: not defined
690 my ($self,$seq) = @_;
692 my @pks = $self->primary_columns
695 $_->{sequence} = $seq
696 for values %{ $self->columns_info (\@pks) };
700 =head2 add_unique_constraint
704 =item Arguments: $name?, \@colnames
706 =item Return Value: not defined
710 Declare a unique constraint on this source. Call once for each unique
713 # For UNIQUE (column1, column2)
714 __PACKAGE__->add_unique_constraint(
715 constraint_name => [ qw/column1 column2/ ],
718 Alternatively, you can specify only the columns:
720 __PACKAGE__->add_unique_constraint([ qw/column1 column2/ ]);
722 This will result in a unique constraint named
723 C<table_column1_column2>, where C<table> is replaced with the table
726 Unique constraints are used, for example, when you pass the constraint
727 name as the C<key> attribute to L<DBIx::Class::ResultSet/find>. Then
728 only columns in the constraint are searched.
730 Throws an error if any of the given column names do not yet exist on
735 sub add_unique_constraint {
739 $self->throw_exception(
740 'add_unique_constraint() does not accept multiple constraints, use '
741 . 'add_unique_constraints() instead'
746 if (ref $cols ne 'ARRAY') {
747 $self->throw_exception (
748 'Expecting an arrayref of constraint columns, got ' . ($cols||'NOTHING')
754 $name ||= $self->name_unique_constraint($cols);
756 foreach my $col (@$cols) {
757 $self->throw_exception("No such column $col on table " . $self->name)
758 unless $self->has_column($col);
761 my %unique_constraints = $self->unique_constraints;
762 $unique_constraints{$name} = $cols;
763 $self->_unique_constraints(\%unique_constraints);
766 =head2 add_unique_constraints
770 =item Arguments: @constraints
772 =item Return Value: not defined
776 Declare multiple unique constraints on this source.
778 __PACKAGE__->add_unique_constraints(
779 constraint_name1 => [ qw/column1 column2/ ],
780 constraint_name2 => [ qw/column2 column3/ ],
783 Alternatively, you can specify only the columns:
785 __PACKAGE__->add_unique_constraints(
786 [ qw/column1 column2/ ],
787 [ qw/column3 column4/ ]
790 This will result in unique constraints named C<table_column1_column2> and
791 C<table_column3_column4>, where C<table> is replaced with the table name.
793 Throws an error if any of the given column names do not yet exist on
796 See also L</add_unique_constraint>.
800 sub add_unique_constraints {
802 my @constraints = @_;
804 if ( !(@constraints % 2) && grep { ref $_ ne 'ARRAY' } @constraints ) {
805 # with constraint name
806 while (my ($name, $constraint) = splice @constraints, 0, 2) {
807 $self->add_unique_constraint($name => $constraint);
812 foreach my $constraint (@constraints) {
813 $self->add_unique_constraint($constraint);
818 =head2 name_unique_constraint
822 =item Arguments: \@colnames
824 =item Return Value: Constraint name
828 $source->table('mytable');
829 $source->name_unique_constraint(['col1', 'col2']);
833 Return a name for a unique constraint containing the specified
834 columns. The name is created by joining the table name and each column
835 name, using an underscore character.
837 For example, a constraint on a table named C<cd> containing the columns
838 C<artist> and C<title> would result in a constraint name of C<cd_artist_title>.
840 This is used by L</add_unique_constraint> if you do not specify the
841 optional constraint name.
845 sub name_unique_constraint {
846 my ($self, $cols) = @_;
848 my $name = $self->name;
849 $name = $$name if (ref $name eq 'SCALAR');
850 $name =~ s/ ^ [^\.]+ \. //x; # strip possible schema qualifier
852 return join '_', $name, @$cols;
855 =head2 unique_constraints
859 =item Arguments: none
861 =item Return Value: Hash of unique constraint data
865 $source->unique_constraints();
867 Read-only accessor which returns a hash of unique constraints on this
870 The hash is keyed by constraint name, and contains an arrayref of
871 column names as values.
875 sub unique_constraints {
876 return %{shift->_unique_constraints||{}};
879 =head2 unique_constraint_names
883 =item Arguments: none
885 =item Return Value: Unique constraint names
889 $source->unique_constraint_names();
891 Returns the list of unique constraint names defined on this source.
895 sub unique_constraint_names {
898 my %unique_constraints = $self->unique_constraints;
900 return keys %unique_constraints;
903 =head2 unique_constraint_columns
907 =item Arguments: $constraintname
909 =item Return Value: List of constraint columns
913 $source->unique_constraint_columns('myconstraint');
915 Returns the list of columns that make up the specified unique constraint.
919 sub unique_constraint_columns {
920 my ($self, $constraint_name) = @_;
922 my %unique_constraints = $self->unique_constraints;
924 $self->throw_exception(
925 "Unknown unique constraint $constraint_name on '" . $self->name . "'"
926 ) unless exists $unique_constraints{$constraint_name};
928 return @{ $unique_constraints{$constraint_name} };
931 =head2 sqlt_deploy_callback
935 =item Arguments: $callback_name | \&callback_code
937 =item Return Value: $callback_name | \&callback_code
941 __PACKAGE__->sqlt_deploy_callback('mycallbackmethod');
945 __PACKAGE__->sqlt_deploy_callback(sub {
946 my ($source_instance, $sqlt_table) = @_;
950 An accessor to set a callback to be called during deployment of
951 the schema via L<DBIx::Class::Schema/create_ddl_dir> or
952 L<DBIx::Class::Schema/deploy>.
954 The callback can be set as either a code reference or the name of a
955 method in the current result class.
957 Defaults to L</default_sqlt_deploy_hook>.
959 Your callback will be passed the $source object representing the
960 ResultSource instance being deployed, and the
961 L<SQL::Translator::Schema::Table> object being created from it. The
962 callback can be used to manipulate the table object or add your own
963 customised indexes. If you need to manipulate a non-table object, use
964 the L<DBIx::Class::Schema/sqlt_deploy_hook>.
966 See L<DBIx::Class::Manual::Cookbook/Adding Indexes And Functions To
967 Your SQL> for examples.
969 This sqlt deployment callback can only be used to manipulate
970 SQL::Translator objects as they get turned into SQL. To execute
971 post-deploy statements which SQL::Translator does not currently
972 handle, override L<DBIx::Class::Schema/deploy> in your Schema class
973 and call L<dbh_do|DBIx::Class::Storage::DBI/dbh_do>.
975 =head2 default_sqlt_deploy_hook
977 This is the default deploy hook implementation which checks if your
978 current Result class has a C<sqlt_deploy_hook> method, and if present
979 invokes it B<on the Result class directly>. This is to preserve the
980 semantics of C<sqlt_deploy_hook> which was originally designed to expect
981 the Result class name and the
982 L<$sqlt_table instance|SQL::Translator::Schema::Table> of the table being
987 sub default_sqlt_deploy_hook {
990 my $class = $self->result_class;
992 if ($class and $class->can('sqlt_deploy_hook')) {
993 $class->sqlt_deploy_hook(@_);
997 sub _invoke_sqlt_deploy_hook {
999 if ( my $hook = $self->sqlt_deploy_callback) {
1008 =item Arguments: $classname
1010 =item Return Value: $classname
1014 use My::Schema::ResultClass::Inflator;
1017 use My::Schema::Artist;
1019 __PACKAGE__->result_class('My::Schema::ResultClass::Inflator');
1021 Set the default result class for this source. You can use this to create
1022 and use your own result inflator. See L<DBIx::Class::ResultSet/result_class>
1025 Please note that setting this to something like
1026 L<DBIx::Class::ResultClass::HashRefInflator> will make every result unblessed
1027 and make life more difficult. Inflators like those are better suited to
1028 temporary usage via L<DBIx::Class::ResultSet/result_class>.
1034 =item Arguments: none
1036 =item Return Value: L<$resultset|DBIx::Class::ResultSet>
1040 Returns a resultset for the given source. This will initially be created
1041 on demand by calling
1043 $self->resultset_class->new($self, $self->resultset_attributes)
1045 but is cached from then on unless resultset_class changes.
1047 =head2 resultset_class
1051 =item Arguments: $classname
1053 =item Return Value: $classname
1057 package My::Schema::ResultSet::Artist;
1058 use base 'DBIx::Class::ResultSet';
1061 # In the result class
1062 __PACKAGE__->resultset_class('My::Schema::ResultSet::Artist');
1065 $source->resultset_class('My::Schema::ResultSet::Artist');
1067 Set the class of the resultset. This is useful if you want to create your
1068 own resultset methods. Create your own class derived from
1069 L<DBIx::Class::ResultSet>, and set it here. If called with no arguments,
1070 this method returns the name of the existing resultset class, if one
1073 =head2 resultset_attributes
1077 =item Arguments: L<\%attrs|DBIx::Class::ResultSet/ATTRIBUTES>
1079 =item Return Value: L<\%attrs|DBIx::Class::ResultSet/ATTRIBUTES>
1083 # In the result class
1084 __PACKAGE__->resultset_attributes({ order_by => [ 'id' ] });
1087 $source->resultset_attributes({ order_by => [ 'id' ] });
1089 Store a collection of resultset attributes, that will be set on every
1090 L<DBIx::Class::ResultSet> produced from this result source.
1092 B<CAVEAT>: C<resultset_attributes> comes with its own set of issues and
1093 bugs! While C<resultset_attributes> isn't deprecated per se, its usage is
1096 Since relationships use attributes to link tables together, the "default"
1097 attributes you set may cause unpredictable and undesired behavior. Furthermore,
1098 the defaults cannot be turned off, so you are stuck with them.
1100 In most cases, what you should actually be using are project-specific methods:
1102 package My::Schema::ResultSet::Artist;
1103 use base 'DBIx::Class::ResultSet';
1107 #__PACKAGE__->resultset_attributes({ prefetch => 'tracks' });
1110 sub with_tracks { shift->search({}, { prefetch => 'tracks' }) }
1113 $schema->resultset('Artist')->with_tracks->...
1115 This gives you the flexibility of not using it when you don't need it.
1117 For more complex situations, another solution would be to use a virtual view
1118 via L<DBIx::Class::ResultSource::View>.
1124 $self->throw_exception(
1125 'resultset does not take any arguments. If you want another resultset, '.
1126 'call it on the schema instead.'
1129 $self->resultset_class->new(
1132 ( dbic_internal_try { %{$self->schema->default_resultset_attributes} } ),
1133 %{$self->{resultset_attributes}},
1142 =item Arguments: none
1144 =item Result value: $name
1148 Returns the name of the result source, which will typically be the table
1149 name. This may be a scalar reference if the result source has a non-standard
1156 =item Arguments: $source_name
1158 =item Result value: $source_name
1162 Set an alternate name for the result source when it is loaded into a schema.
1163 This is useful if you want to refer to a result source by a name other than
1166 package ArchivedBooks;
1167 use base qw/DBIx::Class/;
1168 __PACKAGE__->table('books_archive');
1169 __PACKAGE__->source_name('Books');
1171 # from your schema...
1172 $schema->resultset('Books')->find(1);
1178 =item Arguments: none
1180 =item Return Value: FROM clause
1184 my $from_clause = $source->from();
1186 Returns an expression of the source to be supplied to storage to specify
1187 retrieval from this source. In the case of a database, the required FROM
1192 sub from { die 'Virtual method!' }
1196 Stores a hashref of per-source metadata. No specific key names
1197 have yet been standardized, the examples below are purely hypothetical
1198 and don't actually accomplish anything on their own:
1200 __PACKAGE__->source_info({
1201 "_tablespace" => 'fast_disk_array_3',
1202 "_engine" => 'InnoDB',
1209 =item Arguments: L<$schema?|DBIx::Class::Schema>
1211 =item Return Value: L<$schema|DBIx::Class::Schema>
1215 my $schema = $source->schema();
1217 Sets and/or returns the L<DBIx::Class::Schema> object to which this
1218 result source instance has been attached to.
1224 $_[0]->{schema} = $_[1];
1227 $_[0]->{schema} || do {
1228 my $name = $_[0]->{source_name} || '_unnamed_';
1229 my $err = 'Unable to perform storage-dependent operations with a detached result source '
1230 . "(source '$name' is not associated with a schema).";
1232 $err .= ' You need to use $schema->thaw() or manually set'
1233 . ' $DBIx::Class::ResultSourceHandle::thaw_schema while thawing.'
1234 if $_[0]->{_detached_thaw};
1236 DBIx::Class::Exception->throw($err);
1245 =item Arguments: none
1247 =item Return Value: L<$storage|DBIx::Class::Storage>
1251 $source->storage->debug(1);
1253 Returns the L<storage handle|DBIx::Class::Storage> for the current schema.
1257 sub storage { shift->schema->storage; }
1259 =head2 add_relationship
1263 =item Arguments: $rel_name, $related_source_name, \%cond, \%attrs?
1265 =item Return Value: 1/true if it succeeded
1269 $source->add_relationship('rel_name', 'related_source', $cond, $attrs);
1271 L<DBIx::Class::Relationship> describes a series of methods which
1272 create pre-defined useful types of relationships. Look there first
1273 before using this method directly.
1275 The relationship name can be arbitrary, but must be unique for each
1276 relationship attached to this result source. 'related_source' should
1277 be the name with which the related result source was registered with
1278 the current schema. For example:
1280 $schema->source('Book')->add_relationship('reviews', 'Review', {
1281 'foreign.book_id' => 'self.id',
1284 The condition C<$cond> needs to be an L<SQL::Abstract>-style
1285 representation of the join between the tables. For example, if you're
1286 creating a relation from Author to Book,
1288 { 'foreign.author_id' => 'self.id' }
1290 will result in the JOIN clause
1292 author me JOIN book foreign ON foreign.author_id = me.id
1294 You can specify as many foreign => self mappings as necessary.
1296 Valid attributes are as follows:
1302 Explicitly specifies the type of join to use in the relationship. Any
1303 SQL join type is valid, e.g. C<LEFT> or C<RIGHT>. It will be placed in
1304 the SQL command immediately before C<JOIN>.
1308 An arrayref containing a list of accessors in the foreign class to proxy in
1309 the main class. If, for example, you do the following:
1311 CD->might_have(liner_notes => 'LinerNotes', undef, {
1312 proxy => [ qw/notes/ ],
1315 Then, assuming LinerNotes has an accessor named notes, you can do:
1317 my $cd = CD->find(1);
1318 # set notes -- LinerNotes object is created if it doesn't exist
1319 $cd->notes('Notes go here');
1323 Specifies the type of accessor that should be created for the
1324 relationship. Valid values are C<single> (for when there is only a single
1325 related object), C<multi> (when there can be many), and C<filter> (for
1326 when there is a single related object, but you also want the relationship
1327 accessor to double as a column accessor). For C<multi> accessors, an
1328 add_to_* method is also created, which calls C<create_related> for the
1333 Throws an exception if the condition is improperly supplied, or cannot
1338 sub add_relationship {
1339 my ($self, $rel, $f_source_name, $cond, $attrs) = @_;
1340 $self->throw_exception("Can't create relationship without join condition")
1344 # Check foreign and self are right in cond
1345 if ( (ref $cond ||'') eq 'HASH') {
1346 $_ =~ /^foreign\./ or $self->throw_exception("Malformed relationship condition key '$_': must be prefixed with 'foreign.'")
1349 $_ =~ /^self\./ or $self->throw_exception("Malformed relationship condition value '$_': must be prefixed with 'self.'")
1353 my %rels = %{ $self->_relationships };
1354 $rels{$rel} = { class => $f_source_name,
1355 source => $f_source_name,
1358 $self->_relationships(\%rels);
1363 =head2 relationships
1367 =item Arguments: none
1369 =item Return Value: L<@rel_names|DBIx::Class::Relationship>
1373 my @rel_names = $source->relationships();
1375 Returns all relationship names for this source.
1380 return keys %{shift->_relationships};
1383 =head2 relationship_info
1387 =item Arguments: L<$rel_name|DBIx::Class::Relationship>
1389 =item Return Value: L<\%rel_data|DBIx::Class::Relationship::Base/add_relationship>
1393 Returns a hash of relationship information for the specified relationship
1394 name. The keys/values are as specified for L<DBIx::Class::Relationship::Base/add_relationship>.
1398 sub relationship_info {
1399 #my ($self, $rel) = @_;
1400 return shift->_relationships->{+shift};
1403 =head2 has_relationship
1407 =item Arguments: L<$rel_name|DBIx::Class::Relationship>
1409 =item Return Value: 1/0 (true/false)
1413 Returns true if the source has a relationship of this name, false otherwise.
1417 sub has_relationship {
1418 #my ($self, $rel) = @_;
1419 return exists shift->_relationships->{+shift};
1422 =head2 reverse_relationship_info
1426 =item Arguments: L<$rel_name|DBIx::Class::Relationship>
1428 =item Return Value: L<\%rel_data|DBIx::Class::Relationship::Base/add_relationship>
1432 Looks through all the relationships on the source this relationship
1433 points to, looking for one whose condition is the reverse of the
1434 condition on this relationship.
1436 A common use of this is to find the name of the C<belongs_to> relation
1437 opposing a C<has_many> relation. For definition of these look in
1438 L<DBIx::Class::Relationship>.
1440 The returned hashref is keyed by the name of the opposing
1441 relationship, and contains its data in the same manner as
1442 L</relationship_info>.
1446 sub reverse_relationship_info {
1447 my ($self, $rel) = @_;
1449 my $rel_info = $self->relationship_info($rel)
1450 or $self->throw_exception("No such relationship '$rel'");
1454 return $ret unless ((ref $rel_info->{cond}) eq 'HASH');
1456 my $stripped_cond = $self->__strip_relcond ($rel_info->{cond});
1458 my $registered_source_name = $self->source_name;
1460 # this may be a partial schema or something else equally esoteric
1461 my $other_rsrc = $self->related_source($rel);
1463 # Get all the relationships for that source that related to this source
1464 # whose foreign column set are our self columns on $rel and whose self
1465 # columns are our foreign columns on $rel
1466 foreach my $other_rel ($other_rsrc->relationships) {
1468 # only consider stuff that points back to us
1469 # "us" here is tricky - if we are in a schema registration, we want
1470 # to use the source_names, otherwise we will use the actual classes
1472 # the schema may be partial
1473 my $roundtrip_rsrc = dbic_internal_try { $other_rsrc->related_source($other_rel) }
1476 if ($registered_source_name) {
1477 next if $registered_source_name ne ($roundtrip_rsrc->source_name || '')
1480 next if $self->result_class ne $roundtrip_rsrc->result_class;
1483 my $other_rel_info = $other_rsrc->relationship_info($other_rel);
1485 # this can happen when we have a self-referential class
1486 next if $other_rel_info eq $rel_info;
1488 next unless ref $other_rel_info->{cond} eq 'HASH';
1489 my $other_stripped_cond = $self->__strip_relcond($other_rel_info->{cond});
1491 $ret->{$other_rel} = $other_rel_info if (
1492 $self->_compare_relationship_keys (
1493 [ keys %$stripped_cond ], [ values %$other_stripped_cond ]
1496 $self->_compare_relationship_keys (
1497 [ values %$stripped_cond ], [ keys %$other_stripped_cond ]
1505 # all this does is removes the foreign/self prefix from a condition
1506 sub __strip_relcond {
1509 { map { /^ (?:foreign|self) \. (\w+) $/x } ($_, $_[1]{$_}) }
1514 sub compare_relationship_keys {
1515 carp 'compare_relationship_keys is a private method, stop calling it';
1517 $self->_compare_relationship_keys (@_);
1520 # Returns true if both sets of keynames are the same, false otherwise.
1521 sub _compare_relationship_keys {
1522 # my ($self, $keys1, $keys2) = @_;
1524 join ("\x00", sort @{$_[1]})
1526 join ("\x00", sort @{$_[2]})
1530 # optionally takes either an arrayref of column names, or a hashref of already
1531 # retrieved colinfos
1532 # returns an arrayref of column names of the shortest unique constraint
1533 # (matching some of the input if any), giving preference to the PK
1534 sub _identifying_column_set {
1535 my ($self, $cols) = @_;
1537 my %unique = $self->unique_constraints;
1538 my $colinfos = ref $cols eq 'HASH' ? $cols : $self->columns_info($cols||());
1540 # always prefer the PK first, and then shortest constraints first
1542 for my $set (delete $unique{primary}, sort { @$a <=> @$b } (values %unique) ) {
1543 next unless $set && @$set;
1546 next USET unless ($colinfos->{$_} && !$colinfos->{$_}{is_nullable} );
1549 # copy so we can mangle it at will
1556 sub _minimal_valueset_satisfying_constraint {
1558 my $args = { ref $_[0] eq 'HASH' ? %{ $_[0] } : @_ };
1560 $args->{columns_info} ||= $self->columns_info;
1562 my $vals = $self->storage->_extract_fixed_condition_columns(
1564 ($args->{carp_on_nulls} ? 'consider_nulls' : undef ),
1568 for my $col ($self->unique_constraint_columns($args->{constraint_name}) ) {
1569 if( ! exists $vals->{$col} or ( $vals->{$col}||'' ) eq UNRESOLVABLE_CONDITION ) {
1570 $cols->{missing}{$col} = undef;
1572 elsif( ! defined $vals->{$col} ) {
1573 $cols->{$args->{carp_on_nulls} ? 'undefined' : 'missing'}{$col} = undef;
1576 # we need to inject back the '=' as _extract_fixed_condition_columns
1577 # will strip it from literals and values alike, resulting in an invalid
1578 # condition in the end
1579 $cols->{present}{$col} = { '=' => $vals->{$col} };
1582 $cols->{fc}{$col} = 1 if (
1583 ( ! $cols->{missing} or ! exists $cols->{missing}{$col} )
1585 keys %{ $args->{columns_info}{$col}{_filter_info} || {} }
1589 $self->throw_exception( sprintf ( "Unable to satisfy requested constraint '%s', missing values for column(s): %s",
1590 $args->{constraint_name},
1591 join (', ', map { "'$_'" } sort keys %{$cols->{missing}} ),
1592 ) ) if $cols->{missing};
1594 $self->throw_exception( sprintf (
1595 "Unable to satisfy requested constraint '%s', FilterColumn values not usable for column(s): %s",
1596 $args->{constraint_name},
1597 join (', ', map { "'$_'" } sort keys %{$cols->{fc}}),
1603 !$ENV{DBIC_NULLABLE_KEY_NOWARN}
1605 carp_unique ( sprintf (
1606 "NULL/undef values supplied for requested unique constraint '%s' (NULL "
1607 . 'values in column(s): %s). This is almost certainly not what you wanted, '
1608 . 'though you can set DBIC_NULLABLE_KEY_NOWARN to disable this warning.',
1609 $args->{constraint_name},
1610 join (', ', map { "'$_'" } sort keys %{$cols->{undefined}}),
1614 return { map { %{ $cols->{$_}||{} } } qw(present undefined) };
1617 # Returns the {from} structure used to express JOIN conditions
1619 my ($self, $join, $alias, $seen, $jpath, $parent_force_left) = @_;
1621 # we need a supplied one, because we do in-place modifications, no returns
1622 $self->throw_exception ('You must supply a seen hashref as the 3rd argument to _resolve_join')
1623 unless ref $seen eq 'HASH';
1625 $self->throw_exception ('You must supply a joinpath arrayref as the 4th argument to _resolve_join')
1626 unless ref $jpath eq 'ARRAY';
1628 $jpath = [@$jpath]; # copy
1630 if (not defined $join or not length $join) {
1633 elsif (ref $join eq 'ARRAY') {
1636 $self->_resolve_join($_, $alias, $seen, $jpath, $parent_force_left);
1639 elsif (ref $join eq 'HASH') {
1642 for my $rel (keys %$join) {
1644 my $rel_info = $self->relationship_info($rel)
1645 or $self->throw_exception("No such relationship '$rel' on " . $self->source_name);
1647 my $force_left = $parent_force_left;
1648 $force_left ||= lc($rel_info->{attrs}{join_type}||'') eq 'left';
1650 # the actual seen value will be incremented by the recursion
1651 my $as = $self->storage->relname_to_table_alias(
1652 $rel, ($seen->{$rel} && $seen->{$rel} + 1)
1656 $self->_resolve_join($rel, $alias, $seen, [@$jpath], $force_left),
1657 $self->related_source($rel)->_resolve_join(
1658 $join->{$rel}, $as, $seen, [@$jpath, { $rel => $as }], $force_left
1666 $self->throw_exception("No idea how to resolve join reftype ".ref $join);
1669 my $count = ++$seen->{$join};
1670 my $as = $self->storage->relname_to_table_alias(
1671 $join, ($count > 1 && $count)
1674 my $rel_info = $self->relationship_info($join)
1675 or $self->throw_exception("No such relationship $join on " . $self->source_name);
1677 my $rel_src = $self->related_source($join);
1678 return [ { $as => $rel_src->from,
1680 -join_type => $parent_force_left
1682 : $rel_info->{attrs}{join_type}
1684 -join_path => [@$jpath, { $join => $as } ],
1686 ! $rel_info->{attrs}{accessor}
1688 $rel_info->{attrs}{accessor} eq 'single'
1690 $rel_info->{attrs}{accessor} eq 'filter'
1693 -relation_chain_depth => ( $seen->{-relation_chain_depth} || 0 ) + 1,
1695 $self->_resolve_relationship_condition(
1697 self_alias => $alias,
1698 foreign_alias => $as,
1705 carp 'pk_depends_on is a private method, stop calling it';
1707 $self->_pk_depends_on (@_);
1710 # Determines whether a relation is dependent on an object from this source
1711 # having already been inserted. Takes the name of the relationship and a
1712 # hashref of columns of the related object.
1713 sub _pk_depends_on {
1714 my ($self, $rel_name, $rel_data) = @_;
1716 my $relinfo = $self->relationship_info($rel_name);
1718 # don't assume things if the relationship direction is specified
1719 return $relinfo->{attrs}{is_foreign_key_constraint}
1720 if exists ($relinfo->{attrs}{is_foreign_key_constraint});
1722 my $cond = $relinfo->{cond};
1723 return 0 unless ref($cond) eq 'HASH';
1725 # map { foreign.foo => 'self.bar' } to { bar => 'foo' }
1726 my $keyhash = { map { my $x = $_; $x =~ s/.*\.//; $x; } reverse %$cond };
1728 # assume anything that references our PK probably is dependent on us
1729 # rather than vice versa, unless the far side is (a) defined or (b)
1731 my $rel_source = $self->related_source($rel_name);
1733 foreach my $p ($self->primary_columns) {
1734 if (exists $keyhash->{$p}) {
1735 unless (defined($rel_data->{$keyhash->{$p}})
1736 || $rel_source->column_info($keyhash->{$p})
1737 ->{is_auto_increment}) {
1746 sub resolve_condition {
1747 carp 'resolve_condition is a private method, stop calling it';
1748 shift->_resolve_condition (@_);
1751 sub _resolve_condition {
1752 # carp_unique sprintf
1753 # '_resolve_condition is a private method, and moreover is about to go '
1754 # . 'away. Please contact the development team at %s if you believe you '
1755 # . 'have a genuine use for this method, in order to discuss alternatives.',
1756 # DBIx::Class::_ENV_::HELP_URL,
1759 #######################
1760 ### API Design? What's that...? (a backwards compatible shim, kill me now)
1762 my ($self, $cond, @res_args, $rel_name);
1764 # we *SIMPLY DON'T KNOW YET* which arg is which, yay
1765 ($self, $cond, $res_args[0], $res_args[1], $rel_name) = @_;
1767 # assume that an undef is an object-like unset (set_from_related(undef))
1768 my @is_objlike = map { ! defined $_ or length ref $_ } (@res_args);
1770 # turn objlike into proper objects for saner code further down
1772 next unless $is_objlike[$_];
1774 if ( defined blessed $res_args[$_] ) {
1776 # but wait - there is more!!! WHAT THE FUCK?!?!?!?!
1777 if ($res_args[$_]->isa('DBIx::Class::ResultSet')) {
1778 carp('Passing a resultset for relationship resolution makes no sense - invoking __gremlins__');
1779 $is_objlike[$_] = 0;
1780 $res_args[$_] = '__gremlins__';
1784 $res_args[$_] ||= {};
1786 # hate everywhere - have to pass in as a plain hash
1787 # pretending to be an object at least for now
1788 $self->throw_exception("Unsupported object-like structure encountered: $res_args[$_]")
1789 unless ref $res_args[$_] eq 'HASH';
1794 # where-is-waldo block guesses relname, then further down we override it if available
1796 $is_objlike[1] ? ( rel_name => $res_args[0], self_alias => $res_args[0], foreign_alias => 'me', self_result_object => $res_args[1] )
1797 : $is_objlike[0] ? ( rel_name => $res_args[1], self_alias => 'me', foreign_alias => $res_args[1], foreign_values => $res_args[0] )
1798 : ( rel_name => $res_args[0], self_alias => $res_args[1], foreign_alias => $res_args[0] )
1801 ( $rel_name ? ( rel_name => $rel_name ) : () ),
1804 # Allowing passing relconds different than the relationshup itself is cute,
1805 # but likely dangerous. Remove that from the (still unofficial) API of
1806 # _resolve_relationship_condition, and instead make it "hard on purpose"
1807 local $self->relationship_info( $args->{rel_name} )->{cond} = $cond if defined $cond;
1809 #######################
1811 # now it's fucking easy isn't it?!
1812 my $rc = $self->_resolve_relationship_condition( $args );
1815 ( $rc->{join_free_condition} || $rc->{condition} ),
1816 ! $rc->{join_free_condition},
1819 # _resolve_relationship_condition always returns qualified cols even in the
1820 # case of join_free_condition, but nothing downstream expects this
1821 if ($rc->{join_free_condition} and ref $res[0] eq 'HASH') {
1823 { ($_ =~ /\.(.+)/) => $res[0]{$_} }
1829 return wantarray ? @res : $res[0];
1832 # Keep this indefinitely. There is evidence of both CPAN and
1833 # darkpan using it, and there isn't much harm in an extra var
1835 our $UNRESOLVABLE_CONDITION = UNRESOLVABLE_CONDITION;
1836 # YES I KNOW THIS IS EVIL
1837 # it is there to save darkpan from themselves, since internally
1838 # we are moving to a constant
1839 Internals::SvREADONLY($UNRESOLVABLE_CONDITION => 1);
1841 # Resolves the passed condition to a concrete query fragment and extra
1844 ## self-explanatory API, modeled on the custom cond coderef:
1845 # rel_name => (scalar)
1846 # foreign_alias => (scalar)
1847 # foreign_values => (either not supplied, or a hashref, or a foreign ResultObject (to be ->get_columns()ed), or plain undef )
1848 # self_alias => (scalar)
1849 # self_result_object => (either not supplied or a result object)
1850 # require_join_free_condition => (boolean, throws on failure to construct a JF-cond)
1851 # infer_values_based_on => (either not supplied or a hashref, implies require_join_free_condition)
1854 # condition => (a valid *likely fully qualified* sqla cond structure)
1855 # identity_map => (a hashref of foreign-to-self *unqualified* column equality names)
1856 # join_free_condition => (a valid *fully qualified* sqla cond structure, maybe unset)
1857 # inferred_values => (in case of an available join_free condition, this is a hashref of
1858 # *unqualified* column/value *EQUALITY* pairs, representing an amalgamation
1859 # of the JF-cond parse and infer_values_based_on
1860 # always either complete or unset)
1862 sub _resolve_relationship_condition {
1865 my $args = { ref $_[0] eq 'HASH' ? %{ $_[0] } : @_ };
1867 for ( qw( rel_name self_alias foreign_alias ) ) {
1868 $self->throw_exception("Mandatory argument '$_' to _resolve_relationship_condition() is not a plain string")
1869 if !defined $args->{$_} or length ref $args->{$_};
1872 $self->throw_exception("Arguments 'self_alias' and 'foreign_alias' may not be identical")
1873 if $args->{self_alias} eq $args->{foreign_alias};
1876 my $exception_rel_id = "relationship '$args->{rel_name}' on source '@{[ $self->source_name ]}'";
1878 my $rel_info = $self->relationship_info($args->{rel_name})
1880 # or $self->throw_exception( "No such $exception_rel_id" );
1881 or carp_unique("Requesting resolution on non-existent relationship '$args->{rel_name}' on source '@{[ $self->source_name ]}': fix your code *soon*, as it will break with the next major version");
1884 $exception_rel_id = "relationship '$rel_info->{_original_name}' on source '@{[ $self->source_name ]}'"
1885 if $rel_info and exists $rel_info->{_original_name};
1887 $self->throw_exception("No practical way to resolve $exception_rel_id between two data structures")
1888 if exists $args->{self_result_object} and exists $args->{foreign_values};
1890 $self->throw_exception( "Argument to infer_values_based_on must be a hash" )
1891 if exists $args->{infer_values_based_on} and ref $args->{infer_values_based_on} ne 'HASH';
1893 $args->{require_join_free_condition} ||= !!$args->{infer_values_based_on};
1895 $self->throw_exception( "Argument 'self_result_object' must be an object inheriting from DBIx::Class::Row" )
1897 exists $args->{self_result_object}
1899 ( ! defined blessed $args->{self_result_object} or ! $args->{self_result_object}->isa('DBIx::Class::Row') )
1903 my $rel_rsrc = $self->related_source($args->{rel_name});
1904 my $storage = $self->schema->storage;
1906 if (exists $args->{foreign_values}) {
1908 if (! defined $args->{foreign_values} ) {
1909 # fallback: undef => {}
1910 $args->{foreign_values} = {};
1912 elsif (defined blessed $args->{foreign_values}) {
1914 $self->throw_exception( "Objects supplied as 'foreign_values' ($args->{foreign_values}) must inherit from DBIx::Class::Row" )
1915 unless $args->{foreign_values}->isa('DBIx::Class::Row');
1918 "Objects supplied as 'foreign_values' ($args->{foreign_values}) "
1919 . "usually should inherit from the related ResultClass ('@{[ $rel_rsrc->result_class ]}'), "
1920 . "perhaps you've made a mistake invoking the condition resolver?"
1921 ) unless $args->{foreign_values}->isa($rel_rsrc->result_class);
1923 $args->{foreign_values} = { $args->{foreign_values}->get_columns };
1925 elsif ( ref $args->{foreign_values} eq 'HASH' ) {
1927 # re-build {foreign_values} excluding identically named rels
1928 if( keys %{$args->{foreign_values}} ) {
1930 my ($col_idx, $rel_idx) = map
1931 { { map { $_ => 1 } $rel_rsrc->$_ } }
1932 qw( columns relationships )
1935 my $equivalencies = $storage->_extract_fixed_condition_columns(
1936 $args->{foreign_values},
1940 $args->{foreign_values} = { map {
1941 # skip if relationship *and* a non-literal ref
1942 # this means a multicreate stub was passed in
1946 length ref $args->{foreign_values}{$_}
1948 ! is_literal_value($args->{foreign_values}{$_})
1953 ? $self->throw_exception( "Key '$_' supplied as 'foreign_values' is not a column on related source '@{[ $rel_rsrc->source_name ]}'" )
1954 : ( !exists $equivalencies->{$_} or ($equivalencies->{$_}||'') eq UNRESOLVABLE_CONDITION )
1955 ? $self->throw_exception( "Value supplied for '...{foreign_values}{$_}' is not a direct equivalence expression" )
1956 : $args->{foreign_values}{$_}
1958 } keys %{$args->{foreign_values}} };
1962 $self->throw_exception(
1963 "Argument 'foreign_values' must be either an object inheriting from '@{[ $rel_rsrc->result_class ]}', "
1964 . "or a hash reference, or undef"
1971 if (ref $rel_info->{cond} eq 'CODE') {
1974 rel_name => $args->{rel_name},
1975 self_resultsource => $self,
1976 self_alias => $args->{self_alias},
1977 foreign_alias => $args->{foreign_alias},
1979 { (exists $args->{$_}) ? ( $_ => $args->{$_} ) : () }
1980 qw( self_result_object foreign_values )
1984 # legacy - never remove these!!!
1985 $cref_args->{foreign_relname} = $cref_args->{rel_name};
1987 $cref_args->{self_rowobj} = $cref_args->{self_result_object}
1988 if exists $cref_args->{self_result_object};
1990 ($ret->{condition}, $ret->{join_free_condition}, my @extra) = $rel_info->{cond}->($cref_args);
1993 $self->throw_exception("A custom condition coderef can return at most 2 conditions, but $exception_rel_id returned extra values: @extra")
1996 if (my $jfc = $ret->{join_free_condition}) {
1998 $self->throw_exception (
1999 "The join-free condition returned for $exception_rel_id must be a hash reference"
2000 ) unless ref $jfc eq 'HASH';
2002 my ($joinfree_alias, $joinfree_source);
2003 if (defined $args->{self_result_object}) {
2004 $joinfree_alias = $args->{foreign_alias};
2005 $joinfree_source = $rel_rsrc;
2007 elsif (defined $args->{foreign_values}) {
2008 $joinfree_alias = $args->{self_alias};
2009 $joinfree_source = $self;
2012 # FIXME sanity check until things stabilize, remove at some point
2013 $self->throw_exception (
2014 "A join-free condition returned for $exception_rel_id without a result object to chain from"
2015 ) unless $joinfree_alias;
2017 my $fq_col_list = { map
2018 { ( "$joinfree_alias.$_" => 1 ) }
2019 $joinfree_source->columns
2022 exists $fq_col_list->{$_} or $self->throw_exception (
2023 "The join-free condition returned for $exception_rel_id may only "
2024 . 'contain keys that are fully qualified column names of the corresponding source '
2025 . "'$joinfree_alias' (instead it returned '$_')"
2033 $_->isa('DBIx::Class::Row')
2035 $self->throw_exception (
2036 "The join-free condition returned for $exception_rel_id may not "
2037 . 'contain result objects as values - perhaps instead of invoking '
2038 . '->$something you meant to return ->get_column($something)'
2044 elsif (ref $rel_info->{cond} eq 'HASH') {
2046 # the condition is static - use parallel arrays
2047 # for a "pivot" depending on which side of the
2048 # rel did we get as an object
2049 my (@f_cols, @l_cols);
2050 for my $fc (keys %{ $rel_info->{cond} }) {
2051 my $lc = $rel_info->{cond}{$fc};
2053 # FIXME STRICTMODE should probably check these are valid columns
2054 $fc =~ s/^foreign\.// ||
2055 $self->throw_exception("Invalid rel cond key '$fc'");
2057 $lc =~ s/^self\.// ||
2058 $self->throw_exception("Invalid rel cond val '$lc'");
2064 # construct the crosstable condition and the identity map
2066 $ret->{condition}{"$args->{foreign_alias}.$f_cols[$_]"} = { -ident => "$args->{self_alias}.$l_cols[$_]" };
2067 $ret->{identity_map}{$l_cols[$_]} = $f_cols[$_];
2070 if ($args->{foreign_values}) {
2071 $ret->{join_free_condition}{"$args->{self_alias}.$l_cols[$_]"} = $args->{foreign_values}{$f_cols[$_]}
2074 elsif (defined $args->{self_result_object}) {
2076 for my $i (0..$#l_cols) {
2077 if ( $args->{self_result_object}->has_column_loaded($l_cols[$i]) ) {
2078 $ret->{join_free_condition}{"$args->{foreign_alias}.$f_cols[$i]"} = $args->{self_result_object}->get_column($l_cols[$i]);
2081 $self->throw_exception(sprintf
2082 "Unable to resolve relationship '%s' from object '%s': column '%s' not "
2083 . 'loaded from storage (or not passed to new() prior to insert()). You '
2084 . 'probably need to call ->discard_changes to get the server-side defaults '
2085 . 'from the database.',
2087 $args->{self_result_object},
2089 ) if $args->{self_result_object}->in_storage;
2091 # FIXME - temporarly force-override
2092 delete $args->{require_join_free_condition};
2093 $ret->{join_free_condition} = UNRESOLVABLE_CONDITION;
2099 elsif (ref $rel_info->{cond} eq 'ARRAY') {
2100 if (@{ $rel_info->{cond} } == 0) {
2102 condition => UNRESOLVABLE_CONDITION,
2103 join_free_condition => UNRESOLVABLE_CONDITION,
2107 my @subconds = map {
2108 local $rel_info->{cond} = $_;
2109 $self->_resolve_relationship_condition( $args );
2110 } @{ $rel_info->{cond} };
2112 if( @{ $rel_info->{cond} } == 1 ) {
2113 $ret = $subconds[0];
2116 # we are discarding inferred values here... likely incorrect...
2117 # then again - the entire thing is an OR, so we *can't* use them anyway
2118 for my $subcond ( @subconds ) {
2119 $self->throw_exception('Either all or none of the OR-condition members must resolve to a join-free condition')
2120 if ( $ret and ( $ret->{join_free_condition} xor $subcond->{join_free_condition} ) );
2122 $subcond->{$_} and push @{$ret->{$_}}, $subcond->{$_} for (qw(condition join_free_condition));
2128 $self->throw_exception ("Can't handle condition $rel_info->{cond} for $exception_rel_id yet :(");
2132 $args->{require_join_free_condition}
2134 ( ! $ret->{join_free_condition} or $ret->{join_free_condition} eq UNRESOLVABLE_CONDITION )
2136 $self->throw_exception(
2137 ucfirst sprintf "$exception_rel_id does not resolve to a %sjoin-free condition fragment",
2138 exists $args->{foreign_values}
2139 ? "'foreign_values'-based reversed-"
2144 # we got something back - sanity check and infer values if we can
2147 $ret->{join_free_condition}
2149 $ret->{join_free_condition} ne UNRESOLVABLE_CONDITION
2151 my $jfc = $storage->_collapse_cond( $ret->{join_free_condition} )
2154 my $jfc_eqs = $storage->_extract_fixed_condition_columns($jfc, 'consider_nulls');
2156 if (keys %$jfc_eqs) {
2159 # $jfc is fully qualified by definition
2160 my ($col) = $_ =~ /\.(.+)/;
2162 if (exists $jfc_eqs->{$_} and ($jfc_eqs->{$_}||'') ne UNRESOLVABLE_CONDITION) {
2163 $ret->{inferred_values}{$col} = $jfc_eqs->{$_};
2165 elsif ( !$args->{infer_values_based_on} or ! exists $args->{infer_values_based_on}{$col} ) {
2166 push @nonvalues, $col;
2171 delete $ret->{inferred_values} if @nonvalues;
2175 # did the user explicitly ask
2176 if ($args->{infer_values_based_on}) {
2178 $self->throw_exception(sprintf (
2179 "Unable to complete value inferrence - custom $exception_rel_id returns conditions instead of values for column(s): %s",
2180 map { "'$_'" } @nonvalues
2184 $ret->{inferred_values} ||= {};
2186 $ret->{inferred_values}{$_} = $args->{infer_values_based_on}{$_}
2187 for keys %{$args->{infer_values_based_on}};
2190 # add the identities based on the main condition
2191 # (may already be there, since easy to calculate on the fly in the HASH case)
2192 if ( ! $ret->{identity_map} ) {
2194 my $col_eqs = $storage->_extract_fixed_condition_columns($ret->{condition});
2197 for my $lhs (keys %$col_eqs) {
2199 next if $col_eqs->{$lhs} eq UNRESOLVABLE_CONDITION;
2201 # there is no way to know who is right and who is left in a cref
2202 # therefore a full blown resolution call, and figure out the
2203 # direction a bit further below
2204 $colinfos ||= $storage->_resolve_column_info([
2205 { -alias => $args->{self_alias}, -rsrc => $self },
2206 { -alias => $args->{foreign_alias}, -rsrc => $rel_rsrc },
2209 next unless $colinfos->{$lhs}; # someone is engaging in witchcraft
2211 if ( my $rhs_ref = is_literal_value( $col_eqs->{$lhs} ) ) {
2214 $colinfos->{$rhs_ref->[0]}
2216 $colinfos->{$lhs}{-source_alias} ne $colinfos->{$rhs_ref->[0]}{-source_alias}
2218 ( $colinfos->{$lhs}{-source_alias} eq $args->{self_alias} )
2219 ? ( $ret->{identity_map}{$colinfos->{$lhs}{-colname}} = $colinfos->{$rhs_ref->[0]}{-colname} )
2220 : ( $ret->{identity_map}{$colinfos->{$rhs_ref->[0]}{-colname}} = $colinfos->{$lhs}{-colname} )
2225 $col_eqs->{$lhs} =~ /^ ( \Q$args->{self_alias}\E \. .+ ) /x
2227 ($colinfos->{$1}||{})->{-result_source} == $rel_rsrc
2229 my ($lcol, $rcol) = map
2230 { $colinfos->{$_}{-colname} }
2234 "The $exception_rel_id specifies equality of column '$lcol' and the "
2235 . "*VALUE* '$rcol' (you did not use the { -ident => ... } operator)"
2241 # FIXME - temporary, to fool the idiotic check in SQLMaker::_join_condition
2242 $ret->{condition} = { -and => [ $ret->{condition} ] }
2243 unless $ret->{condition} eq UNRESOLVABLE_CONDITION;
2248 =head2 related_source
2252 =item Arguments: $rel_name
2254 =item Return Value: $source
2258 Returns the result source object for the given relationship.
2262 sub related_source {
2263 my ($self, $rel) = @_;
2264 if( !$self->has_relationship( $rel ) ) {
2265 $self->throw_exception("No such relationship '$rel' on " . $self->source_name);
2268 # if we are not registered with a schema - just use the prototype
2269 # however if we do have a schema - ask for the source by name (and
2270 # throw in the process if all fails)
2271 if (my $schema = dbic_internal_try { $self->schema }) {
2272 $schema->source($self->relationship_info($rel)->{source});
2275 my $class = $self->relationship_info($rel)->{class};
2276 $self->ensure_class_loaded($class);
2277 $class->result_source_instance;
2281 =head2 related_class
2285 =item Arguments: $rel_name
2287 =item Return Value: $classname
2291 Returns the class name for objects in the given relationship.
2296 my ($self, $rel) = @_;
2297 if( !$self->has_relationship( $rel ) ) {
2298 $self->throw_exception("No such relationship '$rel' on " . $self->source_name);
2300 return $self->schema->class($self->relationship_info($rel)->{source});
2307 =item Arguments: none
2309 =item Return Value: L<$source_handle|DBIx::Class::ResultSourceHandle>
2313 Obtain a new L<result source handle instance|DBIx::Class::ResultSourceHandle>
2314 for this source. Used as a serializable pointer to this resultsource, as it is not
2315 easy (nor advisable) to serialize CODErefs which may very well be present in e.g.
2316 relationship definitions.
2321 return DBIx::Class::ResultSourceHandle->new({
2322 source_moniker => $_[0]->source_name,
2324 # so that a detached thaw can be re-frozen
2325 $_[0]->{_detached_thaw}
2326 ? ( _detached_source => $_[0] )
2327 : ( schema => $_[0]->schema )
2332 my $global_phase_destroy;
2334 ### NO detected_reinvoked_destructor check
2335 ### This code very much relies on being called multuple times
2337 return if $global_phase_destroy ||= in_global_destruction;
2343 # Under no circumstances shall $_[0] be stored anywhere else (like copied to
2344 # a lexical variable, or shifted, or anything else). Doing so will mess up
2345 # the refcount of this particular result source, and will allow the $schema
2346 # we are trying to save to reattach back to the source we are destroying.
2347 # The relevant code checking refcounts is in ::Schema::DESTROY()
2349 # if we are not a schema instance holder - we don't matter
2351 ! ref $_[0]->{schema}
2353 isweak $_[0]->{schema}
2356 # weaken our schema hold forcing the schema to find somewhere else to live
2357 # during global destruction (if we have not yet bailed out) this will throw
2358 # which will serve as a signal to not try doing anything else
2359 # however beware - on older perls the exception seems randomly untrappable
2360 # due to some weird race condition during thread joining :(((
2363 weaken $_[0]->{schema};
2365 # if schema is still there reintroduce ourselves with strong refs back to us
2366 if ($_[0]->{schema}) {
2367 my $srcregs = $_[0]->{schema}->source_registrations;
2368 for (keys %$srcregs) {
2369 next unless $srcregs->{$_};
2370 $srcregs->{$_} = $_[0] if $srcregs->{$_} == $_[0];
2376 $global_phase_destroy = 1;
2379 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
2380 # collected before leaving this scope. Depending on the code above, this
2381 # may very well be just a preventive measure guarding future modifications
2385 sub STORABLE_freeze { Storable::nfreeze($_[0]->handle) }
2388 my ($self, $cloning, $ice) = @_;
2389 %$self = %{ (Storable::thaw($ice))->resolve };
2392 =head2 throw_exception
2394 See L<DBIx::Class::Schema/"throw_exception">.
2398 sub throw_exception {
2402 ? $self->{schema}->throw_exception(@_)
2403 : DBIx::Class::Exception->throw(@_)
2407 =head2 column_info_from_storage
2411 =item Arguments: 1/0 (default: 0)
2413 =item Return Value: 1/0
2417 __PACKAGE__->column_info_from_storage(1);
2419 Enables the on-demand automatic loading of the above column
2420 metadata from storage as necessary. This is *deprecated*, and
2421 should not be used. It will be removed before 1.0.
2423 =head1 FURTHER QUESTIONS?
2425 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
2427 =head1 COPYRIGHT AND LICENSE
2429 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
2430 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
2431 redistribute it and/or modify it under the same terms as the
2432 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.