package # Hide from PAUSE
DBIx::Class::SQLAHacks;
-# This module is a subclass of SQL::Abstract::Limit and includes a number
-# of DBIC-specific workarounds, not yet suitable for inclusion into the
-# SQLA core
-
-use base qw/SQL::Abstract::Limit/;
+# This module is a subclass of SQL::Abstract and includes a number of
+# DBIC-specific workarounds, not yet suitable for inclusion into the
+# SQLA core.
+# It also provides all (and more than) the functionality of
+# SQL::Abstract::Limit, which proved to be very hard to keep updated
+
+use base qw/
+ DBIx::Class::SQLAHacks::LimitDialects
+ SQL::Abstract
+ Class::Accessor::Grouped
+/;
+use mro 'c3';
use strict;
use warnings;
-use Carp::Clan qw/^DBIx::Class|^SQL::Abstract/;
-use Sub::Name();
+use Sub::Name 'subname';
+use Carp::Clan qw/^DBIx::Class|^SQL::Abstract|^Try::Tiny/;
+use namespace::clean;
+
+__PACKAGE__->mk_group_accessors (simple => qw/quote_char name_sep limit_dialect/);
BEGIN {
# reinstall the carp()/croak() functions imported into SQL::Abstract
for my $f (qw/carp croak/) {
my $orig = \&{"SQL::Abstract::$f"};
- *{"SQL::Abstract::$f"} = Sub::Name::subname "SQL::Abstract::$f" =>
+ my $clan_import = \&{$f};
+ *{"SQL::Abstract::$f"} = subname "SQL::Abstract::$f" =>
sub {
if (Carp::longmess() =~ /DBIx::Class::SQLAHacks::[\w]+ .+? called \s at/x) {
- __PACKAGE__->can($f)->(@_);
+ $clan_import->(@_);
}
else {
goto $orig;
}
}
+# the "oh noes offset/top without limit" constant
+# limited to 32 bits for sanity (and consistency,
+# since it is ultimately handed to sprintf %u)
+# 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 };
-# Tries to determine limit dialect.
-#
-sub new {
- my $self = shift->SUPER::new(@_);
-
- # This prevents the caching of $dbh in S::A::L, I believe
- # If limit_dialect is a ref (like a $dbh), go ahead and replace
- # it with what it resolves to:
- $self->{limit_dialect} = $self->_find_syntax($self->{limit_dialect})
- if ref $self->{limit_dialect};
-
- $self;
-}
-
-# !!! THIS IS ALSO HORRIFIC !!! /me ashamed
-#
-# generate inner/outer select lists for various limit dialects
-# which result in one or more subqueries (e.g. RNO, Top, RowNum)
-# Any non-root-table columns need to have their table qualifier
-# turned into a column alias (otherwise names in subqueries clash
-# and/or lose their source table)
-#
-# returns inner/outer strings of SQL QUOTED selectors with aliases
-# (to be used in whatever select statement), and an alias index hashref
-# of QUOTED SEL => QUOTED ALIAS pairs (to maybe be used for string-subst
-# higher up)
-#
-# If the $scan_order option is supplied, it signals that the limit dialect
-# needs to order the outer side of the query, which in turn means that the
-# inner select needs to bring out columns used in implicit (non-selected)
-# orders, and the order condition itself needs to be realiased to the proper
-# names in the outer query.
-#
-# In this case ($scan_order os true) we also return a hashref (order doesn't
-# matter) of QUOTED EXTRA-SEL => QUOTED ALIAS pairs, which is a list of extra
-# selectors that do *not* exist in the original select list
-
-sub _subqueried_limit_attrs {
- my ($self, $rs_attrs, $scan_order) = @_;
-
- croak 'Limit dialect implementation usable only in the context of DBIC (missing $rs_attrs)'
- unless ref ($rs_attrs) eq 'HASH';
-
- my ($re_sep, $re_alias) = map { quotemeta $_ } (
- $self->name_sep || '.',
- $rs_attrs->{alias},
- );
-
- # correlate select and as, build selection index
- my (@sel, $in_sel_index);
- for my $i (0 .. $#{$rs_attrs->{select}}) {
-
- my $s = $rs_attrs->{select}[$i];
- my $sql_sel = $self->_recurse_fields ($s);
- my $sql_alias = (ref $s) eq 'HASH' ? $s->{-as} : undef;
-
-
- push @sel, {
- sql => $sql_sel,
- unquoted_sql => do { local $self->{quote_char}; $self->_recurse_fields ($s) },
- as =>
- $sql_alias
- ||
- $rs_attrs->{as}[$i]
- ||
- croak "Select argument $i ($s) without corresponding 'as'"
- ,
- };
-
- $in_sel_index->{$sql_sel}++;
- $in_sel_index->{$self->_quote ($sql_alias)}++ if $sql_alias;
-
-# this *may* turn out to be necessary, not sure yet
-# my ($sql_unqualified_sel) = $sql_sel =~ / $re_sep (.+) $/x
-# if ! ref $s;
-# $in_sel_index->{$sql_unqualified_sel}++;
- }
-
-
- # re-alias and remove any name separators from aliases,
- # unless we are dealing with the current source alias
- # (which will transcend the subqueries as it is necessary
- # for possible further chaining)
- my (@in_sel, @out_sel, %renamed);
- for my $node (@sel) {
- if (List::Util::first { $_ =~ / (?<! $re_alias ) $re_sep /x } ($node->{as}, $node->{unquoted_sql}) ) {
- $node->{as} =~ s/ $re_sep /__/xg;
- my $quoted_as = $self->_quote($node->{as});
- push @in_sel, sprintf '%s AS %s', $node->{sql}, $quoted_as;
- push @out_sel, $quoted_as;
- $renamed{$node->{sql}} = $quoted_as;
- }
- else {
- push @in_sel, $node->{sql};
- push @out_sel, $self->_quote ($node->{as});
- }
- }
+# Handle limit-dialect selection
+sub select {
+ my ($self, $table, $fields, $where, $rs_attrs, $limit, $offset) = @_;
- my %extra_order_sel;
- if ($scan_order) {
- for my $chunk ($self->_order_by_chunks ($rs_attrs->{order_by})) {
- # order with bind
- $chunk = $chunk->[0] if (ref $chunk) eq 'ARRAY';
- $chunk =~ s/\s+ (?: ASC|DESC ) \s* $//ix;
- next if $in_sel_index->{$chunk};
+ $fields = $self->_recurse_fields($fields);
- $extra_order_sel{$chunk} ||= $self->_quote (
- 'ORDER__BY__' . scalar keys %extra_order_sel
- );
- }
+ if (defined $offset) {
+ croak ('A supplied offset must be a non-negative integer')
+ if ( $offset =~ /\D/ or $offset < 0 );
}
- return (
- (map { join (', ', @$_ ) } (
- \@in_sel,
- \@out_sel)
- ),
- \%renamed,
- keys %extra_order_sel ? \%extra_order_sel : (),
- );
-}
+ $offset ||= 0;
-# ANSI standard Limit/Offset implementation. DB2 and MSSQL >= 2005 use this
-sub _RowNumberOver {
- my ($self, $sql, $rs_attrs, $rows, $offset ) = @_;
-
- # mangle the input sql as we will be replacing the selector
- $sql =~ s/^ \s* SELECT \s+ .+? \s+ (?= \b FROM \b )//ix
- or croak "Unrecognizable SELECT: $sql";
-
- # get selectors, and scan the order_by (if any)
- my ($in_sel, $out_sel, $alias_map, $extra_order_sel) = $self->_subqueried_limit_attrs (
- $rs_attrs, 'scan_order_by',
- );
-
- # make up an order if none exists
- my $requested_order = (delete $rs_attrs->{order_by}) || $self->_rno_default_order;
- my $rno_ord = $self->_order_by ($requested_order);
-
- # this is the order supplement magic
- my $mid_sel = $out_sel;
- if ($extra_order_sel) {
- for my $extra_col (sort
- { $extra_order_sel->{$a} cmp $extra_order_sel->{$b} }
- keys %$extra_order_sel
- ) {
- $in_sel .= sprintf (', %s AS %s',
- $extra_col,
- $extra_order_sel->{$extra_col},
- );
-
- $mid_sel .= ', ' . $extra_order_sel->{$extra_col};
- }
+ if (defined $limit) {
+ croak ('A supplied limit must be a positive integer')
+ if ( $limit =~ /\D/ or $limit <= 0 );
}
-
- # and this is order re-alias magic
- for ($extra_order_sel, $alias_map) {
- for my $col (keys %$_) {
- my $re_col = quotemeta ($col);
- $rno_ord =~ s/$re_col/$_->{$col}/;
- }
+ elsif ($offset) {
+ $limit = $self->__max_int;
}
- # whatever is left of the order_by (only where is processed at this point)
- my $group_having = $self->_parse_rs_attrs($rs_attrs);
-
- my $qalias = $self->_quote ($rs_attrs->{alias});
- my $idx_name = $self->_quote ('rno__row__index');
-
- $sql = sprintf (<<EOS, $offset + 1, $offset + $rows, );
-
-SELECT $out_sel FROM (
- SELECT $mid_sel, ROW_NUMBER() OVER( $rno_ord ) AS $idx_name FROM (
- SELECT $in_sel ${sql}${group_having}
- ) $qalias
-) $qalias WHERE $idx_name BETWEEN %d AND %d
-
-EOS
-
- $sql =~ s/\s*\n\s*/ /g; # easier to read in the debugger
- return $sql;
-}
-
-# some databases are happy with OVER (), some need OVER (ORDER BY (SELECT (1)) )
-sub _rno_default_order {
- return undef;
-}
-
-# Informix specific limit, almost like LIMIT/OFFSET
-sub _SkipFirst {
- my ($self, $sql, $rs_attrs, $rows, $offset) = @_;
-
- $sql =~ s/^ \s* SELECT \s+ //ix
- or croak "Unrecognizable SELECT: $sql";
-
- return sprintf ('SELECT %s%s%s%s',
- $offset
- ? sprintf ('SKIP %d ', $offset)
- : ''
- ,
- sprintf ('FIRST %d ', $rows),
- $sql,
- $self->_parse_rs_attrs ($rs_attrs),
- );
-}
-
-# Firebird specific limit, reverse of _SkipFirst for Informix
-sub _FirstSkip {
- my ($self, $sql, $rs_attrs, $rows, $offset) = @_;
-
- $sql =~ s/^ \s* SELECT \s+ //ix
- or croak "Unrecognizable SELECT: $sql";
-
- return sprintf ('SELECT %s%s%s%s',
- sprintf ('FIRST %d ', $rows),
- $offset
- ? sprintf ('SKIP %d ', $offset)
- : ''
- ,
- $sql,
- $self->_parse_rs_attrs ($rs_attrs),
- );
-}
-
-# WhOracle limits
-sub _RowNum {
- my ( $self, $sql, $rs_attrs, $rows, $offset ) = @_;
-
- # mangle the input sql as we will be replacing the selector
- $sql =~ s/^ \s* SELECT \s+ .+? \s+ (?= \b FROM \b )//ix
- or croak "Unrecognizable SELECT: $sql";
-
- my ($insel, $outsel) = $self->_subqueried_limit_attrs ($rs_attrs);
-
- my $qalias = $self->_quote ($rs_attrs->{alias});
- my $idx_name = $self->_quote ('rownum__index');
- my $order_group_having = $self->_parse_rs_attrs($rs_attrs);
-
- $sql = sprintf (<<EOS, $offset + 1, $offset + $rows, );
-
-SELECT $outsel FROM (
- SELECT $outsel, ROWNUM $idx_name FROM (
- SELECT $insel ${sql}${order_group_having}
- ) $qalias
-) $qalias WHERE $idx_name BETWEEN %d AND %d
-
-EOS
-
- $sql =~ s/\s*\n\s*/ /g; # easier to read in the debugger
- return $sql;
-}
-
-# Crappy Top based Limit/Offset support. Legacy for MSSQL < 2005
-sub _Top {
- my ( $self, $sql, $rs_attrs, $rows, $offset ) = @_;
-
- # mangle the input sql as we will be replacing the selector
- $sql =~ s/^ \s* SELECT \s+ .+? \s+ (?= \b FROM \b )//ix
- or croak "Unrecognizable SELECT: $sql";
-
- # get selectors
- my ($in_sel, $out_sel, $alias_map, $extra_order_sel)
- = $self->_subqueried_limit_attrs ($rs_attrs, 'outer_order_by');
-
- my $requested_order = delete $rs_attrs->{order_by};
-
- my $order_by_requested = $self->_order_by ($requested_order);
- # make up an order unless supplied
- my $inner_order = ($order_by_requested
- ? $requested_order
- : [ map
- { join ('', $rs_attrs->{alias}, $self->{name_sep}||'.', $_ ) }
- ( $rs_attrs->{_rsroot_source_handle}->resolve->_pri_cols )
- ]
- );
+ my ($sql, @bind);
+ if ($limit) {
+ # this is legacy code-flow from SQLA::Limit, it is not set in stone
- my ($order_by_inner, $order_by_reversed);
+ ($sql, @bind) = $self->next::method ($table, $fields, $where);
- # localise as we already have all the bind values we need
- {
- local $self->{order_bind};
- $order_by_inner = $self->_order_by ($inner_order);
-
- my @out_chunks;
- for my $ch ($self->_order_by_chunks ($inner_order)) {
- $ch = $ch->[0] if ref $ch eq 'ARRAY';
-
- $ch =~ s/\s+ ( ASC|DESC ) \s* $//ix;
- my $dir = uc ($1||'ASC');
-
- push @out_chunks, \join (' ', $ch, $dir eq 'ASC' ? 'DESC' : 'ASC' );
- }
-
- $order_by_reversed = $self->_order_by (\@out_chunks);
- }
-
- # this is the order supplement magic
- my $mid_sel = $out_sel;
- if ($extra_order_sel) {
- for my $extra_col (sort
- { $extra_order_sel->{$a} cmp $extra_order_sel->{$b} }
- keys %$extra_order_sel
- ) {
- $in_sel .= sprintf (', %s AS %s',
- $extra_col,
- $extra_order_sel->{$extra_col},
- );
+ 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 "SQLAHacks does not implement the requested dialect '$dialect'";
+ }
+ ;
- $mid_sel .= ', ' . $extra_order_sel->{$extra_col};
- }
+ $sql = $self->$limiter ($sql, $rs_attrs, $limit, $offset);
}
-
- # and this is order re-alias magic
- for my $map ($extra_order_sel, $alias_map) {
- for my $col (keys %$map) {
- my $re_col = quotemeta ($col);
- $_ =~ s/$re_col/$map->{$col}/
- for ($order_by_reversed, $order_by_requested);
- }
+ else {
+ ($sql, @bind) = $self->next::method ($table, $fields, $where, $rs_attrs);
}
- # generate the rest of the sql
- my $grpby_having = $self->_parse_rs_attrs ($rs_attrs);
-
- my $quoted_rs_alias = $self->_quote ($rs_attrs->{alias});
-
- $sql = sprintf ('SELECT TOP %d %s %s %s %s',
- $rows + ($offset||0),
- $in_sel,
- $sql,
- $grpby_having,
- $order_by_inner,
- );
-
- $sql = sprintf ('SELECT TOP %d %s FROM ( %s ) %s %s',
- $rows,
- $mid_sel,
- $sql,
- $quoted_rs_alias,
- $order_by_reversed,
- ) if $offset;
-
- $sql = sprintf ('SELECT TOP %d %s FROM ( %s ) %s %s',
- $rows,
- $out_sel,
- $sql,
- $quoted_rs_alias,
- $order_by_requested,
- ) if ($order_by_requested || ($mid_sel ne $out_sel));
+ push @{$self->{where_bind}}, @bind;
- return $sql;
-}
+# this *must* be called, otherwise extra binds will remain in the sql-maker
+ my @all_bind = $self->_assemble_binds;
-
-# While we're at it, this should make LIMIT queries more efficient,
-# without digging into things too deeply
-sub _find_syntax {
- my ($self, $syntax) = @_;
- return $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax);
+ return wantarray ? ($sql, @all_bind) : $sql;
}
-# Quotes table names, handles "limit" dialects (e.g. where rownum between x and
-# y)
-sub select {
- my ($self, $table, $fields, $where, $rs_attrs, @rest) = @_;
-
- $self->{"${_}_bind"} = [] for (qw/having from order/);
-
- if (not ref($table) or ref($table) eq 'SCALAR') {
- $table = $self->_quote($table);
- }
-
- local $self->{rownum_hack_count} = 1
- if (defined $rest[0] && $self->{limit_dialect} eq 'RowNum');
- @rest = (-1) unless defined $rest[0];
- croak "LIMIT 0 Does Not Compute" if $rest[0] == 0;
- # and anyway, SQL::Abstract::Limit will cause a barf if we don't first
-
- my ($sql, @where_bind) = $self->SUPER::select(
- $table, $self->_recurse_fields($fields), $where, $rs_attrs, @rest
- );
- return wantarray ? ($sql, @{$self->{from_bind}}, @where_bind, @{$self->{having_bind}}, @{$self->{order_bind}} ) : $sql;
+sub _assemble_binds {
+ my $self = shift;
+ return map { @{ (delete $self->{"${_}_bind"}) || [] } } (qw/from where having order/);
}
-# Quotes table names, and handles default inserts
+# Handle default inserts
sub insert {
- my $self = shift;
- my $table = shift;
- $table = $self->_quote($table);
+# 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 (! $_[0] or (ref $_[0] eq 'HASH' and !keys %{$_[0]} ) ) {
- my $sql = "INSERT INTO ${table} DEFAULT VALUES";
+ if (! $_[2] or (ref $_[2] eq 'HASH' and !keys %{$_[2]} ) ) {
+ my $sql = "INSERT INTO $_[1] DEFAULT VALUES";
- if (my $ret = ($_[1]||{})->{returning} ) {
- $sql .= $self->_insert_returning ($ret);
+ if (my $ret = ($_[3]||{})->{returning} ) {
+ $sql .= $_[0]->_insert_returning ($ret);
}
return $sql;
}
- $self->SUPER::insert($table, @_);
-}
-
-# Just quotes table names.
-sub update {
- my $self = shift;
- my $table = shift;
- $table = $self->_quote($table);
- $self->SUPER::update($table, @_);
-}
-
-# Just quotes table names.
-sub delete {
- my $self = shift;
- my $table = shift;
- $table = $self->_quote($table);
- $self->SUPER::delete($table, @_);
-}
-
-sub _emulate_limit {
- my $self = shift;
- # my ( $syntax, $sql, $order, $rows, $offset ) = @_;
-
- if ($_[3] == -1) {
- return $_[1] . $self->_parse_rs_attrs($_[2]);
- } else {
- return $self->SUPER::_emulate_limit(@_);
- }
+ next::method(@_);
}
sub _recurse_fields {
my $sql = '';
- if (my $g = $self->_recurse_fields($arg->{group_by}, { no_rownum_hack => 1 }) ) {
+ if (my $g = $self->_recurse_fields($arg->{group_by}) ) {
$sql .= $self->_sqlcase(' group by ') . $g;
}
return $self->_parse_rs_attrs ($arg);
}
else {
- my ($sql, @bind) = $self->SUPER::_order_by ($arg);
+ my ($sql, @bind) = $self->next::method($arg);
push @{$self->{order_bind}}, @bind;
return $sql;
}
}
-sub _order_directions {
- my ($self, $order) = @_;
-
- # strip bind values - none of the current _order_directions users support them
- return $self->SUPER::_order_directions( [ map
- { ref $_ ? $_->[0] : $_ }
- $self->_order_by_chunks ($order)
- ]);
-}
-
sub _table {
- my ($self, $from) = @_;
- if (ref $from eq 'ARRAY') {
- return $self->_recurse_from(@$from);
- } elsif (ref $from eq 'HASH') {
- return $self->_make_as($from);
- } else {
- return $from; # would love to quote here but _table ends up getting called
- # twice during an ->select without a limit clause due to
- # the way S::A::Limit->select works. should maybe consider
- # bypassing this and doing S::A::select($self, ...) in
- # our select method above. meantime, quoting shims have
- # been added to select/insert/update/delete here
+# 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]->_make_as($_[1]);
+ }
}
+
+ return $_[0]->next::method ($_[1]);
}
sub _generate_join_clause {
} elsif (ref $cond eq 'ARRAY') {
return join(' OR ', map { $self->_join_condition($_) } @$cond);
} else {
- die "Can't handle this yet!";
+ croak "Can't handle this yet!";
}
}
-sub limit_dialect {
- my $self = shift;
- if (@_) {
- $self->{limit_dialect} = shift;
- undef $self->{_cached_syntax};
- }
- return $self->{limit_dialect};
-}
-
-# Set to an array-ref to specify separate left and right quotes for table names.
-# A single scalar is equivalen to [ $char, $char ]
-sub quote_char {
- my $self = shift;
- $self->{quote_char} = shift if @_;
- return $self->{quote_char};
-}
-
-# Character separating quoted table names.
-sub name_sep {
- my $self = shift;
- $self->{name_sep} = shift if @_;
- return $self->{name_sep};
-}
-
1;
projects / dbsrgits/DBIx-Class.git / blobdiff