1 package DBIx::Class::SQLMaker;
5 DBIx::Class::SQLMaker - An SQL::Abstract-based SQL maker class
9 This module is a subclass of L<SQL::Abstract> and includes a number of
10 DBIC-specific workarounds, not yet suitable for inclusion into the
11 L<SQL::Abstract> core. It also provides all (and more than) the functionality
12 of L<SQL::Abstract::Limit>, see L<DBIx::Class::SQLMaker::LimitDialects> for
15 Currently the enhancements to L<SQL::Abstract> are:
19 =item * Support for C<JOIN> statements (via extended C<table/from> support)
21 =item * Support of functions in C<SELECT> lists
23 =item * C<GROUP BY>/C<HAVING> support (via extensions to the order_by parameter)
25 =item * Support of C<...FOR UPDATE> type of select statement modifiers
27 =item * The -ident operator
29 =item * The -value operator
36 DBIx::Class::SQLMaker::LimitDialects
38 Class::Accessor::Grouped
43 use Sub::Name 'subname';
44 use Carp::Clan qw/^DBIx::Class|^SQL::Abstract|^Try::Tiny/;
47 __PACKAGE__->mk_group_accessors (simple => qw/quote_char name_sep limit_dialect/);
49 # for when I need a normalized l/r pair
52 { defined $_ ? $_ : '' }
53 ( ref $_[0]->{quote_char} ? (@{$_[0]->{quote_char}}) : ( ($_[0]->{quote_char}) x 2 ) )
58 # reinstall the carp()/croak() functions imported into SQL::Abstract
59 # as Carp and Carp::Clan do not like each other much
60 no warnings qw/redefine/;
62 for my $f (qw/carp croak/) {
64 my $orig = \&{"SQL::Abstract::$f"};
65 my $clan_import = \&{$f};
66 *{"SQL::Abstract::$f"} = subname "SQL::Abstract::$f" =>
68 if (Carp::longmess() =~ /DBIx::Class::SQLMaker::[\w]+ .+? called \s at/x) {
78 # the "oh noes offset/top without limit" constant
79 # limited to 32 bits for sanity (and consistency,
80 # since it is ultimately handed to sprintf %u)
81 # Implemented as a method, since ::Storage::DBI also
82 # refers to it (i.e. for the case of software_limit or
83 # as the value to abuse with MSSQL ordered subqueries)
84 sub __max_int { 0xFFFFFFFF };
87 my $self = shift->next::method(@_);
89 # use the same coderefs, they are prepared to handle both cases
90 my @extra_dbic_syntax = (
91 { regex => qr/^ ident $/xi, handler => '_where_op_IDENT' },
92 { regex => qr/^ value $/xi, handler => '_where_op_VALUE' },
95 push @{$self->{special_ops}}, @extra_dbic_syntax;
96 push @{$self->{unary_ops}}, @extra_dbic_syntax;
101 sub _where_op_IDENT {
103 my ($op, $rhs) = splice @_, -2;
105 croak "-$op takes a single scalar argument (a quotable identifier)";
108 # in case we are called as a top level special op (no '=')
111 $_ = $self->_convert($self->_quote($_)) for ($lhs, $rhs);
119 sub _where_op_VALUE {
121 my ($op, $rhs) = splice @_, -2;
123 # in case we are called as a top level special op (no '=')
127 ($lhs || $self->{_nested_func_lhs} || croak "Unable to find bindtype for -value $rhs"),
133 $self->_convert($self->_quote($lhs)) . ' = ' . $self->_convert('?'),
137 $self->_convert('?'),
143 my $callsites_warned;
145 # determine callsite obeying Carp::Clan rules (fucking ugly but don't have better ideas)
148 local $SIG{__WARN__} = sub { $w = shift };
153 carp ("-nest in search conditions is deprecated, you most probably wanted:\n"
154 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
155 ) unless $callsites_warned->{$callsite}++;
157 shift->next::method(@_);
160 # Handle limit-dialect selection
162 my ($self, $table, $fields, $where, $rs_attrs, $limit, $offset) = @_;
165 $fields = $self->_recurse_fields($fields);
167 if (defined $offset) {
168 croak ('A supplied offset must be a non-negative integer')
169 if ( $offset =~ /\D/ or $offset < 0 );
173 if (defined $limit) {
174 croak ('A supplied limit must be a positive integer')
175 if ( $limit =~ /\D/ or $limit <= 0 );
178 $limit = $self->__max_int;
184 # this is legacy code-flow from SQLA::Limit, it is not set in stone
186 ($sql, @bind) = $self->__overriden_select($table, $fields, $where);
189 $self->can ('emulate_limit') # also backcompat hook from SQLA::Limit
192 my $dialect = $self->limit_dialect
193 or croak "Unable to generate SQL-limit - no limit dialect specified on $self, and no emulate_limit method found";
194 $self->can ("_$dialect")
195 or croak (__PACKAGE__ . " does not implement the requested dialect '$dialect'");
199 $sql = $self->$limiter ($sql, $rs_attrs, $limit, $offset);
202 ($sql, @bind) = $self->__overriden_select($table, $fields, $where, $rs_attrs);
205 push @{$self->{where_bind}}, @bind;
207 # this *must* be called, otherwise extra binds will remain in the sql-maker
208 my @all_bind = $self->_assemble_binds;
210 $sql .= $self->_lock_select ($rs_attrs->{for})
213 return wantarray ? ($sql, @all_bind) : $sql;
216 sub __overriden_select {
218 my ($table, @bind) = $self->_table(shift);
219 my $fields = shift || '*';
223 my($where_sql, @morebind) = $self->where($where, $order);
224 push @bind, @morebind;
226 my $f = (ref $fields eq 'ARRAY') ? join ', ', map { $self->_quote($_) } @$fields
228 my $sql = join(' ', $self->_sqlcase('select'), $f,
229 $self->_sqlcase('from'), $table)
232 return wantarray ? ($sql, @bind) : $sql;
235 sub _assemble_binds {
237 return map { @{ (delete $self->{"${_}_bind"}) || [] } } (qw/select from where group having order/);
241 update => 'FOR UPDATE',
242 shared => 'FOR SHARE',
245 my ($self, $type) = @_;
246 my $sql = $for_syntax->{$type} || croak "Unknown SELECT .. FOR type '$type' requested";
250 # Handle default inserts
252 # optimized due to hotttnesss
253 # my ($self, $table, $data, $options) = @_;
255 # SQLA will emit INSERT INTO $table ( ) VALUES ( )
256 # which is sadly understood only by MySQL. Change default behavior here,
257 # until SQLA2 comes with proper dialect support
258 if (! $_[2] or (ref $_[2] eq 'HASH' and !keys %{$_[2]} ) ) {
261 'INSERT INTO %s DEFAULT VALUES', $_[0]->_quote($_[1])
264 if ( ($_[3]||{})->{returning} ) {
266 ($s, @bind) = $_[0]->_insert_returning ($_[3]);
270 return ($sql, @bind);
276 sub _recurse_fields {
277 my ($self, $fields) = @_;
278 my $ref = ref $fields;
279 return $self->_quote($fields) unless $ref;
280 return $$fields if $ref eq 'SCALAR';
282 if ($ref eq 'ARRAY') {
283 return join(', ', map { $self->_recurse_fields($_) } @$fields);
285 elsif ($ref eq 'HASH') {
286 my %hash = %$fields; # shallow copy
288 my $as = delete $hash{-as}; # if supplied
290 my ($func, $args, @toomany) = %hash;
292 # there should be only one pair
294 croak "Malformed select argument - too many keys in hash: " . join (',', keys %$fields );
297 if (lc ($func) eq 'distinct' && ref $args eq 'ARRAY' && @$args > 1) {
299 'The select => { distinct => ... } syntax is not supported for multiple columns.'
300 .' Instead please use { group_by => [ qw/' . (join ' ', @$args) . '/ ] }'
301 .' or { select => [ qw/' . (join ' ', @$args) . '/ ], distinct => 1 }'
305 my $select = sprintf ('%s( %s )%s',
306 $self->_sqlcase($func),
307 $self->_recurse_fields($args),
309 ? sprintf (' %s %s', $self->_sqlcase('as'), $self->_quote ($as) )
315 # Is the second check absolutely necessary?
316 elsif ( $ref eq 'REF' and ref($$fields) eq 'ARRAY' ) {
317 push @{$self->{select_bind}}, @{$$fields}[1..$#$$fields];
318 return $$fields->[0];
321 croak($ref . qq{ unexpected in _recurse_fields()})
326 # this used to be a part of _order_by but is broken out for clarity.
327 # What we have been doing forever is hijacking the $order arg of
328 # SQLA::select to pass in arbitrary pieces of data (first the group_by,
329 # then pretty much the entire resultset attr-hash, as more and more
330 # things in the SQLA space need to have mopre info about the $rs they
331 # create SQL for. The alternative would be to keep expanding the
332 # signature of _select with more and more positional parameters, which
333 # is just gross. All hail SQLA2!
334 sub _parse_rs_attrs {
335 my ($self, $arg) = @_;
339 if ($arg->{group_by}) {
340 # horible horrible, waiting for refactor
341 local $self->{select_bind};
342 if (my $g = $self->_recurse_fields($arg->{group_by}) ) {
343 $sql .= $self->_sqlcase(' group by ') . $g;
344 push @{$self->{group_bind} ||= []}, @{$self->{select_bind}||[]};
348 if (defined $arg->{having}) {
349 my ($frag, @bind) = $self->_recurse_where($arg->{having});
350 push(@{$self->{having_bind}}, @bind);
351 $sql .= $self->_sqlcase(' having ') . $frag;
354 if (defined $arg->{order_by}) {
355 $sql .= $self->_order_by ($arg->{order_by});
362 my ($self, $arg) = @_;
364 # check that we are not called in legacy mode (order_by as 4th argument)
365 if (ref $arg eq 'HASH' and not grep { $_ =~ /^-(?:desc|asc)/i } keys %$arg ) {
366 return $self->_parse_rs_attrs ($arg);
369 my ($sql, @bind) = $self->next::method($arg);
370 push @{$self->{order_bind}}, @bind;
376 # optimized due to hotttnesss
377 # my ($self, $from) = @_;
378 if (my $ref = ref $_[1] ) {
379 if ($ref eq 'ARRAY') {
380 return $_[0]->_recurse_from(@{$_[1]});
382 elsif ($ref eq 'HASH') {
383 return $_[0]->_recurse_from($_[1]);
387 return $_[0]->next::method ($_[1]);
390 sub _generate_join_clause {
391 my ($self, $join_type) = @_;
393 return sprintf ('%s JOIN ',
394 $join_type ? ' ' . $self->_sqlcase($join_type) : ''
399 my ($self, $from, @join) = @_;
401 push @sqlf, $self->_from_chunk_to_sql($from);
406 # check whether a join type exists
407 my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to;
409 if (ref($to_jt) eq 'HASH' and defined($to_jt->{-join_type})) {
410 $join_type = $to_jt->{-join_type};
411 $join_type =~ s/^\s+ | \s+$//xg;
414 $join_type = $self->{_default_jointype} if not defined $join_type;
416 push @sqlf, $self->_generate_join_clause( $join_type );
418 if (ref $to eq 'ARRAY') {
419 my ($sql, @local_bind) = $self->_recurse_from(@$to);
420 push(@sqlf, '(', $sql , ')');
421 push @binds, @local_bind;
423 push(@sqlf, $self->_from_chunk_to_sql($to));
425 my ($sql, @local_bind) = $self->_join_condition($on);
426 push(@sqlf, ' ON ', $sql);
427 push @binds, @local_bind;
429 return join('', @sqlf), @binds;
432 sub _from_chunk_to_sql {
433 my ($self, $fromspec) = @_;
435 return join (' ', $self->_SWITCH_refkind($fromspec, {
440 push @{$self->{from_bind}}, @{$$fromspec}[1..$#$$fromspec];
444 my ($as, $table, $toomuch) = ( map
445 { $_ => $fromspec->{$_} }
446 ( grep { $_ !~ /^\-/ } keys %$fromspec )
449 croak "Only one table/as pair expected in from-spec but an exra '$toomuch' key present"
452 ($self->_from_chunk_to_sql($table), $self->_quote($as) );
455 $self->_quote($fromspec);
460 sub _join_condition {
461 my ($self, $cond) = @_;
463 if (ref $cond eq 'HASH') {
468 #croak (ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'})
469 # if ref($v) ne 'SCALAR';
473 my $x = '= '.$self->_quote($v); $j{$_} = \$x;
476 return $self->_recurse_where(\%j);
477 } elsif (ref $cond eq 'ARRAY') {
480 foreach my $c (@$cond) {
481 my ($sql, @bind) = $self->_join_condition($c);
485 return join(' OR ', @parts), @binds;
487 croak "Can't handle this yet!";
495 See L<DBIx::Class/CONTRIBUTORS>.
499 You may distribute this code under the same terms as Perl itself.