Module: ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::SchemaStatements

Included in:
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
Defined in:
lib/active_record/connection_adapters/postgresql/schema_statements.rb

Instance Method Summary collapse

Instance Method Details

#add_column(table_name, column_name, type, options = {}) ⇒ Object

Adds a new column to the named table. See TableDefinition#column for details of the options you can use.



393
394
395
396
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 393

def add_column(table_name, column_name, type, options = {})
  clear_cache!
  super
end

#add_index(table_name, column_name, options = {}) ⇒ Object

:nodoc:



434
435
436
437
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 434

def add_index(table_name, column_name, options = {}) #:nodoc:
  index_name, index_type, index_columns, index_options, index_algorithm, index_using = add_index_options(table_name, column_name, options)
  execute "CREATE #{index_type} INDEX #{index_algorithm} #{quote_column_name(index_name)} ON #{quote_table_name(table_name)} #{index_using} (#{index_columns})#{index_options}"
end

#change_column(table_name, column_name, type, options = {}) ⇒ Object

Changes the column of a table.



399
400
401
402
403
404
405
406
407
408
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 399

def change_column(table_name, column_name, type, options = {})
  clear_cache!
  quoted_table_name = quote_table_name(table_name)
  sql_type = type_to_sql(type, options[:limit], options[:precision], options[:scale])
  sql_type << "[]" if options[:array]
  execute "ALTER TABLE #{quoted_table_name} ALTER COLUMN #{quote_column_name(column_name)} TYPE #{sql_type}"

  change_column_default(table_name, column_name, options[:default]) if options_include_default?(options)
  change_column_null(table_name, column_name, options[:null], options[:default]) if options.key?(:null)
end

#change_column_default(table_name, column_name, default) ⇒ Object

Changes the default value of a table column.



411
412
413
414
415
416
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 411

def change_column_default(table_name, column_name, default)
  clear_cache!
  column = column_for(table_name, column_name)

  execute "ALTER TABLE #{quote_table_name(table_name)} ALTER COLUMN #{quote_column_name(column_name)} SET DEFAULT #{quote_default_value(default, column)}" if column
end

#change_column_null(table_name, column_name, null, default = nil) ⇒ Object 



418
419
420
421
422
423
424
425
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 418

def change_column_null(table_name, column_name, null, default = nil)
  clear_cache!
  unless null || default.nil?
    column = column_for(table_name, column_name)
    execute("UPDATE #{quote_table_name(table_name)} SET #{quote_column_name(column_name)}=#{quote_default_value(default, column)} WHERE #{quote_column_name(column_name)} IS NULL") if column
  end
  execute("ALTER TABLE #{quote_table_name(table_name)} ALTER #{quote_column_name(column_name)} #{null ? 'DROP' : 'SET'} NOT NULL")
end

#client_min_messages ⇒ Object

Returns the current client message level.



268
269
270
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 268

def client_min_messages
  query('SHOW client_min_messages', 'SCHEMA')[0][0]
end

#client_min_messages=(level) ⇒ Object

Set the client message level.



273
274
275
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 273

def client_min_messages=(level)
  execute("SET client_min_messages TO '#{level}'", 'SCHEMA')
end

#collation ⇒ Object

Returns the current database collation.



216
217
218
219
220
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 216

def collation
  query("    SELECT pg_database.datcollate FROM pg_database WHERE pg_database.datname LIKE '\#{current_database}'\n  end_sql\nend\n", 'SCHEMA')[0][0]

#column_for(table_name, column_name) ⇒ Object

:nodoc:



193
194
195
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 193

def column_for(table_name, column_name) #:nodoc:
  columns(table_name).detect { |c| c.name == column_name.to_s }
end

#columns(table_name) ⇒ Object

Returns the list of all column definitions for a table.



185
186
187
188
189
190
191
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 185

def columns(table_name)
  # Limit, precision, and scale are all handled by the superclass.
  column_definitions(table_name).map do |column_name, type, default, notnull, oid, fmod|
    oid = get_oid_type(oid.to_i, fmod.to_i, column_name)
    PostgreSQLColumn.new(column_name, default, oid, type, notnull == 'f')
  end
end

#columns_for_distinct(columns, orders) ⇒ Object

PostgreSQL requires the ORDER BY columns in the select list for distinct queries, and requires that the ORDER BY include the distinct column.



491
492
493
494
495
496
497
498
499
500
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 491

def columns_for_distinct(columns, orders) #:nodoc:
  order_columns = orders.map{ |s|
      # Convert Arel node to string
      s = s.to_sql unless s.is_a?(String)
      # Remove any ASC/DESC modifiers
      s.gsub(/\s+(ASC|DESC)\s*(NULLS\s+(FIRST|LAST)\s*)?/i, '')
    }.reject(&:blank?).map.with_index { |column, i| "#{column} AS alias_#{i}" }

  [super, *order_columns].join(', ')
end

#create_database(name, options = {}) ⇒ Object

Create a new PostgreSQL database. Options include :owner, :template, :encoding, :collation, :ctype, :tablespace, and :connection_limit (note that MySQL uses :charset while PostgreSQL uses :encoding).

Example:

create_database config[:database], config
create_database 'foo_development', encoding: 'unicode'



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 56

def create_database(name, options = {})
  options = { encoding: 'utf8' }.merge!(options.symbolize_keys)

  option_string = options.sum do |key, value|
    case key
    when :owner
      " OWNER = \"#{value}\""
    when :template
      " TEMPLATE = \"#{value}\""
    when :encoding
      " ENCODING = '#{value}'"
    when :collation
      " LC_COLLATE = '#{value}'"
    when :ctype
      " LC_CTYPE = '#{value}'"
    when :tablespace
      " TABLESPACE = \"#{value}\""
    when :connection_limit
      " CONNECTION LIMIT = #{value}"
    else
      ""
    end
  end

  execute "CREATE DATABASE #{quote_table_name(name)}#{option_string}"
end

#create_schema(schema_name) ⇒ Object

Creates a schema for the given schema name.



241
242
243
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 241

def create_schema schema_name
  execute "CREATE SCHEMA #{schema_name}"
end

#ctype ⇒ Object

Returns the current database ctype.



223
224
225
226
227
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 223

def ctype
  query("    SELECT pg_database.datctype FROM pg_database WHERE pg_database.datname LIKE '\#{current_database}'\n  end_sql\nend\n", 'SCHEMA')[0][0]

#current_database ⇒ Object

Returns the current database name.



198
199
200
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 198

def current_database
  query('select current_database()', 'SCHEMA')[0][0]
end

#current_schema ⇒ Object

Returns the current schema name.



203
204
205
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 203

def current_schema
  query('SELECT current_schema', 'SCHEMA')[0][0]
end

#default_sequence_name(table_name, pk = nil) ⇒ Object

Returns the sequence name for a table’s primary key or some other specified key.



278
279
280
281
282
283
284
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 278

def default_sequence_name(table_name, pk = nil) #:nodoc:
  result = serial_sequence(table_name, pk || 'id')
  return nil unless result
  result.split('.').last
rescue ActiveRecord::StatementInvalid
  "#{table_name}_#{pk || 'id'}_seq"
end

#drop_database(name) ⇒ Object

Drops a PostgreSQL database.

Example:

drop_database 'matt_development'



87
88
89
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 87

def drop_database(name) #:nodoc:
  execute "DROP DATABASE IF EXISTS #{quote_table_name(name)}"
end

#drop_schema(schema_name) ⇒ Object

Drops the schema for the given schema name.



246
247
248
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 246

def drop_schema schema_name
  execute "DROP SCHEMA #{schema_name} CASCADE"
end

#encoding ⇒ Object

Returns the current database encoding format.



208
209
210
211
212
213
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 208

def encoding
  query("    SELECT pg_encoding_to_char(pg_database.encoding) FROM pg_database\n    WHERE pg_database.datname LIKE '\#{current_database}'\n  end_sql\nend\n", 'SCHEMA')[0][0]

#index_name_exists?(table_name, index_name, default) ⇒ Boolean

Returns:

  • (Boolean) 


129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 129

def index_name_exists?(table_name, index_name, default)
  exec_query("    SELECT COUNT(*)\n    FROM pg_class t\n    INNER JOIN pg_index d ON t.oid = d.indrelid\n    INNER JOIN pg_class i ON d.indexrelid = i.oid\n    WHERE i.relkind = 'i'\n      AND i.relname = '\#{index_name}'\n      AND t.relname = '\#{table_name}'\n      AND i.relnamespace IN (SELECT oid FROM pg_namespace WHERE nspname = ANY (current_schemas(false)) )\n  SQL\nend\n", 'SCHEMA').rows.first[0].to_i > 0

#index_name_length ⇒ Object 



447
448
449
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 447

def index_name_length
  63
end

#indexes(table_name, name = nil) ⇒ Object

Returns an array of indexes for the given table.



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 143

def indexes(table_name, name = nil)
   result = query("     SELECT distinct i.relname, d.indisunique, d.indkey, pg_get_indexdef(d.indexrelid), t.oid\n     FROM pg_class t\n     INNER JOIN pg_index d ON t.oid = d.indrelid\n     INNER JOIN pg_class i ON d.indexrelid = i.oid\n     WHERE i.relkind = 'i'\n       AND d.indisprimary = 'f'\n       AND t.relname = '\#{table_name}'\n       AND i.relnamespace IN (SELECT oid FROM pg_namespace WHERE nspname = ANY (current_schemas(false)) )\n    ORDER BY i.relname\n  SQL\n\n  result.map do |row|\n    index_name = row[0]\n    unique = row[1] == 't'\n    indkey = row[2].split(\" \")\n    inddef = row[3]\n    oid = row[4]\n\n    columns = Hash[query(<<-SQL, \"SCHEMA\")]\n    SELECT a.attnum, a.attname\n    FROM pg_attribute a\n    WHERE a.attrelid = \#{oid}\n    AND a.attnum IN (\#{indkey.join(\",\")})\n    SQL\n\n    column_names = columns.values_at(*indkey).compact\n\n    unless column_names.empty?\n      # add info on sort order for columns (only desc order is explicitly specified, asc is the default)\n      desc_order_columns = inddef.scan(/(\\w+) DESC/).flatten\n      orders = desc_order_columns.any? ? Hash[desc_order_columns.map {|order_column| [order_column, :desc]}] : {}\n      where = inddef.scan(/WHERE (.+)$/).flatten[0]\n      using = inddef.scan(/USING (.+?) /).flatten[0].to_sym\n\n      IndexDefinition.new(table_name, index_name, unique, column_names, [], orders, where, nil, using)\n    end\n  end.compact\nend\n", 'SCHEMA')

#pk_and_sequence_for(table) ⇒ Object

Returns a table’s primary key and belonging sequence.



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 316

def pk_and_sequence_for(table) #:nodoc:
  # First try looking for a sequence with a dependency on the
  # given table's primary key.
  result = query("    SELECT attr.attname, seq.relname\n    FROM pg_class      seq,\n         pg_attribute  attr,\n         pg_depend     dep,\n         pg_constraint cons\n    WHERE seq.oid           = dep.objid\n      AND seq.relkind       = 'S'\n      AND attr.attrelid     = dep.refobjid\n      AND attr.attnum       = dep.refobjsubid\n      AND attr.attrelid     = cons.conrelid\n      AND attr.attnum       = cons.conkey[1]\n      AND cons.contype      = 'p'\n      AND dep.refobjid      = '\#{quote_table_name(table)}'::regclass\n  end_sql\n\n  if result.nil? or result.empty?\n    result = query(<<-end_sql, 'SCHEMA')[0]\n      SELECT attr.attname,\n        CASE\n          WHEN pg_get_expr(def.adbin, def.adrelid) !~* 'nextval' THEN NULL\n          WHEN split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2) ~ '.' THEN\n            substr(split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2),\n                   strpos(split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2), '.')+1)\n          ELSE split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2)\n        END\n      FROM pg_class       t\n      JOIN pg_attribute   attr ON (t.oid = attrelid)\n      JOIN pg_attrdef     def  ON (adrelid = attrelid AND adnum = attnum)\n      JOIN pg_constraint  cons ON (conrelid = adrelid AND adnum = conkey[1])\n      WHERE t.oid = '\#{quote_table_name(table)}'::regclass\n        AND cons.contype = 'p'\n        AND pg_get_expr(def.adbin, def.adrelid) ~* 'nextval|uuid_generate'\n    end_sql\n  end\n\n  [result.first, result.last]\nrescue\n  nil\nend\n", 'SCHEMA')[0]

#primary_key(table) ⇒ Object

Returns just a table’s primary key



361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 361

def primary_key(table)
  row = exec_query("    SELECT attr.attname\n    FROM pg_attribute attr\n    INNER JOIN pg_constraint cons ON attr.attrelid = cons.conrelid AND attr.attnum = cons.conkey[1]\n    WHERE cons.contype = 'p'\n      AND cons.conrelid = '\#{quote_table_name(table)}'::regclass\n  end_sql\n\n  row && row.first\nend\n", 'SCHEMA').rows.first

#recreate_database(name, options = {}) ⇒ Object

Drops the database specified on the name attribute and creates it again using the provided options.



43
44
45
46
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 43

def recreate_database(name, options = {}) #:nodoc:
  drop_database(name)
  create_database(name, options)
end

#remove_index!(table_name, index_name) ⇒ Object

:nodoc:



439
440
441
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 439

def remove_index!(table_name, index_name) #:nodoc:
  execute "DROP INDEX #{quote_table_name(index_name)}"
end

#rename_column(table_name, column_name, new_column_name) ⇒ Object

Renames a column in a table.



428
429
430
431
432
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 428

def rename_column(table_name, column_name, new_column_name)
  clear_cache!
  execute "ALTER TABLE #{quote_table_name(table_name)} RENAME COLUMN #{quote_column_name(column_name)} TO #{quote_column_name(new_column_name)}"
  rename_column_indexes(table_name, column_name, new_column_name)
end

#rename_index(table_name, old_name, new_name) ⇒ Object 



443
444
445
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 443

def rename_index(table_name, old_name, new_name)
  execute "ALTER INDEX #{quote_column_name(old_name)} RENAME TO #{quote_table_name(new_name)}"
end

#rename_table(table_name, new_name) ⇒ Object

Renames a table. Also renames a table’s primary key sequence if the sequence name matches the Active Record default.

Example:

rename_table('octopuses', 'octopi')



379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 379

def rename_table(table_name, new_name)
  clear_cache!
  execute "ALTER TABLE #{quote_table_name(table_name)} RENAME TO #{quote_table_name(new_name)}"
  pk, seq = pk_and_sequence_for(new_name)
  if seq == "#{table_name}_#{pk}_seq"
    new_seq = "#{new_name}_#{pk}_seq"
    execute "ALTER TABLE #{quote_table_name(seq)} RENAME TO #{quote_table_name(new_seq)}"
  end

  rename_table_indexes(table_name, new_name)
end

#reset_pk_sequence!(table, pk = nil, sequence = nil) ⇒ Object

Resets the sequence of a table’s primary key to the maximum value.



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 294

def reset_pk_sequence!(table, pk = nil, sequence = nil) #:nodoc:
  unless pk and sequence
    default_pk, default_sequence = pk_and_sequence_for(table)

    pk ||= default_pk
    sequence ||= default_sequence
  end

  if @logger && pk && !sequence
    @logger.warn "#{table} has primary key #{pk} with no default sequence"
  end

  if pk && sequence
    quoted_sequence = quote_table_name(sequence)

    select_value "      SELECT setval('\#{quoted_sequence}', (SELECT COALESCE(MAX(\#{quote_column_name pk})+(SELECT increment_by FROM \#{quoted_sequence}), (SELECT min_value FROM \#{quoted_sequence})) FROM \#{quote_table_name(table)}), false)\n    end_sql\n  end\nend\n", 'SCHEMA'

#schema_exists?(name) ⇒ Boolean

Returns true if schema exists.

Returns:

  • (Boolean) 


121
122
123
124
125
126
127
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 121

def schema_exists?(name)
  exec_query("    SELECT COUNT(*)\n    FROM pg_namespace\n    WHERE nspname = '\#{name}'\n  SQL\nend\n", 'SCHEMA').rows.first[0].to_i > 0

#schema_names ⇒ Object

Returns an array of schema names.



230
231
232
233
234
235
236
237
238
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 230

def schema_names
  query("    SELECT nspname\n      FROM pg_namespace\n     WHERE nspname !~ '^pg_.*'\n       AND nspname NOT IN ('information_schema')\n     ORDER by nspname;\n  SQL\nend\n", 'SCHEMA').flatten

#schema_search_path ⇒ Object

Returns the active schema search path.



263
264
265
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 263

def schema_search_path
  @schema_search_path ||= query('SHOW search_path', 'SCHEMA')[0][0]
end

#schema_search_path=(schema_csv) ⇒ Object

Sets the schema search path to a string of comma-separated schema names. Names beginning with $ have to be quoted (e.g. $user => ‘$user’). See: www.postgresql.org/docs/current/static/ddl-schemas.html

This should be not be called manually but set in database.yml.



255
256
257
258
259
260
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 255

def schema_search_path=(schema_csv)
  if schema_csv
    execute("SET search_path TO #{schema_csv}", 'SCHEMA')
    @schema_search_path = schema_csv
  end
end

#serial_sequence(table, column) ⇒ Object 



286
287
288
289
290
291
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 286

def serial_sequence(table, column)
  result = exec_query("    SELECT pg_get_serial_sequence('\#{table}', '\#{column}')\n  eosql\n  result.rows.first.first\nend\n", 'SCHEMA')

#table_exists?(name) ⇒ Boolean

Returns true if table exists. If the schema is not specified as part of name then it will only find tables within the current schema search path (regardless of permissions to access tables in other schemas)

Returns:

  • (Boolean) 


103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 103

def table_exists?(name)
  schema, table = Utils.extract_schema_and_table(name.to_s)
  return false unless table

  binds = [[nil, table]]
  binds << [nil, schema] if schema

  exec_query("      SELECT COUNT(*)\n      FROM pg_class c\n      LEFT JOIN pg_namespace n ON n.oid = c.relnamespace\n      WHERE c.relkind in ('v','r')\n      AND c.relname = '\#{table.gsub(/(^\"|\"$)/,'')}'\n      AND n.nspname = \#{schema ? \"'\#{schema}'\" : 'ANY (current_schemas(false))'}\n  SQL\nend\n", 'SCHEMA').rows.first[0].to_i > 0

#tables(name = nil) ⇒ Object

Returns the list of all tables in the schema search path or a specified schema.



92
93
94
95
96
97
98
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 92

def tables(name = nil)
  query("    SELECT tablename\n    FROM pg_tables\n    WHERE schemaname = ANY (current_schemas(false))\n  SQL\nend\n", 'SCHEMA').map { |row| row[0] }

#type_to_sql(type, limit = nil, precision = nil, scale = nil) ⇒ Object

Maps logical Rails types to PostgreSQL-specific data types.



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 452

def type_to_sql(type, limit = nil, precision = nil, scale = nil)
  case type.to_s
  when 'binary'
    # PostgreSQL doesn't support limits on binary (bytea) columns.
    # The hard limit is 1Gb, because of a 32-bit size field, and TOAST.
    case limit
    when nil, 0..0x3fffffff; super(type)
    else raise(ActiveRecordError, "No binary type has byte size #{limit}.")
    end
  when 'text'
    # PostgreSQL doesn't support limits on text columns.
    # The hard limit is 1Gb, according to section 8.3 in the manual.
    case limit
    when nil, 0..0x3fffffff; super(type)
    else raise(ActiveRecordError, "The limit on text can be at most 1GB - 1byte.")
    end
  when 'integer'
    return 'integer' unless limit

    case limit
      when 1, 2; 'smallint'
      when 3, 4; 'integer'
      when 5..8; 'bigint'
      else raise(ActiveRecordError, "No integer type has byte size #{limit}. Use a numeric with precision 0 instead.")
    end
  when 'datetime'
    return super unless precision

    case precision
      when 0..6; "timestamp(#{precision})"
      else raise(ActiveRecordError, "No timestamp type has precision of #{precision}. The allowed range of precision is from 0 to 6")
    end
  else
    super
  end
end