b1c1e96d3cbad115c606ea5ff0fcc321299dc4da
[dbsrgits/DBIx-Class.git] / t / 88result_set_column.t
1 use strict;
2 use warnings;
3
4 use Test::More;
5 use Test::Warn;
6 use Test::Exception;
7 use lib qw(t/lib);
8 use DBICTest;
9 use DBIC::SqlMakerTest;
10
11 my $schema = DBICTest->init_schema();
12
13 my $rs = $schema->resultset("CD");
14
15 cmp_ok (
16   $rs->count,
17     '>',
18   $rs->search ({}, {columns => ['year'], distinct => 1})->count,
19   'At least one year is the same in rs'
20 );
21
22 my $rs_title = $rs->get_column('title');
23 my $rs_year = $rs->get_column('year');
24 my $max_year = $rs->get_column(\'MAX (year)');
25
26 my @all_titles = $rs_title->all;
27 cmp_ok(scalar @all_titles, '==', 5, "five titles returned");
28
29 my @nexted_titles;
30 while (my $r = $rs_title->next) {
31   push @nexted_titles, $r;
32 }
33
34 is_deeply (\@all_titles, \@nexted_titles, 'next works');
35
36 is_deeply( [ sort $rs_year->func('DISTINCT') ], [ 1997, 1998, 1999, 2001 ],  "wantarray context okay");
37 ok ($max_year->next == $rs_year->max, q/get_column (\'FUNC') ok/);
38
39 cmp_ok($rs_year->max, '==', 2001, "max okay for year");
40 is($rs_title->min, 'Caterwaulin\' Blues', "min okay for title");
41
42 cmp_ok($rs_year->sum, '==', 9996, "three artists returned");
43
44 my $rso_year = $rs->search({}, { order_by => 'cdid' })->get_column('year');
45 is($rso_year->next, 1999, "reset okay");
46
47 is($rso_year->first, 1999, "first okay");
48
49 warnings_exist (sub {
50   is($rso_year->single, 1999, "single okay");
51 }, qr/Query returned more than one row/, 'single warned');
52
53
54 # test distinct propagation
55 is_deeply (
56   [sort $rs->search ({}, { distinct => 1 })->get_column ('year')->all],
57   [sort $rs_year->func('distinct')],
58   'distinct => 1 is passed through properly',
59 );
60
61 # test illogical distinct
62 my $dist_rs = $rs->search ({}, {
63   columns => ['year'],
64   distinct => 1,
65   order_by => { -desc => [qw( cdid year )] },
66 });
67
68 is_same_sql_bind(
69   $dist_rs->as_query,
70   '(
71     SELECT me.year
72       FROM cd me
73     GROUP BY me.year
74     ORDER BY MAX(cdid) DESC, year DESC
75   )',
76   [],
77   'Correct SQL on external-ordered distinct',
78 );
79
80 is_same_sql_bind(
81   $dist_rs->count_rs->as_query,
82   '(
83     SELECT COUNT( * )
84       FROM (
85         SELECT me.year
86           FROM cd me
87         GROUP BY me.year
88       ) me
89   )',
90   [],
91   'Correct SQL on count of external-orderdd distinct',
92 );
93
94 is (
95   $dist_rs->count_rs->next,
96   4,
97   'Correct rs-count',
98 );
99
100 is (
101   $dist_rs->count,
102   4,
103   'Correct direct count',
104 );
105
106 # test +select/+as for single column
107 my $psrs = $schema->resultset('CD')->search({},
108     {
109         '+select'   => \'MAX(year)',
110         '+as'       => 'last_year'
111     }
112 );
113 lives_ok(sub { $psrs->get_column('last_year')->next }, '+select/+as additional column "last_year" present (scalar)');
114 dies_ok(sub { $psrs->get_column('noSuchColumn')->next }, '+select/+as nonexistent column throws exception');
115
116 # test +select/+as for overriding a column
117 $psrs = $schema->resultset('CD')->search({},
118     {
119         'select'   => \"'The Final Countdown'",
120         'as'       => 'title'
121     }
122 );
123 is($psrs->get_column('title')->next, 'The Final Countdown', '+select/+as overridden column "title"');
124
125
126 # test +select/+as for multiple columns
127 $psrs = $schema->resultset('CD')->search({},
128     {
129         '+select'   => [ \'LENGTH(title) AS title_length', 'title' ],
130         '+as'       => [ 'tlength', 'addedtitle' ]
131     }
132 );
133 lives_ok(sub { $psrs->get_column('tlength')->next }, '+select/+as multiple additional columns, "tlength" column present');
134 lives_ok(sub { $psrs->get_column('addedtitle')->next }, '+select/+as multiple additional columns, "addedtitle" column present');
135
136 # test that +select/+as specs do not leak
137 is_same_sql_bind (
138   $psrs->get_column('year')->as_query,
139   '(SELECT me.year FROM cd me)',
140   [],
141   'Correct SQL for get_column/as'
142 );
143
144 is_same_sql_bind (
145   $psrs->get_column('addedtitle')->as_query,
146   '(SELECT me.title FROM cd me)',
147   [],
148   'Correct SQL for get_column/+as col'
149 );
150
151 is_same_sql_bind (
152   $psrs->get_column('tlength')->as_query,
153   '(SELECT LENGTH(title) AS title_length FROM cd me)',
154   [],
155   'Correct SQL for get_column/+as func'
156 );
157
158 # test that order_by over a function forces a subquery
159 lives_ok ( sub {
160   is_deeply (
161     [ $psrs->search ({}, { order_by => { -desc => 'title_length' } })->get_column ('title')->all ],
162     [
163       "Generic Manufactured Singles",
164       "Come Be Depressed With Us",
165       "Caterwaulin' Blues",
166       "Spoonful of bees",
167       "Forkful of bees",
168     ],
169     'Subquery count induced by aliased ordering function',
170   );
171 });
172
173 # test for prefetch not leaking
174 {
175   my $rs = $schema->resultset("CD")->search({}, { prefetch => 'artist' });
176   my $rsc = $rs->get_column('year');
177   is( $rsc->{_parent_resultset}->{attrs}->{prefetch}, undef, 'prefetch wiped' );
178 }
179
180 # test sum()
181 is ($schema->resultset('BooksInLibrary')->get_column ('price')->sum, 125, 'Sum of a resultset works correctly');
182
183 # test sum over search_related
184 my $owner = $schema->resultset('Owners')->find ({ name => 'Newton' });
185 ok ($owner->books->count > 1, 'Owner Newton has multiple books');
186 is ($owner->search_related ('books')->get_column ('price')->sum, 60, 'Correctly calculated price of all owned books');
187
188
189 # make sure joined/prefetched get_column of a PK dtrt
190 $rs->reset;
191 my $j_rs = $rs->search ({}, { join => 'tracks' })->get_column ('cdid');
192 is_deeply (
193   [ sort $j_rs->all ],
194   [ sort map { my $c = $rs->next; ( ($c->id) x $c->tracks->count ) } (1 .. $rs->count) ],
195   'join properly explodes amount of rows from get_column',
196 );
197
198 $rs->reset;
199 my $p_rs = $rs->search ({}, { prefetch => 'tracks' })->get_column ('cdid');
200 is_deeply (
201   [ sort $p_rs->all ],
202   [ sort $rs->get_column ('cdid')->all ],
203   'prefetch properly collapses amount of rows from get_column',
204 );
205
206 $rs->reset;
207 my $pob_rs = $rs->search({}, {
208   select   => ['me.title', 'tracks.title'],
209   prefetch => 'tracks',
210   order_by => [{-asc => ['position']}],
211   group_by => ['me.title', 'tracks.title'],
212 });
213 is_same_sql_bind (
214   $pob_rs->get_column("me.title")->as_query,
215   '(SELECT me.title FROM (SELECT me.title, tracks.title FROM cd me LEFT JOIN track tracks ON tracks.cd = me.cdid GROUP BY me.title, tracks.title ORDER BY position ASC) me)',
216   [],
217   'Correct SQL for prefetch/order_by/group_by'
218 );
219
220 # test aggregate on a function (create an extra track on one cd)
221 {
222   my $tr_rs = $schema->resultset("Track");
223   $tr_rs->create({ cd => 2, title => 'dealbreaker' });
224
225   is(
226     $tr_rs->get_column('cd')->max,
227     5,
228     "Correct: Max cd in Track is 5"
229   );
230
231   my $track_counts_per_cd_via_group_by = $tr_rs->search({}, {
232     columns => [ 'cd', { cnt => { count => 'trackid', -as => 'cnt' } } ],
233     group_by => 'cd',
234   })->get_column('cnt');
235
236   is ($track_counts_per_cd_via_group_by->max, 4, 'Correct max tracks per cd');
237   is ($track_counts_per_cd_via_group_by->min, 3, 'Correct min tracks per cd');
238   is (
239     sprintf('%0.1f', $track_counts_per_cd_via_group_by->func('avg') ),
240     '3.2',
241     'Correct avg tracks per cd'
242   );
243 }
244
245 # test exotic scenarious (create a track-less cd)
246 # "How many CDs (not tracks) have been released per year where a given CD has at least one track and the artist isn't evancarroll?"
247 {
248
249   $schema->resultset('CD')->create({ artist => 1, title => 'dealbroker no tracks', year => 2001 });
250
251   my $rs = $schema->resultset ('CD')->search (
252     { 'artist.name' => { '!=', 'evancarrol' }, 'tracks.trackid' => { '!=', undef } },
253     {
254       order_by => 'me.year',
255       join => [qw(artist tracks)],
256       columns => [ 'year', { cnt => { count => 'me.cdid' }} ],
257     },
258   );
259
260   my $rstypes = {
261     'explicitly grouped' => $rs->search_rs({}, { group_by => 'year' }),
262     'implicitly grouped' => $rs->search_rs({}, { distinct => 1 }),
263   };
264
265   for my $type (keys %$rstypes) {
266     is ($rstypes->{$type}->count, 4, "correct cd count with $type column");
267
268     is_deeply (
269       [ $rstypes->{$type}->get_column ('year')->all ],
270       [qw(1997 1998 1999 2001)],
271       "Getting $type column works",
272     );
273   }
274
275   # Why do we test this - we want to make sure that the selector *will* actually make
276   # it to the group_by as per the distinct => 1 contract. Before 0.08251 this situation
277   # would silently drop the group_by entirely, likely ending up with nonsensival results
278   # With the current behavior the user will at least get a nice fat exception from the
279   # RDBMS (or maybe the RDBMS will even decide to handle the situation sensibly...)
280   warnings_exist { is_same_sql_bind(
281     $rstypes->{'implicitly grouped'}->get_column('cnt')->as_query,
282     '(
283       SELECT COUNT( me.cdid )
284         FROM cd me
285         JOIN artist artist
286           ON artist.artistid = me.artist
287         LEFT JOIN track tracks
288           ON tracks.cd = me.cdid
289       WHERE artist.name != ? AND tracks.trackid IS NOT NULL
290       GROUP BY COUNT( me.cdid )
291       ORDER BY MIN(me.year)
292     )',
293     [ [ { dbic_colname => 'artist.name', sqlt_datatype => 'varchar', sqlt_size => 100 }
294         => 'evancarrol'
295     ] ],
296     'Expected (though nonsensical) SQL generated on rscol-with-distinct-over-function',
297   ) } qr/
298     \QUse of distinct => 1 while selecting anything other than a column \E
299     \Qdeclared on the primary ResultSource is deprecated\E
300   /x, 'deprecation warning';
301
302   {
303     local $TODO = 'multiplying join leaks through to the count aggregate... this may never actually work';
304     is_deeply (
305       [ $rstypes->{'explicitly grouped'}->get_column ('cnt')->all ],
306       [qw(1 1 1 2)],
307       "Get aggregate over group works",
308     );
309   }
310 }
311
312 done_testing;