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

Inherits:
TableDefinition show all
Includes:
ColumnMethods
Defined in:
activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb

Instance Attribute Summary

Attributes inherited from TableDefinition

#as, #foreign_keys, #indexes, #name, #options, #temporary

Instance Method Summary collapse

Methods included from ColumnMethods

#bit, #bit_varying, #cidr, #citext, #daterange, #hstore, #inet, #int4range, #int8range, #json, #jsonb, #ltree, #macaddr, #money, #numrange, #point, #tsrange, #tstzrange, #tsvector, #uuid, #xml

Methods inherited from TableDefinition

#[], #column, #columns, #foreign_key, #index, #initialize, #references, #remove_column, #timestamps

Methods included from TimestampDefaultDeprecation

#emit_warning_if_null_unspecified

Constructor Details

This class inherits a constructor from ActiveRecord::ConnectionAdapters::TableDefinition

Instance Method Details

#new_column_definition(name, type, options) ⇒ Object

:nodoc:


134
135
136
137
138
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 134

def new_column_definition(name, type, options) # :nodoc:
  column = super
  column.array = options[:array]
  column
end

#primary_key(name, type = :primary_key, options = {}) ⇒ Object

Defines the primary key field. Use of the native PostgreSQL UUID type is supported, and can be used by defining your tables as such:

create_table :stuffs, id: :uuid do |t|
  t.string :content
  t.timestamps
end

By default, this will use the uuid_generate_v4() function from the uuid-ossp extension, which MUST be enabled on your database. To enable the uuid-ossp extension, you can use the enable_extension method in your migrations. To use a UUID primary key without uuid-ossp enabled, you can set the :default option to nil:

create_table :stuffs, id: false do |t|
  t.primary_key :id, :uuid, default: nil
  t.uuid :foo_id
  t.timestamps
end

You may also pass a different UUID generation function from uuid-ossp or another library.

Note that setting the UUID primary key default value to nil will require you to assure that you always provide a UUID value before saving a record (as primary keys cannot be nil). This might be done via the SecureRandom.uuid method and a before_save callback, for instance.


127
128
129
130
131
132
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 127

def primary_key(name, type = :primary_key, options = {})
  return super unless type == :uuid
  options[:default] = options.fetch(:default, 'uuid_generate_v4()')
  options[:primary_key] = true
  column name, type, options
end