123456789_123456789_123456789_123456789_123456789_

Class: ActiveRecord::ConnectionAdapters::PostgreSQL::TableDefinition

Overview

Active Record PostgreSQL Adapter Table Definition

Class Method Summary

::ActiveRecord::ConnectionAdapters::TableDefinition - Inherited

.new

Instance Attribute Summary

::ActiveRecord::ConnectionAdapters::TableDefinition - Inherited

#as, #check_constraints, #comment, #foreign_keys, #if_not_exists, #indexes, #name, #options, #temporary

Instance Method Summary

ColumnMethods - Included

#bigserial, #bit, #bit_varying, #box, #cidr, #circle, #citext, #daterange, #enum, #hstore, #inet, #int4range, #int8range, #interval, #jsonb, #line, #lseg, #ltree, #macaddr, #money, #numrange, #oid, #path, #point, #polygon,
#primary_key

Defines the primary key field.
#serial, #timestamptz, #tsrange, #tstzrange, #tsvector, #uuid, #xml

::ActiveRecord::ConnectionAdapters::TableDefinition - Inherited

#[]

Returns a ::ActiveRecord::ConnectionAdapters::ColumnDefinition for the column with name name.
#belongs_to

Alias for TableDefinition#references.
#blob, #check_constraint,
#column

Instantiates a new column for the table.
#columns

Returns an array of ::ActiveRecord::ConnectionAdapters::ColumnDefinition objects for the columns of the table.
#foreign_key,
#index

Adds index options to the indexes hash, keyed by column name This is primarily used to track indexes that need to be created after the table.
#numeric,
#references

Adds a reference.
#remove_column

remove the column name from the table.
#set_primary_key,
#timestamps

Appends :datetime columns :created_at and :updated_at to the table.
#aliased_types, #create_column_definition, #integer_like_primary_key?, #integer_like_primary_key_type, #raise_on_duplicate_column, #valid_column_definition_options, #new_check_constraint_definition, #new_column_definition, #new_foreign_key_definition, #primary_keys

::ActiveRecord::ConnectionAdapters::ColumnMethods - Included

#column

Appends a column or columns of a specified type.
#primary_key

Appends a primary key definition to the table definition.

Constructor Details

.new ⇒ TableDefinition

[ GitHub ] 

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 248



def initialize(*, **)
  super
  @exclusion_constraints = []
  @unique_constraints = []
  @unlogged = ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.create_unlogged_tables
end


  







Instance Attribute Details



  

    #exclusion_constraints   (readonly)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 246



attr_reader :exclusion_constraints, :unique_constraints, :unlogged


  








  

    #unique_constraints   (readonly)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 246



attr_reader :exclusion_constraints, :unique_constraints, :unlogged


  








  

    #unlogged   (readonly)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 246



attr_reader :exclusion_constraints, :unique_constraints, :unlogged


  







Instance Method Details



  

    #aliased_types(name, fallback)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 287



def aliased_types(name, fallback)
  fallback
end


  








  

    #exclusion_constraint(expression, **options)  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 255



def exclusion_constraint(expression, **options)
  exclusion_constraints << new_exclusion_constraint_definition(expression, options)
end


  








  

    #integer_like_primary_key_type(type, options)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 291



def integer_like_primary_key_type(type, options)
  if type == :bigint || options[:limit] == 8
    :bigserial
  else
    :serial
  end
end


  








  

    #new_column_definition(name, type, **options)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 273



def new_column_definition(name, type, **options) # :nodoc:
  case type
  when :virtual
    type = options[:type]
  end

  super
end


  








  

    #new_exclusion_constraint_definition(expression, options)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 263



def new_exclusion_constraint_definition(expression, options) # :nodoc:
  options = @conn.exclusion_constraint_options(name, expression, options)
  ExclusionConstraintDefinition.new(name, expression, options)
end


  








  

    #new_unique_constraint_definition(column_name, options)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 268



def new_unique_constraint_definition(column_name, options) # :nodoc:
  options = @conn.unique_constraint_options(name, column_name, options)
  UniqueConstraintDefinition.new(name, column_name, options)
end


  








  

    #unique_constraint(column_name, **options)  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 259



def unique_constraint(column_name, **options)
  unique_constraints << new_unique_constraint_definition(column_name, options)
end


  








  

    #valid_column_definition_options   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 283



def valid_column_definition_options
  super + [:array, :using, :cast_as, :as, :type, :enum_type, :stored]
end