class Arel::Table

Attributes

engine[RW]
aliases[RW]
engine[RW]
name[RW]
table_alias[RW]
table_name[RW]

Public Class Methods

new(name, engine = Table.engine) click to toggle source
# File lib/arel/table.rb, line 14
def initialize name, engine = Table.engine
  @name    = name.to_s
  @engine  = engine
  @columns = nil
  @aliases = []
  @table_alias = nil
  @primary_key = nil

  if Hash === engine
    @engine  = engine[:engine] || Table.engine

    # Sometime AR sends an :as parameter to table, to let the table know
    # that it is an Alias.  We may want to override new, and return a
    # TableAlias node?
    @table_alias = engine[:as] unless engine[:as].to_s == @name
  end
end

Public Instance Methods

==(other)
Alias for: eql?
[](name) click to toggle source
# File lib/arel/table.rb, line 99
def [] name
  ::Arel::Attribute.new self, name
end
alias(name = " click to toggle source
# File lib/arel/table.rb, line 45
def alias name = "#{self.name}_2"
  Nodes::TableAlias.new(self, name).tap do |node|
    @aliases << node
  end
end
delete_manager() click to toggle source
# File lib/arel/table.rb, line 115
def delete_manager
  DeleteManager.new(@engine)
end
eql?(other) click to toggle source
# File lib/arel/table.rb, line 126
def eql? other
  self.class == other.class &&
    self.name == other.name &&
    self.engine == other.engine &&
    self.aliases == other.aliases &&
    self.table_alias == other.table_alias
end
Also aliased as: ==
from(table) click to toggle source
# File lib/arel/table.rb, line 51
def from table
  SelectManager.new(@engine, table)
end
group(*columns) click to toggle source
# File lib/arel/table.rb, line 71
def group *columns
  from(self).group(*columns)
end
hash() click to toggle source
# File lib/arel/table.rb, line 119
def hash
  # Perf note: aliases, table alias and engine is excluded from the hash
  #  aliases can have a loop back to this table breaking hashes in parent
  #  relations, for the vast majority of cases @name is unique to a query
  @name.hash
end
having(expr) click to toggle source
# File lib/arel/table.rb, line 95
def having expr
  from(self).having expr
end
insert_manager() click to toggle source
# File lib/arel/table.rb, line 107
def insert_manager
  InsertManager.new(@engine)
end
join(relation, klass = Nodes::InnerJoin) click to toggle source
# File lib/arel/table.rb, line 55
def join relation, klass = Nodes::InnerJoin
  return from(self) unless relation

  case relation
  when String, Nodes::SqlLiteral
    raise if relation.empty?
    klass = Nodes::StringJoin
  end

  from(self).join(relation, klass)
end
order(*expr) click to toggle source
# File lib/arel/table.rb, line 75
def order *expr
  from(self).order(*expr)
end
outer_join(relation) click to toggle source
# File lib/arel/table.rb, line 67
def outer_join relation
  join(relation, Nodes::OuterJoin)
end
primary_key() click to toggle source
# File lib/arel/table.rb, line 32
    def primary_key
      if $VERBOSE
        warn <<-eowarn
primary_key (#{caller.first}) is deprecated and will be removed in Arel 4.0.0
        eowarn
      end
      @primary_key ||= begin
        primary_key_name = @engine.connection.primary_key(name)
        # some tables might be without primary key
        primary_key_name && self[primary_key_name]
      end
    end
project(*things) click to toggle source
# File lib/arel/table.rb, line 83
def project *things
  from(self).project(*things)
end
select_manager() click to toggle source
# File lib/arel/table.rb, line 103
def select_manager
  SelectManager.new(@engine)
end
skip(amount) click to toggle source
# File lib/arel/table.rb, line 91
def skip amount
  from(self).skip amount
end
take(amount) click to toggle source
# File lib/arel/table.rb, line 87
def take amount
  from(self).take amount
end
update_manager() click to toggle source
# File lib/arel/table.rb, line 111
def update_manager
  UpdateManager.new(@engine)
end
where(condition) click to toggle source
# File lib/arel/table.rb, line 79
def where condition
  from(self).where condition
end

Private Instance Methods

attributes_for(columns) click to toggle source
# File lib/arel/table.rb, line 137
def attributes_for columns
  return nil unless columns

  columns.map do |column|
    Attributes.for(column).new self, column.name.to_sym
  end
end