Class: Arel::Table

Inherits:
Object
  • Object
show all
Includes:
Crud, FactoryMethods
Defined in:
lib/arel/table.rb

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from FactoryMethods

#create_and, #create_false, #create_join, #create_on, #create_string_join, #create_table_alias, #create_true, #grouping, #lower

Methods included from Crud

#compile_delete, #compile_insert, #compile_update, #create_insert

Constructor Details

#initialize(name, as: nil, type_caster: nil) ⇒ Table

Returns a new instance of Table



14
15
16
17
18
19
20
21
22
23
24
25
26
27
# File 'lib/arel/table.rb', line 14

def initialize(name, as: nil, type_caster: nil)
  @name    = name.to_s
  @columns = nil
  @aliases = []
  @type_caster = type_caster

  # 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?
  if as.to_s == @name
    as = nil
  end
  @table_alias = as
end

Class Attribute Details

.engineObject

Returns the value of attribute engine



7
8
9
# File 'lib/arel/table.rb', line 7

def engine
  @engine
end

Instance Attribute Details

#aliasesObject

Returns the value of attribute aliases



9
10
11
# File 'lib/arel/table.rb', line 9

def aliases
  @aliases
end

#nameObject Also known as: table_name

Returns the value of attribute name



9
10
11
# File 'lib/arel/table.rb', line 9

def name
  @name
end

#table_aliasObject

Returns the value of attribute table_alias



9
10
11
# File 'lib/arel/table.rb', line 9

def table_alias
  @table_alias
end

Instance Method Details

#[](name) ⇒ Object



83
84
85
# File 'lib/arel/table.rb', line 83

def [] name
  ::Arel::Attribute.new self, name
end

#able_to_type_cast?Boolean

Returns:

  • (Boolean)


106
107
108
# File 'lib/arel/table.rb', line 106

def able_to_type_cast?
  !type_caster.nil?
end

#alias(name = "#{self.name}_2") ⇒ Object



29
30
31
32
33
# File 'lib/arel/table.rb', line 29

def alias name = "#{self.name}_2"
  Nodes::TableAlias.new(self, name).tap do |node|
    @aliases << node
  end
end

#eql?(other) ⇒ Boolean Also known as: ==

Returns:

  • (Boolean)


94
95
96
97
98
99
# File 'lib/arel/table.rb', line 94

def eql? other
  self.class == other.class &&
    self.name == other.name &&
    self.aliases == other.aliases &&
    self.table_alias == other.table_alias
end

#fromObject



35
36
37
# File 'lib/arel/table.rb', line 35

def from
  SelectManager.new(self)
end

#group(*columns) ⇒ Object



55
56
57
# File 'lib/arel/table.rb', line 55

def group *columns
  from.group(*columns)
end

#hashObject



87
88
89
90
91
92
# File 'lib/arel/table.rb', line 87

def hash
  # Perf note: aliases and table alias 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) ⇒ Object



79
80
81
# File 'lib/arel/table.rb', line 79

def having expr
  from.having expr
end

#join(relation, klass = Nodes::InnerJoin) ⇒ Object



39
40
41
42
43
44
45
46
47
48
49
# File 'lib/arel/table.rb', line 39

def join relation, klass = Nodes::InnerJoin
  return from unless relation

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

  from.join(relation, klass)
end

#order(*expr) ⇒ Object



59
60
61
# File 'lib/arel/table.rb', line 59

def order *expr
  from.order(*expr)
end

#outer_join(relation) ⇒ Object



51
52
53
# File 'lib/arel/table.rb', line 51

def outer_join relation
  join(relation, Nodes::OuterJoin)
end

#project(*things) ⇒ Object



67
68
69
# File 'lib/arel/table.rb', line 67

def project *things
  from.project(*things)
end

#skip(amount) ⇒ Object



75
76
77
# File 'lib/arel/table.rb', line 75

def skip amount
  from.skip amount
end

#take(amount) ⇒ Object



71
72
73
# File 'lib/arel/table.rb', line 71

def take amount
  from.take amount
end

#type_cast_for_database(attribute_name, value) ⇒ Object



102
103
104
# File 'lib/arel/table.rb', line 102

def type_cast_for_database(attribute_name, value)
  type_caster.type_cast_for_database(attribute_name, value)
end

#where(condition) ⇒ Object



63
64
65
# File 'lib/arel/table.rb', line 63

def where condition
  from.where condition
end