Module: ActiveRecord::ConnectionAdapters::PostgreSQL::ColumnMethods

Included in:
Table, TableDefinition
Defined in:
lib/active_record/connection_adapters/postgresql/schema_definitions.rb

Instance Method Summary collapse

Instance Method Details

#bigserial(*args, **options) ⇒ Object 



54
55
56
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 54

def bigserial(*args, **options)
  args.each { |name| column(name, :bigserial, options) }
end

#bit(*args, **options) ⇒ Object 



58
59
60
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 58

def bit(*args, **options)
  args.each { |name| column(name, :bit, options) }
end

#bit_varying(*args, **options) ⇒ Object 



62
63
64
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 62

def bit_varying(*args, **options)
  args.each { |name| column(name, :bit_varying, options) }
end

#box(*args, **options) ⇒ Object 



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

def box(*args, **options)
  args.each { |name| column(name, :box, options) }
end

#cidr(*args, **options) ⇒ Object 



66
67
68
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 66

def cidr(*args, **options)
  args.each { |name| column(name, :cidr, options) }
end

#circle(*args, **options) ⇒ Object 



146
147
148
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 146

def circle(*args, **options)
  args.each { |name| column(name, :circle, options) }
end

#citext(*args, **options) ⇒ Object 



70
71
72
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 70

def citext(*args, **options)
  args.each { |name| column(name, :citext, options) }
end

#daterange(*args, **options) ⇒ Object 



74
75
76
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 74

def daterange(*args, **options)
  args.each { |name| column(name, :daterange, options) }
end

#hstore(*args, **options) ⇒ Object 



78
79
80
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 78

def hstore(*args, **options)
  args.each { |name| column(name, :hstore, options) }
end

#inet(*args, **options) ⇒ Object 



82
83
84
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 82

def inet(*args, **options)
  args.each { |name| column(name, :inet, options) }
end

#int4range(*args, **options) ⇒ Object 



90
91
92
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 90

def int4range(*args, **options)
  args.each { |name| column(name, :int4range, options) }
end

#int8range(*args, **options) ⇒ Object 



94
95
96
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 94

def int8range(*args, **options)
  args.each { |name| column(name, :int8range, options) }
end

#interval(*args, **options) ⇒ Object 



86
87
88
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 86

def interval(*args, **options)
  args.each { |name| column(name, :interval, options) }
end

#jsonb(*args, **options) ⇒ Object 



98
99
100
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 98

def jsonb(*args, **options)
  args.each { |name| column(name, :jsonb, options) }
end

#line(*args, **options) ⇒ Object 



126
127
128
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 126

def line(*args, **options)
  args.each { |name| column(name, :line, options) }
end

#lseg(*args, **options) ⇒ Object 



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

def lseg(*args, **options)
  args.each { |name| column(name, :lseg, options) }
end

#ltree(*args, **options) ⇒ Object 



102
103
104
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 102

def ltree(*args, **options)
  args.each { |name| column(name, :ltree, options) }
end

#macaddr(*args, **options) ⇒ Object 



106
107
108
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 106

def macaddr(*args, **options)
  args.each { |name| column(name, :macaddr, options) }
end

#money(*args, **options) ⇒ Object 



110
111
112
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 110

def money(*args, **options)
  args.each { |name| column(name, :money, options) }
end

#numrange(*args, **options) ⇒ Object 



114
115
116
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 114

def numrange(*args, **options)
  args.each { |name| column(name, :numrange, options) }
end

#oid(*args, **options) ⇒ Object 



118
119
120
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 118

def oid(*args, **options)
  args.each { |name| column(name, :oid, options) }
end

#path(*args, **options) ⇒ Object 



138
139
140
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 138

def path(*args, **options)
  args.each { |name| column(name, :path, options) }
end

#point(*args, **options) ⇒ Object 



122
123
124
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 122

def point(*args, **options)
  args.each { |name| column(name, :point, options) }
end

#polygon(*args, **options) ⇒ Object 



142
143
144
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 142

def polygon(*args, **options)
  args.each { |name| column(name, :polygon, options) }
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 gen_random_uuid() function from the pgcrypto extension. As that extension is only available in PostgreSQL 9.4+, for earlier versions an explicit default can be set to use uuid_generate_v4() from the uuid-ossp extension instead:

create_table :stuffs, id: false do |t|
  t.primary_key :id, :uuid, default: "uuid_generate_v4()"
  t.uuid :foo_id
  t.timestamps
end

To enable the appropriate extension, which is a requirement, use the enable_extension method in your migrations.

To use a UUID primary key without any of the extensions, 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.



46
47
48
49
50
51
52
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 46

def primary_key(name, type = :primary_key, **options)
  if type == :uuid
    options[:default] = options.fetch(:default, "gen_random_uuid()")
  end

  super
end

#serial(*args, **options) ⇒ Object 



150
151
152
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 150

def serial(*args, **options)
  args.each { |name| column(name, :serial, options) }
end

#tsrange(*args, **options) ⇒ Object 



154
155
156
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 154

def tsrange(*args, **options)
  args.each { |name| column(name, :tsrange, options) }
end

#tstzrange(*args, **options) ⇒ Object 



158
159
160
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 158

def tstzrange(*args, **options)
  args.each { |name| column(name, :tstzrange, options) }
end

#tsvector(*args, **options) ⇒ Object 



162
163
164
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 162

def tsvector(*args, **options)
  args.each { |name| column(name, :tsvector, options) }
end

#uuid(*args, **options) ⇒ Object 



166
167
168
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 166

def uuid(*args, **options)
  args.each { |name| column(name, :uuid, options) }
end

#xml(*args, **options) ⇒ Object 



170
171
172
 
# File 'lib/active_record/connection_adapters/postgresql/schema_definitions.rb', line 170

def xml(*args, **options)
  args.each { |name| column(name, :xml, options) }
end