package DBIx::Class::SQLMaker;
+use strict;
+use warnings;
+
=head1 NAME
DBIx::Class::SQLMaker - An SQL::Abstract-based SQL maker class
=item * Support of C<...FOR UPDATE> type of select statement modifiers
-=item * The -ident operator
+=item * The L</-ident> operator
-=item * The -value operator
+=item * The L</-value> operator
=back
=cut
use base qw/
- DBIx::Class::SQLMaker::LimitDialects
SQL::Abstract
- Class::Accessor::Grouped
+ DBIx::Class::SQLMaker::LimitDialects
/;
use mro 'c3';
-use strict;
-use warnings;
+
+use Module::Runtime qw(use_module);
use Sub::Name 'subname';
-use Carp::Clan qw/^DBIx::Class|^SQL::Abstract|^Try::Tiny/;
+use DBIx::Class::Carp;
+use DBIx::Class::Exception;
+use Moo;
use namespace::clean;
-__PACKAGE__->mk_group_accessors (simple => qw/quote_char name_sep limit_dialect/);
+has limit_dialect => (
+ is => 'rw', default => sub { 'LimitOffset' },
+ trigger => sub { shift->clear_renderer_class }
+);
+
+our %LIMIT_DIALECT_MAP = (
+ 'GenericSubQ' => 'GenericSubquery',
+ 'RowCountOrGenericSubQ' => 'RowCountOrGenericSubquery',
+);
+
+sub mapped_limit_dialect {
+ my ($self) = @_;
+ my $unmapped = $self->limit_dialect;
+ $LIMIT_DIALECT_MAP{$unmapped}||$unmapped;
+}
+
+around _build_renderer_roles => sub {
+ my ($orig, $self) = (shift, shift);
+ return (
+ $self->$orig(@_),
+ 'Data::Query::Renderer::SQL::Slice::'.$self->mapped_limit_dialect
+ );
+};
# for when I need a normalized l/r pair
sub _quote_chars {
;
}
+sub _build_converter_class {
+ Module::Runtime::use_module('DBIx::Class::SQLMaker::Converter')
+}
+
+# FIXME when we bring in the storage weaklink, check its schema
+# weaklink and channel through $schema->throw_exception
+sub throw_exception { DBIx::Class::Exception->throw($_[1]) }
+
BEGIN {
- # reinstall the carp()/croak() functions imported into SQL::Abstract
- # as Carp and Carp::Clan do not like each other much
+ # reinstall the belch()/puke() functions of SQL::Abstract with custom versions
+ # that use DBIx::Class::Carp/DBIx::Class::Exception instead of plain Carp
no warnings qw/redefine/;
- no strict qw/refs/;
- for my $f (qw/carp croak/) {
-
- my $orig = \&{"SQL::Abstract::$f"};
- my $clan_import = \&{$f};
- *{"SQL::Abstract::$f"} = subname "SQL::Abstract::$f" =>
- sub {
- if (Carp::longmess() =~ /DBIx::Class::SQLMaker::[\w]+ .+? called \s at/x) {
- goto $clan_import;
- }
- else {
- goto $orig;
- }
- };
- }
+
+ *SQL::Abstract::belch = subname 'SQL::Abstract::belch' => sub (@) {
+ my($func) = (caller(1))[3];
+ carp "[$func] Warning: ", @_;
+ };
+
+ *SQL::Abstract::puke = subname 'SQL::Abstract::puke' => sub (@) {
+ my($func) = (caller(1))[3];
+ __PACKAGE__->throw_exception("[$func] Fatal: " . join ('', @_));
+ };
+
+ # Current SQLA pollutes its namespace - clean for the time being
+ namespace::clean->clean_subroutines(qw/SQL::Abstract carp croak confess/);
}
# the "oh noes offset/top without limit" constant
-# limited to 32 bits for sanity (and consistency,
-# since it is ultimately handed to sprintf %u)
+# limited to 31 bits for sanity (and consistency,
+# since it may be handed to the like of sprintf %u)
+#
+# Also *some* builds of SQLite fail the test
+# some_column BETWEEN ? AND ?: 1, 4294967295
+# with the proper integer bind attrs
+#
# Implemented as a method, since ::Storage::DBI also
# refers to it (i.e. for the case of software_limit or
# as the value to abuse with MSSQL ordered subqueries)
-sub __max_int { 0xFFFFFFFF };
+sub __max_int () { 0x7FFFFFFF };
-sub new {
- my $self = shift->next::method(@_);
-
- # use the same coderefs, they are prepared to handle both cases
- my @extra_dbic_syntax = (
- { regex => qr/^ ident $/xi, handler => '_where_op_IDENT' },
- { regex => qr/^ value $/xi, handler => '_where_op_VALUE' },
+# poor man's de-qualifier
+sub _quote {
+ $_[0]->next::method( ( $_[0]{_dequalify_idents} and ! ref $_[1] )
+ ? $_[1] =~ / ([^\.]+) $ /x
+ : $_[1]
);
-
- push @{$self->{special_ops}}, @extra_dbic_syntax;
- push @{$self->{unary_ops}}, @extra_dbic_syntax;
-
- $self;
}
-sub _where_op_IDENT {
- my $self = shift;
- my ($op, $rhs) = splice @_, -2;
- if (ref $rhs) {
- croak "-$op takes a single scalar argument (a quotable identifier)";
- }
-
- # in case we are called as a top level special op (no '=')
- my $lhs = shift;
-
- $_ = $self->_convert($self->_quote($_)) for ($lhs, $rhs);
-
- return $lhs
- ? "$lhs = $rhs"
- : $rhs
- ;
-}
-
-sub _where_op_VALUE {
- my $self = shift;
- my ($op, $rhs) = splice @_, -2;
-
- # in case we are called as a top level special op (no '=')
- my $lhs = shift;
-
- my @bind = [
- ($lhs || $self->{_nested_func_lhs} || croak "Unable to find bindtype for -value $rhs"),
- $rhs
- ];
-
- return $lhs
- ? (
- $self->_convert($self->_quote($lhs)) . ' = ' . $self->_convert('?'),
- @bind
- )
- : (
- $self->_convert('?'),
- @bind,
- )
- ;
-}
-
-my $callsites_warned;
sub _where_op_NEST {
- # determine callsite obeying Carp::Clan rules (fucking ugly but don't have better ideas)
- my $callsite = do {
- my $w;
- local $SIG{__WARN__} = sub { $w = shift };
- carp;
- $w
- };
-
- carp ("-nest in search conditions is deprecated, you most probably wanted:\n"
+ carp_unique ("-nest in search conditions is deprecated, you most probably wanted:\n"
.q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
- ) unless $callsites_warned->{$callsite}++;
+ );
shift->next::method(@_);
}
sub select {
my ($self, $table, $fields, $where, $rs_attrs, $limit, $offset) = @_;
-
- $fields = $self->_recurse_fields($fields);
-
if (defined $offset) {
- croak ('A supplied offset must be a non-negative integer')
+ $self->throw_exception('A supplied offset must be a non-negative integer')
if ( $offset =~ /\D/ or $offset < 0 );
}
$offset ||= 0;
if (defined $limit) {
- croak ('A supplied limit must be a positive integer')
+ $self->throw_exception('A supplied limit must be a positive integer')
if ( $limit =~ /\D/ or $limit <= 0 );
}
elsif ($offset) {
$limit = $self->__max_int;
}
-
- my ($sql, @bind);
- if ($limit) {
- # this is legacy code-flow from SQLA::Limit, it is not set in stone
-
- ($sql, @bind) = $self->next::method ($table, $fields, $where);
-
- my $limiter =
- $self->can ('emulate_limit') # also backcompat hook from SQLA::Limit
- ||
- do {
- my $dialect = $self->limit_dialect
- or croak "Unable to generate SQL-limit - no limit dialect specified on $self, and no emulate_limit method found";
- $self->can ("_$dialect")
- or croak (__PACKAGE__ . " does not implement the requested dialect '$dialect'");
+ my %final_attrs = (%{$rs_attrs||{}}, limit => $limit, offset => $offset);
+
+ if ($limit or $offset) {
+ my %slice_stability = $self->renderer->slice_stability;
+
+ if (my $stability = $slice_stability{$offset ? 'offset' : 'limit'}) {
+ my $source = $rs_attrs->{_rsroot_rsrc};
+ unless (
+ $final_attrs{order_is_stable}
+ = $final_attrs{preserve_order}
+ = $source->schema->storage
+ ->_order_by_is_stable(
+ @final_attrs{qw(from order_by where)}
+ )
+ ) {
+ if ($stability eq 'requires') {
+ if ($self->converter->_order_by_to_dq($final_attrs{order_by})) {
+ $self->throw_exception(
+ $self->limit_dialect.' limit/offset implementation requires a stable order for offset'
+ );
+ }
+ if (my $ident_cols = $source->_identifying_column_set) {
+ $final_attrs{order_by} = [
+ map "$final_attrs{alias}.$_", @$ident_cols
+ ];
+ $final_attrs{order_is_stable} = 1;
+ } else {
+ $self->throw_exception(sprintf(
+ 'Unable to auto-construct stable order criteria for "skimming type"
+ limit '
+ . "dialect based on source '%s'", $source->name) );
+ }
+ }
}
- ;
- $sql = $self->$limiter ($sql, $rs_attrs, $limit, $offset);
- }
- else {
- ($sql, @bind) = $self->next::method ($table, $fields, $where, $rs_attrs);
- }
+ }
- push @{$self->{where_bind}}, @bind;
+ my %slice_subquery = $self->renderer->slice_subquery;
+
+ if (my $subquery = $slice_subquery{$offset ? 'offset' : 'limit'}) {
+ $fields = [ map {
+ my $f = $fields->[$_];
+ if (ref $f) {
+ $f = { '' => $f } unless ref($f) eq 'HASH';
+ ($f->{-as} ||= $final_attrs{as}[$_]) =~ s/\Q${\$self->name_sep}/__/g;
+ } elsif ($f !~ /^\Q$final_attrs{alias}${\$self->name_sep}/) {
+ $f = { '' => $f };
+ ($f->{-as} ||= $final_attrs{as}[$_]) =~ s/\Q${\$self->name_sep}/__/g;
+ }
+ $f;
+ } 0 .. $#$fields ];
+ }
+ }
-# this *must* be called, otherwise extra binds will remain in the sql-maker
- my @all_bind = $self->_assemble_binds;
+ my ($sql, @bind) = $self->next::method ($table, $fields, $where, $final_attrs{order_by}, \%final_attrs );
$sql .= $self->_lock_select ($rs_attrs->{for})
if $rs_attrs->{for};
- return wantarray ? ($sql, @all_bind) : $sql;
+ return wantarray ? ($sql, @bind) : $sql;
}
sub _assemble_binds {
my $self = shift;
- return map { @{ (delete $self->{"${_}_bind"}) || [] } } (qw/select from where group having order/);
+ return map { @{ (delete $self->{"${_}_bind"}) || [] } } (qw/pre_select select from where group having order limit/);
}
my $for_syntax = {
};
sub _lock_select {
my ($self, $type) = @_;
- my $sql = $for_syntax->{$type} || croak "Unknown SELECT .. FOR type '$type' requested";
- return " $sql";
-}
-
-# Handle default inserts
-sub insert {
-# optimized due to hotttnesss
-# my ($self, $table, $data, $options) = @_;
-
- # SQLA will emit INSERT INTO $table ( ) VALUES ( )
- # which is sadly understood only by MySQL. Change default behavior here,
- # until SQLA2 comes with proper dialect support
- if (! $_[2] or (ref $_[2] eq 'HASH' and !keys %{$_[2]} ) ) {
- my @bind;
- my $sql = sprintf(
- 'INSERT INTO %s DEFAULT VALUES', $_[0]->_quote($_[1])
- );
-
- if ( ($_[3]||{})->{returning} ) {
- my $s;
- ($s, @bind) = $_[0]->_insert_returning ($_[3]);
- $sql .= $s;
- }
-
- return ($sql, @bind);
- }
-
- next::method(@_);
-}
-
-sub _recurse_fields {
- my ($self, $fields) = @_;
- my $ref = ref $fields;
- return $self->_quote($fields) unless $ref;
- return $$fields if $ref eq 'SCALAR';
-
- if ($ref eq 'ARRAY') {
- return join(', ', map { $self->_recurse_fields($_) } @$fields);
- }
- elsif ($ref eq 'HASH') {
- my %hash = %$fields; # shallow copy
-
- my $as = delete $hash{-as}; # if supplied
- my ($func, $args, @toomany) = %hash;
-
- # there should be only one pair
- if (@toomany) {
- croak "Malformed select argument - too many keys in hash: " . join (',', keys %$fields );
- }
-
- if (lc ($func) eq 'distinct' && ref $args eq 'ARRAY' && @$args > 1) {
- croak (
- 'The select => { distinct => ... } syntax is not supported for multiple columns.'
- .' Instead please use { group_by => [ qw/' . (join ' ', @$args) . '/ ] }'
- .' or { select => [ qw/' . (join ' ', @$args) . '/ ], distinct => 1 }'
- );
- }
-
- my $select = sprintf ('%s( %s )%s',
- $self->_sqlcase($func),
- $self->_recurse_fields($args),
- $as
- ? sprintf (' %s %s', $self->_sqlcase('as'), $self->_quote ($as) )
- : ''
- );
-
- return $select;
- }
- # Is the second check absolutely necessary?
- elsif ( $ref eq 'REF' and ref($$fields) eq 'ARRAY' ) {
- push @{$self->{select_bind}}, @{$$fields}[1..$#$$fields];
- return $$fields->[0];
+ my $sql;
+ if (ref($type) eq 'SCALAR') {
+ $sql = "FOR $$type";
}
else {
- croak($ref . qq{ unexpected in _recurse_fields()})
- }
-}
-
-
-# this used to be a part of _order_by but is broken out for clarity.
-# What we have been doing forever is hijacking the $order arg of
-# SQLA::select to pass in arbitrary pieces of data (first the group_by,
-# then pretty much the entire resultset attr-hash, as more and more
-# things in the SQLA space need to have mopre info about the $rs they
-# create SQL for. The alternative would be to keep expanding the
-# signature of _select with more and more positional parameters, which
-# is just gross. All hail SQLA2!
-sub _parse_rs_attrs {
- my ($self, $arg) = @_;
-
- my $sql = '';
-
- if ($arg->{group_by}) {
- # horible horrible, waiting for refactor
- local $self->{select_bind};
- if (my $g = $self->_recurse_fields($arg->{group_by}) ) {
- $sql .= $self->_sqlcase(' group by ') . $g;
- push @{$self->{group_bind} ||= []}, @{$self->{select_bind}||[]};
- }
- }
-
- if (defined $arg->{having}) {
- my ($frag, @bind) = $self->_recurse_where($arg->{having});
- push(@{$self->{having_bind}}, @bind);
- $sql .= $self->_sqlcase(' having ') . $frag;
- }
-
- if (defined $arg->{order_by}) {
- $sql .= $self->_order_by ($arg->{order_by});
+ $sql = $for_syntax->{$type} || $self->throw_exception( "Unknown SELECT .. FO
+R type '$type' requested" );
}
- return $sql;
+ return " $sql";
}
-sub _order_by {
- my ($self, $arg) = @_;
-
- # check that we are not called in legacy mode (order_by as 4th argument)
- if (ref $arg eq 'HASH' and not grep { $_ =~ /^-(?:desc|asc)/i } keys %$arg ) {
- return $self->_parse_rs_attrs ($arg);
- }
- else {
- my ($sql, @bind) = $self->next::method($arg);
- push @{$self->{order_bind}}, @bind;
- return $sql;
- }
+sub _recurse_from {
+ scalar shift->_render_sqla(table => \@_);
}
-sub _table {
-# optimized due to hotttnesss
-# my ($self, $from) = @_;
- if (my $ref = ref $_[1] ) {
- if ($ref eq 'ARRAY') {
- return $_[0]->_recurse_from(@{$_[1]});
- }
- elsif ($ref eq 'HASH') {
- return $_[0]->_recurse_from($_[1]);
- }
- }
+1;
- return $_[0]->next::method ($_[1]);
-}
+=head1 OPERATORS
-sub _generate_join_clause {
- my ($self, $join_type) = @_;
+=head2 -ident
- return sprintf ('%s JOIN ',
- $join_type ? ' ' . $self->_sqlcase($join_type) : ''
+Used to explicitly specify an SQL identifier. Takes a plain string as value
+which is then invariably treated as a column name (and is being properly
+quoted if quoting has been requested). Most useful for comparison of two
+columns:
+
+ my %where = (
+ priority => { '<', 2 },
+ requestor => { -ident => 'submitter' }
);
-}
-sub _recurse_from {
- my ($self, $from, @join) = @_;
- my @sqlf;
- push @sqlf, $self->_from_chunk_to_sql($from);
-
- for (@join) {
- my ($to, $on) = @$_;
-
- # check whether a join type exists
- my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to;
- my $join_type;
- if (ref($to_jt) eq 'HASH' and defined($to_jt->{-join_type})) {
- $join_type = $to_jt->{-join_type};
- $join_type =~ s/^\s+ | \s+$//xg;
- }
+which results in:
- $join_type = $self->{_default_jointype} if not defined $join_type;
+ $stmt = 'WHERE "priority" < ? AND "requestor" = "submitter"';
+ @bind = ('2');
- push @sqlf, $self->_generate_join_clause( $join_type );
+=head2 -value
- if (ref $to eq 'ARRAY') {
- push(@sqlf, '(', $self->_recurse_from(@$to), ')');
- } else {
- push(@sqlf, $self->_from_chunk_to_sql($to));
- }
- push(@sqlf, ' ON ', $self->_join_condition($on));
- }
- return join('', @sqlf);
-}
+The -value operator signals that the argument to the right is a raw bind value.
+It will be passed straight to DBI, without invoking any of the SQL::Abstract
+condition-parsing logic. This allows you to, for example, pass an array as a
+column value for databases that support array datatypes, e.g.:
-sub _from_chunk_to_sql {
- my ($self, $fromspec) = @_;
-
- return join (' ', $self->_SWITCH_refkind($fromspec, {
- SCALARREF => sub {
- $$fromspec;
- },
- ARRAYREFREF => sub {
- push @{$self->{from_bind}}, @{$$fromspec}[1..$#$$fromspec];
- $$fromspec->[0];
- },
- HASHREF => sub {
- my ($as, $table, $toomuch) = ( map
- { $_ => $fromspec->{$_} }
- ( grep { $_ !~ /^\-/ } keys %$fromspec )
- );
-
- croak "Only one table/as pair expected in from-spec but an exra '$toomuch' key present"
- if defined $toomuch;
-
- ($self->_from_chunk_to_sql($table), $self->_quote($as) );
- },
- SCALAR => sub {
- $self->_quote($fromspec);
- },
- }));
-}
+ my %where = (
+ array => { -value => [1, 2, 3] }
+ );
-sub _join_condition {
- my ($self, $cond) = @_;
-
- if (ref $cond eq 'HASH') {
- my %j;
- for (keys %$cond) {
- my $v = $cond->{$_};
- if (ref $v) {
- croak (ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'})
- if ref($v) ne 'SCALAR';
- $j{$_} = $v;
- }
- else {
- my $x = '= '.$self->_quote($v); $j{$_} = \$x;
- }
- };
- return scalar($self->_recurse_where(\%j));
- } elsif (ref $cond eq 'ARRAY') {
- return join(' OR ', map { $self->_join_condition($_) } @$cond);
- } else {
- croak "Can't handle this yet!";
- }
-}
+which results in:
-1;
+ $stmt = 'WHERE array = ?';
+ @bind = ([1, 2, 3]);
=head1 AUTHORS
projects / dbsrgits/DBIx-Class.git / blobdiff