Make POD a little more obvious about component order
[dbsrgits/DBIx-Class.git] / t / 76joins.t
CommitLineData
70350518 1use strict;
2use warnings;
3
4use Test::More;
5use lib qw(t/lib);
6use DBICTest;
cb3e35d2 7use Data::Dumper;
70350518 8
a47e1233 9my $schema = DBICTest->init_schema();
0567538f 10
4d91ad3f 11my $orig_debug = $schema->storage->debug;
12
0567538f 13use IO::File;
14
15BEGIN {
16 eval "use DBD::SQLite";
17 plan $@
18 ? ( skip_all => 'needs DBD::SQLite for testing' )
705a9709 19 : ( tests => 53 );
0567538f 20}
21
58ff4acf 22# figure out if we've got a version of sqlite that is older than 3.2.6, in
23# which case COUNT(DISTINCT()) doesn't work
24my $is_broken_sqlite = 0;
25my ($sqlite_major_ver,$sqlite_minor_ver,$sqlite_patch_ver) =
26 split /\./, $schema->storage->dbh->get_info(18);
27if( $schema->storage->dbh->get_info(17) eq 'SQLite' &&
28 ( ($sqlite_major_ver < 3) ||
29 ($sqlite_major_ver == 3 && $sqlite_minor_ver < 2) ||
30 ($sqlite_major_ver == 3 && $sqlite_minor_ver == 2 && $sqlite_patch_ver < 6) ) ) {
31 $is_broken_sqlite = 1;
32}
485f6e10 33
0567538f 34# test the abstract join => SQL generator
35my $sa = new DBIC::SQL::Abstract;
36
37my @j = (
38 { child => 'person' },
39 [ { father => 'person' }, { 'father.person_id' => 'child.father_id' }, ],
40 [ { mother => 'person' }, { 'mother.person_id' => 'child.mother_id' } ],
41);
42my $match = 'person child JOIN person father ON ( father.person_id = '
43 . 'child.father_id ) JOIN person mother ON ( mother.person_id '
44 . '= child.mother_id )'
45 ;
46is( $sa->_recurse_from(@j), $match, 'join 1 ok' );
47
48my @j2 = (
49 { mother => 'person' },
50 [ [ { child => 'person' },
51 [ { father => 'person' },
52 { 'father.person_id' => 'child.father_id' }
53 ]
54 ],
55 { 'mother.person_id' => 'child.mother_id' }
56 ],
57);
58$match = 'person mother JOIN (person child JOIN person father ON ('
59 . ' father.person_id = child.father_id )) ON ( mother.person_id = '
60 . 'child.mother_id )'
61 ;
62is( $sa->_recurse_from(@j2), $match, 'join 2 ok' );
63
64my @j3 = (
65 { child => 'person' },
66 [ { father => 'person', -join_type => 'inner' }, { 'father.person_id' => 'child.father_id' }, ],
67 [ { mother => 'person', -join_type => 'inner' }, { 'mother.person_id' => 'child.mother_id' } ],
68);
69$match = 'person child INNER JOIN person father ON ( father.person_id = '
70 . 'child.father_id ) INNER JOIN person mother ON ( mother.person_id '
71 . '= child.mother_id )'
72 ;
73
74is( $sa->_recurse_from(@j3), $match, 'join 3 (inner join) ok');
75
ca7b9fdf 76my @j4 = (
77 { mother => 'person' },
78 [ [ { child => 'person', -join_type => 'left' },
79 [ { father => 'person', -join_type => 'right' },
80 { 'father.person_id' => 'child.father_id' }
81 ]
82 ],
83 { 'mother.person_id' => 'child.mother_id' }
84 ],
85);
86$match = 'person mother LEFT JOIN (person child RIGHT JOIN person father ON ('
87 . ' father.person_id = child.father_id )) ON ( mother.person_id = '
88 . 'child.mother_id )'
89 ;
90is( $sa->_recurse_from(@j4), $match, 'join 4 (nested joins + join types) ok');
91
635b9634 92my @j5 = (
93 { child => 'person' },
94 [ { father => 'person' }, { 'father.person_id' => \'!= child.father_id' }, ],
95 [ { mother => 'person' }, { 'mother.person_id' => 'child.mother_id' } ],
96);
97$match = 'person child JOIN person father ON ( father.person_id != '
98 . 'child.father_id ) JOIN person mother ON ( mother.person_id '
99 . '= child.mother_id )'
100 ;
101is( $sa->_recurse_from(@j5), $match, 'join 5 (SCALAR reference for ON statement) ok' );
102
103my @j6 = (
104 { child => 'person' },
105 [ { father => 'person' }, { 'father.person_id' => { '!=', '42' } }, ],
106 [ { mother => 'person' }, { 'mother.person_id' => 'child.mother_id' } ],
107);
108$match = qr/^\QHASH reference arguments are not supported in JOINS - try using \"..." instead\E/;
109eval { $sa->_recurse_from(@j6) };
110like( $@, $match, 'join 6 (HASH reference for ON statement dies) ok' );
111
f9db5527 112my $rs = $schema->resultset("CD")->search(
0567538f 113 { 'year' => 2001, 'artist.name' => 'Caterwauler McCrae' },
114 { from => [ { 'me' => 'cd' },
115 [
116 { artist => 'artist' },
117 { 'me.artist' => 'artist.artistid' }
118 ] ] }
119 );
120
ebaefbc2 121cmp_ok( $rs + 0, '==', 1, "Single record in resultset");
0567538f 122
123is($rs->first->title, 'Forkful of bees', 'Correct record returned');
124
f9db5527 125$rs = $schema->resultset("CD")->search(
0567538f 126 { 'year' => 2001, 'artist.name' => 'Caterwauler McCrae' },
127 { join => 'artist' });
128
ebaefbc2 129cmp_ok( $rs + 0, '==', 1, "Single record in resultset");
0567538f 130
131is($rs->first->title, 'Forkful of bees', 'Correct record returned');
132
f9db5527 133$rs = $schema->resultset("CD")->search(
0567538f 134 { 'artist.name' => 'We Are Goth',
135 'liner_notes.notes' => 'Kill Yourself!' },
136 { join => [ qw/artist liner_notes/ ] });
137
ebaefbc2 138cmp_ok( $rs + 0, '==', 1, "Single record in resultset");
0567538f 139
140is($rs->first->title, 'Come Be Depressed With Us', 'Correct record returned');
141
8fe164b9 142# when using join attribute, make sure slice()ing all objects has same count as all()
f9db5527 143$rs = $schema->resultset("CD")->search(
8fe164b9 144 { 'artist' => 1 },
145 { join => [qw/artist/], order_by => 'artist.name' }
146);
147cmp_ok( scalar $rs->all, '==', scalar $rs->slice(0, $rs->count - 1), 'slice() with join has same count as all()' );
148
f9db5527 149$rs = $schema->resultset("Artist")->search(
0567538f 150 { 'liner_notes.notes' => 'Kill Yourself!' },
151 { join => { 'cds' => 'liner_notes' } });
152
153cmp_ok( $rs->count, '==', 1, "Single record in resultset");
154
155is($rs->first->name, 'We Are Goth', 'Correct record returned');
156
cb3e35d2 157# bug in 0.07000 caused attr (join/prefetch) to be modifed by search
158# so we check the search & attr arrays are not modified
159my $search = { 'artist.name' => 'Caterwauler McCrae' };
160my $attr = { prefetch => [ qw/artist liner_notes/ ],
161 order_by => 'me.cdid' };
162my $search_str = Dumper($search);
163my $attr_str = Dumper($attr);
164
165$rs = $schema->resultset("CD")->search($search, $attr);
0567538f 166
cb3e35d2 167is(Dumper($search), $search_str, 'Search hash untouched after search()');
168is(Dumper($attr), $attr_str, 'Attribute hash untouched after search()');
ebaefbc2 169cmp_ok($rs + 0, '==', 3, 'Correct number of records returned');
0567538f 170
d52170d4 171my $queries = 0;
172$schema->storage->debugcb(sub { $queries++ });
d52170d4 173$schema->storage->debug(1);
0567538f 174
175my @cd = $rs->all;
176
177is($cd[0]->title, 'Spoonful of bees', 'First record returned ok');
178
7cd300ea 179ok(!defined $cd[0]->liner_notes, 'No prefetch for NULL LEFT join');
0567538f 180
181is($cd[1]->{_relationship_data}{liner_notes}->notes, 'Buy Whiskey!', 'Prefetch for present LEFT JOIN');
182
dd417d06 183is(ref $cd[1]->liner_notes, 'DBICTest::LinerNotes', 'Prefetch returns correct class');
184
0567538f 185is($cd[2]->{_inflated_column}{artist}->name, 'Caterwauler McCrae', 'Prefetch on parent object ok');
186
d52170d4 187is($queries, 1, 'prefetch ran only 1 select statement');
188
4d91ad3f 189$schema->storage->debug($orig_debug);
190$schema->storage->debugobj->callback(undef);
0567538f 191
9b465d00 192# test for partial prefetch via columns attr
d20bb28e 193my $cd = $schema->resultset('CD')->find(1,
194 {
9b465d00 195 columns => [qw/title artist.name/],
0e35aa05 196 join => { 'artist' => {} }
d20bb28e 197 }
198);
199ok(eval { $cd->artist->name eq 'Caterwauler McCrae' }, 'single related column prefetched');
200
b3e8ac9b 201# start test for nested prefetch SELECT count
d52170d4 202$queries = 0;
db0e65d2 203$schema->storage->debugcb(sub { $queries++ });
d52170d4 204$schema->storage->debug(1);
b3e8ac9b 205
206$rs = $schema->resultset('Tag')->search(
207 {},
208 {
209 prefetch => { cd => 'artist' }
210 }
211);
212
213my $tag = $rs->first;
214
215is( $tag->cd->title, 'Spoonful of bees', 'step 1 ok for nested prefetch' );
216
217is( $tag->cd->artist->name, 'Caterwauler McCrae', 'step 2 ok for nested prefetch');
218
219# count the SELECTs
d52170d4 220#$selects++ if /SELECT(?!.*WHERE 1=0.*)/;
221is($queries, 1, 'nested prefetch ran exactly 1 select statement (excluding column_info)');
b3e8ac9b 222
d52170d4 223$queries = 0;
c5b7d799 224
d20bb28e 225$cd = $schema->resultset('CD')->find(1, { prefetch => 'artist' });
c5b7d799 226
227is($cd->{_inflated_column}{artist}->name, 'Caterwauler McCrae', 'artist prefetched correctly on find');
228
d52170d4 229is($queries, 1, 'find with prefetch ran exactly 1 select statement (excluding column_info)');
230
4d91ad3f 231$schema->storage->debug($orig_debug);
232$schema->storage->debugobj->callback(undef);
c5b7d799 233
b3e8ac9b 234$rs = $schema->resultset('Tag')->search(
235 {},
236 {
237 join => { cd => 'artist' },
238 prefetch => { cd => 'artist' }
239 }
240);
241
242cmp_ok( $rs->count, '>=', 0, 'nested prefetch does not duplicate joins' );
243
f9db5527 244my ($artist) = $schema->resultset("Artist")->search({ 'cds.year' => 2001 },
0567538f 245 { order_by => 'artistid DESC', join => 'cds' });
246
247is($artist->name, 'Random Boy Band', "Join search by object ok");
248
f9db5527 249my @cds = $schema->resultset("CD")->search({ 'liner_notes.notes' => 'Buy Merch!' },
0567538f 250 { join => 'liner_notes' });
251
252cmp_ok(scalar @cds, '==', 1, "Single CD retrieved via might_have");
253
254is($cds[0]->title, "Generic Manufactured Singles", "Correct CD retrieved");
255
f9db5527 256my @artists = $schema->resultset("Artist")->search({ 'tags.tag' => 'Shiny' },
0567538f 257 { join => { 'cds' => 'tags' } });
258
259cmp_ok( @artists, '==', 2, "two-join search ok" );
260
15c382be 261$rs = $schema->resultset("CD")->search(
262 {},
263 { group_by => [qw/ title me.cdid /] }
264);
265
485f6e10 266SKIP: {
267 skip "SQLite < 3.2.6 doesn't understand COUNT(DISTINCT())", 1
268 if $is_broken_sqlite;
269 cmp_ok( $rs->count, '==', 5, "count() ok after group_by on main pk" );
270}
15c382be 271
272cmp_ok( scalar $rs->all, '==', 5, "all() returns same count as count() after group_by on main pk" );
273
274$rs = $schema->resultset("CD")->search(
275 {},
276 { join => [qw/ artist /], group_by => [qw/ artist.name /] }
277);
278
485f6e10 279SKIP: {
280 skip "SQLite < 3.2.6 doesn't understand COUNT(DISTINCT())", 1
281 if $is_broken_sqlite;
282 cmp_ok( $rs->count, '==', 3, "count() ok after group_by on related column" );
283}
15c382be 284
8839560b 285$rs = $schema->resultset("Artist")->search(
6991aba3 286 {},
01c73d7b 287 { join => [qw/ cds /], group_by => [qw/ me.name /], having =>{ 'MAX(cds.cdid)'=> \'< 5' } }
6991aba3 288);
289
8839560b 290cmp_ok( $rs->all, '==', 2, "results ok after group_by on related column with a having" );
6991aba3 291
01c73d7b 292$rs = $rs->search( undef, { having =>{ 'count(*)'=> \'> 2' }});
6991aba3 293
8839560b 294cmp_ok( $rs->all, '==', 1, "count() ok after group_by on related column with a having" );
489709af 295
296$rs = $schema->resultset("Artist")->search(
297 { 'cds.title' => 'Spoonful of bees',
298 'cds_2.title' => 'Forkful of bees' },
299 { join => [ 'cds', 'cds' ] });
300
485f6e10 301SKIP: {
302 skip "SQLite < 3.2.6 doesn't understand COUNT(DISTINCT())", 1
303 if $is_broken_sqlite;
304 cmp_ok($rs->count, '==', 1, "single artist returned from multi-join");
305}
306
489709af 307is($rs->next->name, 'Caterwauler McCrae', "Correct artist returned");
308
d52170d4 309$queries = 0;
db0e65d2 310$schema->storage->debugcb(sub { $queries++ });
887ce227 311$schema->storage->debug(1);
312
313my $tree_like =
314 $schema->resultset('TreeLike')->find(4,
315 { join => { parent => { parent => 'parent' } },
316 prefetch => { parent => { parent => 'parent' } } });
317
318is($tree_like->name, 'quux', 'Bottom of tree ok');
319$tree_like = $tree_like->parent;
320is($tree_like->name, 'baz', 'First level up ok');
321$tree_like = $tree_like->parent;
322is($tree_like->name, 'bar', 'Second level up ok');
323$tree_like = $tree_like->parent;
324is($tree_like->name, 'foo', 'Third level up ok');
325
4d91ad3f 326$schema->storage->debug($orig_debug);
327$schema->storage->debugobj->callback(undef);
887ce227 328
329cmp_ok($queries, '==', 1, 'Only one query run');
330
10ed6c25 331$tree_like = $schema->resultset('TreeLike')->search({'me.id' => 1});
af4cd3e5 332$tree_like = $tree_like->search_related('children')->search_related('children')->search_related('children')->first;
7e5b5f6e 333is($tree_like->name, 'quux', 'Tree search_related ok');
334
48d2be64 335$tree_like = $schema->resultset('TreeLike')->search_related('children',
336 { 'children.id' => 2, 'children_2.id' => 3 },
337 { prefetch => { children => 'children' } }
338 )->first;
b377c7e1 339is(eval { $tree_like->children->first->children->first->name }, 'quux',
340 'Tree search_related with prefetch ok');
10ed6c25 341
b377c7e1 342$tree_like = eval { $schema->resultset('TreeLike')->search(
10ed6c25 343 { 'children.id' => 2, 'children_2.id' => 5 },
3583d755 344 { join => [qw/children children/] }
9755b3df 345 )->search_related('children', { 'children_4.id' => 6 }, { prefetch => 'children' }
b377c7e1 346 )->first->children->first; };
347is(eval { $tree_like->name }, 'fong', 'Tree with multiple has_many joins ok');
10ed6c25 348
7e5b5f6e 349# test that collapsed joins don't get a _2 appended to the alias
350
351my $sql = '';
352$schema->storage->debugcb(sub { $sql = $_[1] });
353$schema->storage->debug(1);
354
355eval {
356 my $row = $schema->resultset('Artist')->search_related('cds', undef, {
357 join => 'tracks',
358 prefetch => 'tracks',
359 })->search_related('tracks')->first;
360};
361
9755b3df 362like( $sql, qr/^SELECT tracks_2\.trackid/, "join not collapsed for search_related" );
7e5b5f6e 363
4d91ad3f 364$schema->storage->debug($orig_debug);
365$schema->storage->debugobj->callback(undef);
907d3b9b 366
a08c907f 367$rs = $schema->resultset('Artist');
368$rs->create({ artistid => 4, name => 'Unknown singer-songwriter' });
369$rs->create({ artistid => 5, name => 'Emo 4ever' });
370@artists = $rs->search(undef, { prefetch => 'cds', order_by => 'artistid' });
371is(scalar @artists, 5, 'has_many prefetch with adjacent empty rows ok');
372
907d3b9b 373# -------------
374#
375# Tests for multilevel has_many prefetch
376
377# artist resultsets - with and without prefetch
378my $art_rs = $schema->resultset('Artist');
379my $art_rs_pr = $art_rs->search(
380 {},
381 {
382 join => [ { cds => ['tracks'] } ],
383 prefetch => [ { cds => ['tracks'] } ]
384 }
385);
386
387# This test does the same operation twice - once on a
388# set of items fetched from the db with no prefetch of has_many rels
389# The second prefetches 2 levels of has_many
390# We check things are the same by comparing the name or title
391# we build everything into a hash structure and compare the one
392# from each rs to see what differs
393
394sub make_hash_struc {
395 my $rs = shift;
396
397 my $struc = {};
398 foreach my $art ( $rs->all ) {
399 foreach my $cd ( $art->cds ) {
400 foreach my $track ( $cd->tracks ) {
401 $struc->{ $art->name }{ $cd->title }{ $track->title }++;
402 }
403 }
404 }
405 return $struc;
406}
407
408my $prefetch_result = make_hash_struc($art_rs_pr);
409my $nonpre_result = make_hash_struc($art_rs);
410
e0f10115 411TODO: {
412 local $TODO = 'fixing collapse in -current';
907d3b9b 413is_deeply( $prefetch_result, $nonpre_result,
414 'Compare 2 level prefetch result to non-prefetch result' );
e0f10115 415}