module ActiveRecord::ConnectionAdapters::PostgreSQL::ColumnMethods

Public Instance Methods

# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 46
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 50
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 54
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 126
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 58
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 138
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 62
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 66
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 173
define_column_methods :bigserial, :bit, :bit_varying, :cidr, :citext, :daterange,
  :hstore, :inet, :interval, :int4range, :int8range, :jsonb, :ltree, :macaddr,
  :money, :numrange, :oid, :point, :line, :lseg, :box, :path, :polygon, :circle,
  :serial, :tsrange, :tstzrange, :tsvector, :uuid, :xml, :timestamptz, :enum
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 70
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 74
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 82
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 86
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 78
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 90
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 118
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 122
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 94
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 98
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 102
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 106
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 110
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 130
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 114
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 134
        

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 gen_random_uuid() function.

To use a UUID primary key without any defaults, 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 custom stored procedure that returns a UUID or use a different UUID generation function from 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.

Calls superclass method
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 37
def primary_key(name, type = :primary_key, **options)
  if type == :uuid
    options[:default] = options.fetch(:default, "gen_random_uuid()")
  end

  super
end
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 142
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 166
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 146
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 150
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 154
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 158
        
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_definitions.rb, line 162