Class: ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::TableDefinition

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

Instance Attribute Summary

Attributes inherited from TableDefinition

#indexes, #name, #options, #temporary

Instance Method Summary collapse

Methods included from ColumnMethods

#cidr, #daterange, #hstore, #inet, #int4range, #int8range, #json, #ltree, #macaddr, #numrange, #tsrange, #tstzrange, #tsvector, #uuid

Methods inherited from TableDefinition

#[], #columns, #index, #initialize, #new_column_definition, #references, #remove_column, #timestamps

Constructor Details

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

Instance Method Details

#column(name, type = nil, options = {}) ⇒ Object


368
369
370
371
372
373
374
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 368

def column(name, type = nil, options = {})
  super
  column = self[name]
  column.array = options[:array]

  self
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.


361
362
363
364
365
366
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 361

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

#xml(options = {}) ⇒ Object


376
377
378
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 376

def xml(options = {})
  column(args[0], :text, options)
end