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 58
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 66
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 80
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(table) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 153
def column_cache(table)
  @schema_cache.columns_hash(table)
end
column_for(attr) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 144
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 551
def literal o; o end
quote(value, column = nil) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 591
def quote value, column = nil
  return value if Arel::Nodes::SqlLiteral === value
  @connection.quote value, column
end
quote_column_name(name) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 601
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 596
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 559
def quoted o
  quote(o, last_column)
end
table_exists?(name) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 140
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 539
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 498
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 531
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 362
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 506
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 405
def visit_Arel_Nodes_Avg o
  "AVG(#{o.distinct ? 'DISTINCT ' : ''}#{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 414
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 244
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 384
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_CurrentRow(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 316
def visit_Arel_Nodes_CurrentRow o
  "CURRENT ROW"
end
visit_Arel_Nodes_DeleteStatement(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 72
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 366
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 248
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 252
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 438
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 511
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 276
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 127
def visit_Arel_Nodes_Exists o
  "EXISTS (#{visit o.expressions})#{
    o.alias ? " AS #{visit o.alias}" : ''}"
end
visit_Arel_Nodes_Extract(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 380
def visit_Arel_Nodes_Extract o
  "EXTRACT(#{o.field.to_s.upcase} FROM #{visit o.expr})#{o.alias ? " AS #{visit o.alias}" : ''}"
end
visit_Arel_Nodes_False(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 136
def visit_Arel_Nodes_False o
  "FALSE"
end
visit_Arel_Nodes_Following(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 312
def visit_Arel_Nodes_Following o
  "#{o.expr ? visit(o.expr) : 'UNBOUNDED'} FOLLOWING"
end
visit_Arel_Nodes_GreaterThan(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 422
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 418
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 370
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 354
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 333
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 482
def visit_Arel_Nodes_In o
  if Array === o.right && o.right.empty?
    '1=0'
  else
    "#{visit o.left} IN (#{visit o.right})"
  end
end
visit_Arel_Nodes_InfixOperation(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 578
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 457
def visit_Arel_Nodes_InnerJoin o
  s = "INNER JOIN #{visit o.left}"
  if o.right
    s << SPACE
    s << visit(o.right)
  end
  s
end
visit_Arel_Nodes_InsertStatement(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 115
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 272
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 442
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 430
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 426
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 341
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 350
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 434
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 395
def visit_Arel_Nodes_Max o
  "MAX(#{o.distinct ? 'DISTINCT ' : ''}#{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 400
def visit_Arel_Nodes_Min o
  "MIN(#{o.distinct ? 'DISTINCT ' : ''}#{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 374
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_NamedWindow(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 280
def visit_Arel_Nodes_NamedWindow o
  "#{quote_column_name o.name} AS #{visit_Arel_Nodes_Window o}"
end
visit_Arel_Nodes_Not(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 470
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 521
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 490
def visit_Arel_Nodes_NotIn o
  if Array === o.right && o.right.empty?
    '1=1'
  else
    "#{visit o.left} NOT IN (#{visit o.right})"
  end
end
visit_Arel_Nodes_Offset(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 337
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 466
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 502
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 453
def visit_Arel_Nodes_OuterJoin o
  "LEFT OUTER JOIN #{visit o.left} #{visit o.right}"
end
visit_Arel_Nodes_Over(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 320
def visit_Arel_Nodes_Over o
  case o.right
    when nil
      "#{visit o.left} OVER ()"
    when Arel::Nodes::SqlLiteral
      "#{visit o.left} OVER #{visit o.right}"
    when String, Symbol
      "#{visit o.left} OVER #{quote_column_name o.right.to_s}"
    else
      "#{visit o.left} OVER #{visit o.right}"
  end
end
visit_Arel_Nodes_Preceding(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 308
def visit_Arel_Nodes_Preceding o
  "#{o.expr ? visit(o.expr) : 'UNBOUNDED'} PRECEDING"
end
visit_Arel_Nodes_Range(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 300
def visit_Arel_Nodes_Range o
  if o.expr
    "RANGE #{visit o.expr}"
  else
    "RANGE"
  end
end
visit_Arel_Nodes_Rows(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 292
def visit_Arel_Nodes_Rows o
  if o.expr
    "ROWS #{visit o.expr}"
  else
    "ROWS"
  end
end
visit_Arel_Nodes_SelectCore(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 195
def visit_Arel_Nodes_SelectCore o
  str = "SELECT"

  str << " #{visit(o.top)}"            if o.top
  str << " #{visit(o.set_quantifier)}" if o.set_quantifier

  unless o.projections.empty?
    str << SPACE
    len = o.projections.length - 1
    o.projections.each_with_index do |x, i|
      str << visit(x)
      str << COMMA unless len == i
    end
  end

  str << " FROM #{visit(o.source)}" if o.source && !o.source.empty?

  unless o.wheres.empty?
    str << WHERE
    len = o.wheres.length - 1
    o.wheres.each_with_index do |x, i|
      str << visit(x)
      str << AND unless len == i
    end
  end

  unless o.groups.empty?
    str << GROUP_BY
    len = o.groups.length - 1
    o.groups.each_with_index do |x, i|
      str << visit(x)
      str << COMMA unless len == i
    end
  end

  str << " #{visit(o.having)}" if o.having

  unless o.windows.empty?
    str << WINDOW
    len = o.windows.length - 1
    o.windows.each_with_index do |x, i|
      str << visit(x)
      str << COMMA unless len == i
    end
  end

  str
end
visit_Arel_Nodes_SelectStatement(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 167
def visit_Arel_Nodes_SelectStatement o
  str = ''

  if o.with
    str << visit(o.with)
    str << SPACE
  end

  o.cores.each { |x| str << visit_Arel_Nodes_SelectCore(x) }

  unless o.orders.empty?
    str << SPACE
    str << ORDER_BY
    len = o.orders.length - 1
    o.orders.each_with_index { |x, i|
      str << visit(x)
      str << COMMA unless len == i
    }
  end

  str << " #{visit(o.limit)}" if o.limit
  str << " #{visit(o.offset)}" if o.offset
  str << " #{visit(o.lock)}" if o.lock

  str.strip!
  str
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 449
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 390
def visit_Arel_Nodes_Sum o
  "SUM(#{o.distinct ? 'DISTINCT ' : ''}#{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 410
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 346
def visit_Arel_Nodes_Top o
  ""
end
visit_Arel_Nodes_True(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 132
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 264
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 268
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 535
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 91
      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 157
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_Window(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 284
def visit_Arel_Nodes_Window o
  s = [
    ("ORDER BY #{o.orders.map { |x| visit(x) }.join(', ')}" unless o.orders.empty?),
    (visit o.framing if o.framing)
  ].compact.join ' '
  "(#{s})"
end
visit_Arel_Nodes_With(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 256
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 260
def visit_Arel_Nodes_WithRecursive o
  "WITH RECURSIVE #{o.children.map { |x| visit x }.join(', ')}"
end
visit_Arel_SelectManager(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 358
def visit_Arel_SelectManager o
  "(#{o.to_sql.rstrip})"
end
visit_Arel_SqlLiteral(o;)
Alias for: literal
visit_Arel_Table(o) click to toggle source
# File lib/arel/visitors/to_sql.rb, line 474
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 587
def visit_Array o
  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