Parent

Included Modules

Class/Module Index [+]

Quicksearch

Arel::Table

Attributes

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

Public Class Methods

new(name, engine = Table.engine) click to toggle source
# File lib/arel/table.rb, line 10
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
    @columns = attributes_for engine[:columns]

    # 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

[](name) click to toggle source
# File lib/arel/table.rb, line 100
def [] name
  return nil unless table_exists?

  name = name.to_sym
  columns.find { |column| column.name == name }
end
alias(name = "#{self.name}_2") click to toggle source
# File lib/arel/table.rb, line 37
def alias name = "#{self.name}_2"
  Nodes::TableAlias.new(name, self).tap do |node|
    @aliases << node
  end
end
columns() click to toggle source
# File lib/arel/table.rb, line 95
def columns
  @columns ||=
    attributes_for @engine.connection.columns(@name, "#{@name} Columns")
end
from(table) click to toggle source
# File lib/arel/table.rb, line 43
def from table
  SelectManager.new(@engine, table)
end
group(*columns) click to toggle source
# File lib/arel/table.rb, line 67
def group *columns
  from(self).group(*columns)
end
having(expr) click to toggle source
# File lib/arel/table.rb, line 91
def having expr
  from(self).having expr
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.blank?
    from Nodes::StringJoin.new(self, relation)
  else
    from klass.new(self, relation, nil)
  end
end
joins(manager) click to toggle source
# File lib/arel/table.rb, line 47
def joins manager
  if $VERBOSE
    warn "joins is deprecated and will be removed in 2.2"
    warn "please remove your call to joins from #{caller.first}"
  end
  nil
end
order(*expr) click to toggle source
# File lib/arel/table.rb, line 71
def order *expr
  from(self).order(*expr)
end
primary_key() click to toggle source
# File lib/arel/table.rb, line 29
def primary_key
  @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 79
def project *things
  from(self).project(*things)
end
select_manager() click to toggle source
# File lib/arel/table.rb, line 107
def select_manager
  SelectManager.new(@engine)
end
skip(amount) click to toggle source
# File lib/arel/table.rb, line 87
def skip amount
  from(self).skip amount
end
take(amount) click to toggle source
# File lib/arel/table.rb, line 83
def take amount
  from(self).take amount
end
where(condition) click to toggle source
# File lib/arel/table.rb, line 75
def where condition
  from(self).where condition
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.