Really fix SQLite savepoints unlike the shortsighted 398215b1
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / ResultClass / HashRefInflator.pm
1 package DBIx::Class::ResultClass::HashRefInflator;
2
3 use strict;
4 use warnings;
5
6 =head1 NAME
7
8 DBIx::Class::ResultClass::HashRefInflator - Get raw hashrefs from a resultset
9
10 =head1 SYNOPSIS
11
12  use DBIx::Class::ResultClass::HashRefInflator;
13
14  my $rs = $schema->resultset('CD');
15  $rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
16  while (my $hashref = $rs->next) {
17    ...
18  }
19
20   OR as an attribute:
21
22  my $rs = $schema->resultset('CD')->search({}, {
23    result_class => 'DBIx::Class::ResultClass::HashRefInflator',
24  });
25  while (my $hashref = $rs->next) {
26    ...
27  }
28
29 =head1 DESCRIPTION
30
31 DBIx::Class is faster than older ORMs like Class::DBI but it still isn't
32 designed primarily for speed. Sometimes you need to quickly retrieve the data
33 from a massive resultset, while skipping the creation of fancy result objects.
34 Specifying this class as a C<result_class> for a resultset will change C<< $rs->next >>
35 to return a plain data hash-ref (or a list of such hash-refs if C<< $rs->all >> is used).
36
37 There are two ways of applying this class to a resultset:
38
39 =over
40
41 =item *
42
43 Specify C<< $rs->result_class >> on a specific resultset to affect only that
44 resultset (and any chained off of it); or
45
46 =item *
47
48 Specify C<< __PACKAGE__->result_class >> on your source object to force all
49 uses of that result source to be inflated to hash-refs - this approach is not
50 recommended.
51
52 =back
53
54 =cut
55
56 ##############
57 # NOTE
58 #
59 # Generally people use this to gain as much speed as possible. If a new &mk_hash is
60 # implemented, it should be benchmarked using the maint/benchmark_hashrefinflator.pl
61 # script (in addition to passing all tests of course :)
62
63 # This coderef is a simple recursive function
64 # Arguments: ($me, $prefetch, $is_root) from inflate_result() below
65 my $mk_hash;
66 $mk_hash = sub {
67
68   my $hash = {
69
70     # the main hash could be an undef if we are processing a skipped-over join
71     $_[0] ? %{$_[0]} : (),
72
73     # the second arg is a hash of arrays for each prefetched relation
74     map { $_ => (
75
76       # null-branch or not
77       ref $_[1]->{$_} eq $DBIx::Class::ResultSource::RowParser::Util::null_branch_class
78
79         ? ref $_[1]->{$_}[0] eq 'ARRAY' ? [] : undef
80
81         : ref $_[1]->{$_}[0] eq 'ARRAY'
82           ? [ map { $mk_hash->( @$_ ) || () } @{$_[1]->{$_}} ]
83           : $mk_hash->( @{$_[1]->{$_}} )
84
85     ) } ($_[1] ? keys %{$_[1]} : ())
86   };
87
88   ($_[2] || keys %$hash) ? $hash : undef;
89 };
90
91 =head1 METHODS
92
93 =head2 inflate_result
94
95 Inflates the result and prefetched data into a hash-ref (invoked by L<DBIx::Class::ResultSet>)
96
97 =cut
98
99 ##################################################################################
100 # inflate_result is invoked as:
101 # HRI->inflate_result ($resultsource_instance, $main_data_hashref, $prefetch_data_hashref)
102 sub inflate_result {
103   return $mk_hash->($_[2], $_[3], 'is_root');
104 }
105
106 1;
107
108 __END__
109
110 =head1 CAVEATS
111
112 =over
113
114 =item *
115
116 This will not work for relationships that have been prefetched. Consider the
117 following:
118
119  my $artist = $artitsts_rs->search({}, {prefetch => 'cds' })->first;
120
121  my $cds = $artist->cds;
122  $cds->result_class('DBIx::Class::ResultClass::HashRefInflator');
123  my $first = $cds->first;
124
125 C<$first> will B<not> be a hashref, it will be a normal CD row since
126 HashRefInflator only affects resultsets at inflation time, and prefetch causes
127 relations to be inflated when the master C<$artist> row is inflated.
128
129 =item *
130
131 Column value inflation, e.g., using modules like
132 L<DBIx::Class::InflateColumn::DateTime>, is not performed.
133 The returned hash contains the raw database values.
134
135 =back
136
137 =head1 FURTHER QUESTIONS?
138
139 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
140
141 =head1 COPYRIGHT AND LICENSE
142
143 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
144 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
145 redistribute it and/or modify it under the same terms as the
146 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.