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

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, ::ActiveRecord::ConnectionAdapters::TableDefinition
Instance Chain: self, ColumnMethods, ::ActiveRecord::ConnectionAdapters::TableDefinition
Inherits:	ActiveRecord::ConnectionAdapters::TableDefinition ::Object ActiveRecord::ConnectionAdapters::TableDefinition ActiveRecord::ConnectionAdapters::PostgreSQL::TableDefinition
Defined in:	activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb

Class Method Summary

::ActiveRecord::ConnectionAdapters::TableDefinition - Inherited

.new

Instance Attribute Summary

::ActiveRecord::ConnectionAdapters::TableDefinition - Inherited

#as, #foreign_keys,
#indexes	An array of ColumnDefinition objects, representing the column changes that have been defined.
#name, #options, #temporary

Instance Method Summary

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

Defines the primary key field.

ColumnMethods - Included

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

::ActiveRecord::ConnectionAdapters::TableDefinition - Inherited

#[]	Returns a ColumnDefinition for the column with name `name`.
#belongs_to	Alias for TableDefinition#references.
#column	Instantiates a new column for the table.
#columns,
#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.
#primary_key	Appends a primary key definition to the table definition.
#references	Adds a reference.
#remove_column,
#timestamps	Appends `:datetime` columns `:created_at` and `:updated_at` to the table.

Constructor Details

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

Instance Method Details

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

Defines the primary key field. Use of the native ::ActiveRecord::ConnectionAdapters::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.

[ GitHub ]

# 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