class Arel::Visitors::ToSql

Attributes

last_column[RW]

Public Class Methods

new(connection) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 9
def initialize connection
  @connection     = connection
  @schema_cache   = connection.schema_cache
  @quoted_tables  = {}
  @quoted_columns = {}
  @last_column    = nil
end

Public Instance Methods

accept(object) click to toggle source
Calls superclass method Arel::Visitors::Visitor#accept
# File lib/arel/visitors/to_sql.rb, line 17
def accept object
  self.last_column = nil
  super
end

Private Instance Methods

build_subselect(key, o) click to toggle source

FIXME: we should probably have a 2-pass visitor for this

# File lib/arel/visitors/to_sql.rb, line 31
def build_subselect key, o
  stmt             = Nodes::SelectStatement.new
  core             = stmt.cores.first
  core.froms       = o.relation
  core.wheres      = o.wheres
  core.projections = [key]
  stmt.limit       = o.limit
  stmt.orders      = o.orders
  stmt
end
column_cache() click to toggle source
# File lib/arel/visitors/to_sql.rb, line 104
def column_cache
  @schema_cache.columns_hash
end
column_for(attr) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 95
def column_for attr
  name    = attr.name.to_s
  table   = attr.relation.table_name

  return nil unless table_exists? table

  column_cache[table][name]
end
literal(o;) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 375
def literal o; o end
quote(value, column = nil) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 415
def quote value, column = nil
  @connection.quote value, column
end
quote_column_name(name) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 424
def quote_column_name name
  @quoted_columns[name] ||= Arel::Nodes::SqlLiteral === name ? name : @connection.quote_column_name(name)
end
quote_table_name(name) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 419
def quote_table_name name
  return name if Arel::Nodes::SqlLiteral === name
  @quoted_tables[name] ||= @connection.quote_table_name(name)
end
quoted(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 383
def quoted o
  quote(o, last_column)
end
table_exists?(name) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 91
def table_exists? name
  @schema_cache.table_exists? name
end
visit_ActiveSupport_Multibyte_Chars(o)
Alias for: quoted
visit_ActiveSupport_StringInquirer(o)
Alias for: quoted
visit_Arel_Attributes_Attribute(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 363
def visit_Arel_Attributes_Attribute o
  self.last_column = column_for o
  join_name = o.relation.table_alias || o.relation.name
  "#{quote_table_name join_name}.#{quote_column_name o.name}"
end
visit_Arel_Attributes_Boolean(o)
visit_Arel_Attributes_Decimal(o)
visit_Arel_Attributes_Float(o)
visit_Arel_Attributes_Integer(o)
visit_Arel_Attributes_String(o)
visit_Arel_Attributes_Time(o)
visit_Arel_Nodes_Addition(o)
visit_Arel_Nodes_And(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 322
def visit_Arel_Nodes_And o
  o.children.map { |x| visit x }.join ' AND '
end
visit_Arel_Nodes_As(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 355
def visit_Arel_Nodes_As o
  "#{visit o.left} AS #{visit o.right}"
end
visit_Arel_Nodes_Ascending(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 203
def visit_Arel_Nodes_Ascending o
  "#{visit o.expr} ASC"
end
visit_Arel_Nodes_Assignment(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 330
def visit_Arel_Nodes_Assignment o
  right = quote(o.right, column_for(o.left))
  "#{visit o.left} = #{right}"
end
visit_Arel_Nodes_Avg(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 242
def visit_Arel_Nodes_Avg o
  "AVG(#{o.expressions.map { |x|
    visit x }.join(', ')})#{o.alias ? " AS #{visit o.alias}" : ''}"
end
visit_Arel_Nodes_Between(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 251
def visit_Arel_Nodes_Between o
  "#{visit o.left} BETWEEN #{visit o.right}"
end
visit_Arel_Nodes_Bin(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 142
def visit_Arel_Nodes_Bin o
  visit o.expr
end
visit_Arel_Nodes_BindParam(o;)
Alias for: literal
visit_Arel_Nodes_Count(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 221
def visit_Arel_Nodes_Count o
  "COUNT(#{o.distinct ? 'DISTINCT ' : ''}#{o.expressions.map { |x|
    visit x
  }.join(', ')})#{o.alias ? " AS #{visit o.alias}" : ''}"
end
visit_Arel_Nodes_DeleteStatement(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 23
def visit_Arel_Nodes_DeleteStatement o
  [
    "DELETE FROM #{visit o.relation}",
    ("WHERE #{o.wheres.map { |x| visit x }.join ' AND '}" unless o.wheres.empty?)
  ].compact.join ' '
end
visit_Arel_Nodes_Descending(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 207
def visit_Arel_Nodes_Descending o
  "#{visit o.expr} DESC"
end
visit_Arel_Nodes_Distinct(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 146
def visit_Arel_Nodes_Distinct o
  'DISTINCT'
end
visit_Arel_Nodes_DistinctOn(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 150
def visit_Arel_Nodes_DistinctOn o
  raise NotImplementedError, 'DISTINCT ON not implemented for this db'
end
visit_Arel_Nodes_Division(o)
visit_Arel_Nodes_DoesNotMatch(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 275
def visit_Arel_Nodes_DoesNotMatch o
  "#{visit o.left} NOT LIKE #{visit o.right}"
end
visit_Arel_Nodes_Equality(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 335
def visit_Arel_Nodes_Equality o
  right = o.right

  if right.nil?
    "#{visit o.left} IS NULL"
  else
    "#{visit o.left} = #{visit right}"
  end
end
visit_Arel_Nodes_Except(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 174
def visit_Arel_Nodes_Except o
  "( #{visit o.left} EXCEPT #{visit o.right} )"
end
visit_Arel_Nodes_Exists(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 78
def visit_Arel_Nodes_Exists o
  "EXISTS (#{visit o.expressions})#{
    o.alias ? " AS #{visit o.alias}" : ''}"
end
visit_Arel_Nodes_False(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 87
def visit_Arel_Nodes_False o
  "FALSE"
end
visit_Arel_Nodes_GreaterThan(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 259
def visit_Arel_Nodes_GreaterThan o
  "#{visit o.left} > #{visit o.right}"
end
visit_Arel_Nodes_GreaterThanOrEqual(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 255
def visit_Arel_Nodes_GreaterThanOrEqual o
  "#{visit o.left} >= #{visit o.right}"
end
visit_Arel_Nodes_Group(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 211
def visit_Arel_Nodes_Group o
  visit o.expr
end
visit_Arel_Nodes_Grouping(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 199
def visit_Arel_Nodes_Grouping o
  "(#{visit o.expr})"
end
visit_Arel_Nodes_Having(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 178
def visit_Arel_Nodes_Having o
  "HAVING #{visit o.expr}"
end
visit_Arel_Nodes_In(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 314
def visit_Arel_Nodes_In o
  "#{visit o.left} IN (#{visit o.right})"
end
visit_Arel_Nodes_InfixOperation(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 402
def visit_Arel_Nodes_InfixOperation o
  "#{visit o.left} #{o.operator} #{visit o.right}"
end
visit_Arel_Nodes_InnerJoin(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 294
def visit_Arel_Nodes_InnerJoin o
  "INNER JOIN #{visit o.left} #{visit o.right if o.right}"
end
visit_Arel_Nodes_InsertStatement(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 66
def visit_Arel_Nodes_InsertStatement o
  [
    "INSERT INTO #{visit o.relation}",

    ("(#{o.columns.map { |x|
    quote_column_name x.name
  }.join ', '})" unless o.columns.empty?),

    (visit o.values if o.values),
  ].compact.join ' '
end
visit_Arel_Nodes_Intersect(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 170
def visit_Arel_Nodes_Intersect o
  "( #{visit o.left} INTERSECT #{visit o.right} )"
end
visit_Arel_Nodes_JoinSource(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 279
def visit_Arel_Nodes_JoinSource o
  [
    (visit(o.left) if o.left),
    o.right.map { |j| visit j }.join(' ')
  ].compact.join ' '
end
visit_Arel_Nodes_LessThan(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 267
def visit_Arel_Nodes_LessThan o
  "#{visit o.left} < #{visit o.right}"
end
visit_Arel_Nodes_LessThanOrEqual(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 263
def visit_Arel_Nodes_LessThanOrEqual o
  "#{visit o.left} <= #{visit o.right}"
end
visit_Arel_Nodes_Limit(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 186
def visit_Arel_Nodes_Limit o
  "LIMIT #{visit o.expr}"
end
visit_Arel_Nodes_Lock(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 195
def visit_Arel_Nodes_Lock o
  visit o.expr
end
visit_Arel_Nodes_Matches(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 271
def visit_Arel_Nodes_Matches o
  "#{visit o.left} LIKE #{visit o.right}"
end
visit_Arel_Nodes_Max(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 232
def visit_Arel_Nodes_Max o
  "MAX(#{o.expressions.map { |x|
    visit x }.join(', ')})#{o.alias ? " AS #{visit o.alias}" : ''}"
end
visit_Arel_Nodes_Min(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 237
def visit_Arel_Nodes_Min o
  "MIN(#{o.expressions.map { |x|
    visit x }.join(', ')})#{o.alias ? " AS #{visit o.alias}" : ''}"
end
visit_Arel_Nodes_Multiplication(o)
visit_Arel_Nodes_NamedFunction(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 215
def visit_Arel_Nodes_NamedFunction o
  "#{o.name}(#{o.distinct ? 'DISTINCT ' : ''}#{o.expressions.map { |x|
    visit x
  }.join(', ')})#{o.alias ? " AS #{visit o.alias}" : ''}"
end
visit_Arel_Nodes_Not(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 302
def visit_Arel_Nodes_Not o
  "NOT (#{visit o.expr})"
end
visit_Arel_Nodes_NotEqual(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 345
def visit_Arel_Nodes_NotEqual o
  right = o.right

  if right.nil?
    "#{visit o.left} IS NOT NULL"
  else
    "#{visit o.left} != #{visit right}"
  end
end
visit_Arel_Nodes_NotIn(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 318
def visit_Arel_Nodes_NotIn o
  "#{visit o.left} NOT IN (#{visit o.right})"
end
visit_Arel_Nodes_Offset(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 182
def visit_Arel_Nodes_Offset o
  "OFFSET #{visit o.expr}"
end
visit_Arel_Nodes_On(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 298
def visit_Arel_Nodes_On o
  "ON #{visit o.expr}"
end
visit_Arel_Nodes_Or(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 326
def visit_Arel_Nodes_Or o
  "#{visit o.left} OR #{visit o.right}"
end
visit_Arel_Nodes_OuterJoin(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 290
def visit_Arel_Nodes_OuterJoin o
  "LEFT OUTER JOIN #{visit o.left} #{visit o.right}"
end
visit_Arel_Nodes_SelectCore(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 129
def visit_Arel_Nodes_SelectCore o
  [
    "SELECT",
    (visit(o.top) if o.top),
    (visit(o.set_quantifier) if o.set_quantifier),
    ("#{o.projections.map { |x| visit x }.join ', '}" unless o.projections.empty?),
    ("FROM #{visit(o.source)}" if o.source && !o.source.empty?),
    ("WHERE #{o.wheres.map { |x| visit x }.join ' AND ' }" unless o.wheres.empty?),
    ("GROUP BY #{o.groups.map { |x| visit x }.join ', ' }" unless o.groups.empty?),
    (visit(o.having) if o.having),
  ].compact.join ' '
end
visit_Arel_Nodes_SelectStatement(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 118
def visit_Arel_Nodes_SelectStatement o
  [
    (visit(o.with) if o.with),
    o.cores.map { |x| visit_Arel_Nodes_SelectCore x }.join,
    ("ORDER BY #{o.orders.map { |x| visit x }.join(', ')}" unless o.orders.empty?),
    (visit(o.limit) if o.limit),
    (visit(o.offset) if o.offset),
    (visit(o.lock) if o.lock),
  ].compact.join ' '
end
visit_Arel_Nodes_SqlLiteral(o;)
Alias for: literal
visit_Arel_Nodes_StringJoin(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 286
def visit_Arel_Nodes_StringJoin o
  visit o.left
end
visit_Arel_Nodes_Subtraction(o)
visit_Arel_Nodes_Sum(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 227
def visit_Arel_Nodes_Sum o
  "SUM(#{o.expressions.map { |x|
    visit x }.join(', ')})#{o.alias ? " AS #{visit o.alias}" : ''}"
end
visit_Arel_Nodes_TableAlias(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 247
def visit_Arel_Nodes_TableAlias o
  "#{visit o.relation} #{quote_table_name o.name}"
end
visit_Arel_Nodes_Top(o) click to toggle source

FIXME: this does nothing on most databases, but does on MSSQL

# File lib/arel/visitors/to_sql.rb, line 191
def visit_Arel_Nodes_Top o
  ""
end
visit_Arel_Nodes_True(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 83
def visit_Arel_Nodes_True o
  "TRUE"
end
visit_Arel_Nodes_Union(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 162
def visit_Arel_Nodes_Union o
  "( #{visit o.left} UNION #{visit o.right} )"
end
visit_Arel_Nodes_UnionAll(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 166
def visit_Arel_Nodes_UnionAll o
  "( #{visit o.left} UNION ALL #{visit o.right} )"
end
visit_Arel_Nodes_UnqualifiedColumn(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 359
def visit_Arel_Nodes_UnqualifiedColumn o
  "#{quote_column_name o.name}"
end
visit_Arel_Nodes_UpdateStatement(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 42
      def visit_Arel_Nodes_UpdateStatement o
        if o.orders.empty? && o.limit.nil?
          wheres = o.wheres
        else
          key = o.key
          unless key
            warn("(#{caller.first}) Using UpdateManager without setting UpdateManager#key is
deprecated and support will be removed in ARel 4.0.0.  Please set the primary
key on UpdateManager using UpdateManager#key=
") if $VERBOSE
            key = o.relation.primary_key
          end

          wheres = [Nodes::In.new(key, [build_subselect(key, o)])]
        end

        [
          "UPDATE #{visit o.relation}",
          ("SET #{o.values.map { |value| visit value }.join ', '}" unless o.values.empty?),
          ("WHERE #{wheres.map { |x| visit x }.join ' AND '}" unless wheres.empty?),
        ].compact.join ' '
      end
visit_Arel_Nodes_Values(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 108
def visit_Arel_Nodes_Values o
  "VALUES (#{o.expressions.zip(o.columns).map { |value, attr|
    if Nodes::SqlLiteral === value
      visit value
    else
      quote(value, attr && column_for(attr))
    end
  }.join ', '})"
end
visit_Arel_Nodes_With(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 154
def visit_Arel_Nodes_With o
  "WITH #{o.children.map { |x| visit x }.join(', ')}"
end
visit_Arel_Nodes_WithRecursive(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 158
def visit_Arel_Nodes_WithRecursive o
  "WITH RECURSIVE #{o.children.map { |x| visit x }.join(', ')}"
end
visit_Arel_SqlLiteral(o;)
Alias for: literal
visit_Arel_Table(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 306
def visit_Arel_Table o
  if o.table_alias
    "#{quote_table_name o.name} #{quote_table_name o.table_alias}"
  else
    quote_table_name o.name
  end
end
visit_Array(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 411
def visit_Array o
  o.empty? ? 'NULL' : o.map { |x| visit x }.join(', ')
end
visit_BigDecimal(o)
Alias for: quoted
visit_Bignum(o;)
Alias for: literal
visit_Class(o)
Alias for: quoted
visit_Date(o)
Alias for: quoted
visit_DateTime(o)
Alias for: quoted
visit_FalseClass(o)
Alias for: quoted
visit_Fixnum(o;)
Alias for: literal
visit_Float(o)
Alias for: quoted
visit_Hash(o)
Alias for: quoted
visit_NilClass(o)
Alias for: quoted
visit_String(o)
Alias for: quoted
visit_Symbol(o)
Alias for: quoted
visit_Time(o)
Alias for: quoted
visit_TrueClass(o)
Alias for: quoted