Module: ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaStatements

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

Defined Under Namespace

Classes: SequenceReset

Instance Method Summary collapse

Instance Method Details

#add_column(table_name, column_name, type, **options) ⇒ Object

:nodoc:



629
630
631
632
633
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 629

def add_column(table_name, column_name, type, **options) # :nodoc:
  clear_cache!
  super
  change_column_comment(table_name, column_name, options[:comment]) if options.key?(:comment)
end

#add_exclusion_constraint(table_name, expression, **options) ⇒ Object

Adds a new exclusion constraint to the table. expression is a String representation of a list of exclusion elements and operators.

add_exclusion_constraint :products, "price WITH =, availability_range WITH &&", using: :gist, name: "price_check"

generates:

ALTER TABLE "products" ADD CONSTRAINT price_check EXCLUDE USING gist (price WITH =, availability_range WITH &&)

The options hash can include the following keys:

:name

The constraint name. Defaults to excl_rails_<identifier>.

:deferrable

Specify whether or not the exclusion constraint should be deferrable. Valid values are false or :immediate or :deferred to specify the default behavior. Defaults to false.

:using

Specify which index method to use when creating this exclusion constraint (e.g. :btree, :gist etc).

:where

Specify an exclusion constraint on a subset of the table (internally PostgreSQL creates a partial index for this).



931
932
933
934
935
936
937
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 931

def add_exclusion_constraint(table_name, expression, **options)
  options = exclusion_constraint_options(table_name, expression, options)
  at = create_alter_table(table_name)
  at.add_exclusion_constraint(expression, options)

  execute schema_creation.accept(at)
end

#add_foreign_key(from_table, to_table, **options) ⇒ Object 



747
748
749
750
751
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 747

def add_foreign_key(from_table, to_table, **options)
  assert_valid_deferrable(options[:deferrable])

  super
end

#add_index(table_name, column_name, **options) ⇒ Object

:nodoc:



698
699
700
701
702
703
704
705
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 698

def add_index(table_name, column_name, **options) # :nodoc:
  create_index = build_create_index_definition(table_name, column_name, **options)
  result = execute schema_creation.accept(create_index)

  index = create_index.index
  execute "COMMENT ON INDEX #{quote_column_name(index.name)} IS #{quote(index.comment)}" if index.comment
  result
end

#add_index_options(table_name, column_name, **options) ⇒ Object

:nodoc:



1123
1124
1125
1126
1127
1128
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 1123

def add_index_options(table_name, column_name, **options) # :nodoc:
  if (where = options[:where]) && table_exists?(table_name) && column_exists?(table_name, where)
    options[:where] = quote_column_name(where)
  end
  super
end

#add_unique_constraint(table_name, column_name = nil, **options) ⇒ Object

Adds a new unique constraint to the table.

add_unique_constraint :sections, [:position], deferrable: :deferred, name: "unique_position", nulls_not_distinct: true

generates:

ALTER TABLE "sections" ADD CONSTRAINT unique_position UNIQUE (position) DEFERRABLE INITIALLY DEFERRED

If you want to change an existing unique index to deferrable, you can use :using_index to create deferrable unique constraints.

add_unique_constraint :sections, deferrable: :deferred, name: "unique_position", using_index: "index_sections_on_position"

The options hash can include the following keys:

:name

The constraint name. Defaults to uniq_rails_<identifier>.

:deferrable

Specify whether or not the unique constraint should be deferrable. Valid values are false or :immediate or :deferred to specify the default behavior. Defaults to false.

:using_index

To specify an existing unique index name. Defaults to nil.

:nulls_not_distinct

Create a unique constraint where NULLs are treated equally. Note: only supported by PostgreSQL version 15.0.0 and greater.



982
983
984
985
986
987
988
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 982

def add_unique_constraint(table_name, column_name = nil, **options)
  options = unique_constraint_options(table_name, column_name, options)
  at = create_alter_table(table_name)
  at.add_unique_constraint(column_name, options)

  execute schema_creation.accept(at)
end

#build_change_column_default_definition(table_name, column_name, default_or_changes) ⇒ Object

:nodoc:



658
659
660
661
662
663
664
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 658

def build_change_column_default_definition(table_name, column_name, default_or_changes) # :nodoc:
  column = column_for(table_name, column_name)
  return unless column

  default = extract_new_default_value(default_or_changes)
  ChangeColumnDefaultDefinition.new(column, default)
end

#build_change_column_definition(table_name, column_name, type, **options) ⇒ Object

Builds a ChangeColumnDefinition object.

This definition object contains information about the column change that would occur if the same arguments were passed to #change_column. See #change_column for information about passing a table_name, column_name, type and other options that can be passed.



647
648
649
650
651
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 647

def build_change_column_definition(table_name, column_name, type, **options) # :nodoc:
  td = create_table_definition(table_name)
  cd = td.new_column_definition(column_name, type, **options)
  ChangeColumnDefinition.new(cd, column_name)
end

#build_create_index_definition(table_name, column_name, **options) ⇒ Object

:nodoc:



707
708
709
710
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 707

def build_create_index_definition(table_name, column_name, **options) # :nodoc:
  index, algorithm, if_not_exists = add_index_options(table_name, column_name, **options)
  CreateIndexDefinition.new(index, algorithm, if_not_exists)
end

#change_column(table_name, column_name, type, **options) ⇒ Object

:nodoc:



635
636
637
638
639
640
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 635

def change_column(table_name, column_name, type, **options) # :nodoc:
  clear_cache!
  sqls, procs = Array(change_column_for_alter(table_name, column_name, type, **options)).partition { |v| v.is_a?(String) }
  execute "ALTER TABLE #{quote_table_name(table_name)} #{sqls.join(", ")}"
  procs.each(&:call)
end

#change_column_comment(table_name, column_name, comment_or_changes) ⇒ Object

Adds comment for given table column or drops it if comment is a nil



678
679
680
681
682
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 678

def change_column_comment(table_name, column_name, comment_or_changes) # :nodoc:
  clear_cache!
  comment = extract_new_comment_value(comment_or_changes)
  execute "COMMENT ON COLUMN #{quote_table_name(table_name)}.#{quote_column_name(column_name)} IS #{quote(comment)}"
end

#change_column_default(table_name, column_name, default_or_changes) ⇒ Object

Changes the default value of a table column.



654
655
656
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 654

def change_column_default(table_name, column_name, default_or_changes) # :nodoc:
  execute "ALTER TABLE #{quote_table_name(table_name)} #{change_column_default_for_alter(table_name, column_name, default_or_changes)}"
end

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

:nodoc:



666
667
668
669
670
671
672
673
674
675
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 666

def change_column_null(table_name, column_name, null, default = nil) # :nodoc:
  validate_change_column_null_argument!(null)

  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_expression(default, column)} WHERE #{quote_column_name(column_name)} IS NULL" if column
  end
  execute "ALTER TABLE #{quote_table_name(table_name)} ALTER COLUMN #{quote_column_name(column_name)} #{null ? 'DROP' : 'SET'} NOT NULL"
end

#change_table_comment(table_name, comment_or_changes) ⇒ Object

Adds comment for given table or drops it if comment is a nil



685
686
687
688
689
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 685

def change_table_comment(table_name, comment_or_changes) # :nodoc:
  clear_cache!
  comment = extract_new_comment_value(comment_or_changes)
  execute "COMMENT ON TABLE #{quote_table_name(table_name)} IS #{quote(comment)}"
end

#check_constraints(table_name) ⇒ Object

:nodoc:



815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 815

def check_constraints(table_name) # :nodoc:
  scope = quoted_scope(table_name)

  check_info = query_all(<<-SQL)
    SELECT conname, pg_get_constraintdef(c.oid, true) AS constraintdef, c.convalidated AS valid
    FROM pg_constraint c
    JOIN pg_class t ON c.conrelid = t.oid
    JOIN pg_namespace n ON n.oid = c.connamespace
    WHERE c.contype = 'c'
      AND t.relname = #{scope[:name]}
      AND n.nspname = #{scope[:schema]}
  SQL

  check_info.map do |row|
    options = {
      name: row["conname"],
      validate: row["valid"]
    }
    expression = row["constraintdef"][/CHECK \((.+)\)/m, 1]

    CheckConstraintDefinition.new(table_name, expression, options)
  end
end

#client_min_messages ⇒ Object

Returns the current client message level.



323
324
325
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 323

def client_min_messages
  query_value("SHOW client_min_messages")
end

#client_min_messages=(level) ⇒ Object

Set the client message level.



328
329
330
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 328

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

#collation ⇒ Object

Returns the current database collation.



259
260
261
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 259

def collation
  query_value("SELECT datcollate FROM pg_database WHERE datname = current_database()")
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.



1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 1054

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

  (order_columns << super).join(", ")
end

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

Create a new PostgreSQL database. Options include :owner, :template, :encoding (defaults to utf8), :locale_provider, :locale, :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'



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 23

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

  option_string = options.each_with_object(+"") do |(key, value), memo|
    memo << case key
            when :owner
              " OWNER = \"#{value}\""
            when :template
              " TEMPLATE = \"#{value}\""
            when :encoding
              " ENCODING = '#{value}'"
            when :locale_provider
              " LOCALE_PROVIDER = '#{value}'"
            when :locale
              " LOCALE = '#{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, force: nil, if_not_exists: nil) ⇒ Object

Creates a schema for the given schema name.



280
281
282
283
284
285
286
287
288
289
290
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 280

def create_schema(schema_name, force: nil, if_not_exists: nil)
  if force && if_not_exists
    raise ArgumentError, "Options `:force` and `:if_not_exists` cannot be used simultaneously."
  end

  if force
    drop_schema(schema_name, if_exists: true)
  end

  execute("CREATE SCHEMA#{' IF NOT EXISTS' if if_not_exists} #{quote_schema_name(schema_name)}")
end

#create_schema_dumper(options) ⇒ Object

:nodoc:



1070
1071
1072
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 1070

def create_schema_dumper(options) # :nodoc:
  PostgreSQL::SchemaDumper.create(self, options)
end

#ctype ⇒ Object

Returns the current database ctype.



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

def ctype
  query_value("SELECT datctype FROM pg_database WHERE datname = current_database()")
end

#current_database ⇒ Object

Returns the current database name.



236
237
238
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 236

def current_database
  query_value("SELECT current_database()")
end

#current_schema ⇒ Object

Returns the current schema name.



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

def current_schema
  query_value("SELECT current_schema")
end

#current_schemas ⇒ Object

Returns an array of the names of all schemas presently in the effective search path, in their priority order.



247
248
249
250
251
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 247

def current_schemas # :nodoc:
  schemas = query_value("SELECT current_schemas(false)")
  decoder = PG::TextDecoder::Array.new
  decoder.decode(schemas)
end

#default_sequence_name(table_name, pk = "id") ⇒ Object

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



333
334
335
336
337
338
339
340
341
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 333

def default_sequence_name(table_name, pk = "id") # :nodoc:
  return nil if pk.is_a?(Array)

  result = serial_sequence(table_name, pk)
  return nil unless result
  Utils.extract_schema_qualified_name(result).to_s
rescue ActiveRecord::StatementInvalid
  PostgreSQL::Name.new(nil, "#{table_name}_#{pk}_seq").to_s
end

#drop_database(name) ⇒ Object

Drops a PostgreSQL database.

Example:

drop_database 'matt_development'

Note, for PostgreSQL versions >= 13 the SQL statement will include WITH (FORCE) to disconnect clients before dropping the database. This allows you to drop/reset the database without stopping the Rails server etc. See: www.postgresql.org/docs/current/sql-dropdatabase.html



63
64
65
66
67
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 63

def drop_database(name)
  statement = "DROP DATABASE IF EXISTS #{quote_table_name(name)}"
  statement += " WITH (FORCE)" if supports_force_drop_database?
  execute statement
end

#drop_schema(schema_name, **options) ⇒ Object

Drops the schema for the given schema name.



293
294
295
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 293

def drop_schema(schema_name, **options)
  execute "DROP SCHEMA#{' IF EXISTS' if options[:if_exists]} #{quote_schema_name(schema_name)} CASCADE"
end

#drop_table(*table_names, **options) ⇒ Object

:nodoc:



69
70
71
72
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 69

def drop_table(*table_names, **options) # :nodoc:
  table_names.each { |table_name| schema_cache.clear_data_source_cache!(table_name.to_s) }
  execute "DROP TABLE#{' IF EXISTS' if options[:if_exists]} #{table_names.map { |table_name| quote_table_name(table_name) }.join(', ')}#{' CASCADE' if options[:force] == :cascade}"
end

#encoding ⇒ Object

Returns the current database encoding format.



254
255
256
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 254

def encoding
  query_value("SELECT pg_encoding_to_char(encoding) FROM pg_database WHERE datname = current_database()")
end

#exclusion_constraint_options(table_name, expression, options) ⇒ Object

:nodoc:



939
940
941
942
943
944
945
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 939

def exclusion_constraint_options(table_name, expression, options) # :nodoc:
  assert_valid_deferrable(options[:deferrable])

  options = options.dup
  options[:name] ||= exclusion_constraint_name(table_name, expression: expression, **options)
  options
end

#exclusion_constraints(table_name) ⇒ Object

Returns an array of exclusion constraints for the given table. The exclusion constraints are represented as ExclusionConstraintDefinition objects.



841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 841

def exclusion_constraints(table_name)
  scope = quoted_scope(table_name)

  exclusion_info = query_all(<<-SQL)
    SELECT conname, pg_get_constraintdef(c.oid) AS constraintdef, c.condeferrable, c.condeferred
    FROM pg_constraint c
    JOIN pg_class t ON c.conrelid = t.oid
    JOIN pg_namespace n ON n.oid = c.connamespace
    WHERE c.contype = 'x'
      AND t.relname = #{scope[:name]}
      AND n.nspname = #{scope[:schema]}
  SQL

  exclusion_info.map do |row|
    method_and_elements, predicate = row["constraintdef"].split(" WHERE ")
    method_and_elements_parts = method_and_elements.match(/EXCLUDE(?: USING (?<using>\S+))? \((?<expression>.+)\)/)
    predicate.remove!(/ DEFERRABLE(?: INITIALLY (?:IMMEDIATE|DEFERRED))?/) if predicate
    predicate = predicate.from(2).to(-3) if predicate # strip 2 opening and closing parentheses

    deferrable = extract_constraint_deferrable(row["condeferrable"], row["condeferred"])

    options = {
      name: row["conname"],
      using: method_and_elements_parts["using"].to_sym,
      where: predicate,
      deferrable: deferrable
    }

    ExclusionConstraintDefinition.new(table_name, method_and_elements_parts["expression"], options)
  end
end

#foreign_key_column_for(table_name, column_name) ⇒ Object

:nodoc:



1118
1119
1120
1121
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 1118

def foreign_key_column_for(table_name, column_name) # :nodoc:
  _schema, table_name = extract_schema_qualified_name(table_name)
  super
end

#foreign_keys(table_name) ⇒ Object 



753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 753

def foreign_keys(table_name)
  scope = quoted_scope(table_name)
  fk_info = query_all(<<~SQL)
    SELECT t2.oid::regclass::text AS to_table, c.conname AS name, c.confupdtype AS on_update, c.confdeltype AS on_delete, c.convalidated AS valid, c.condeferrable AS deferrable, c.condeferred AS deferred, c.conrelid, c.confrelid,
      (
        SELECT array_agg(a.attname ORDER BY idx)
        FROM (
          SELECT idx, c.conkey[idx] AS conkey_elem
          FROM generate_subscripts(c.conkey, 1) AS idx
        ) indexed_conkeys
        JOIN pg_attribute a ON a.attrelid = t1.oid
        AND a.attnum = indexed_conkeys.conkey_elem
      ) AS conkey_names,
      (
        SELECT array_agg(a.attname ORDER BY idx)
        FROM (
          SELECT idx, c.confkey[idx] AS confkey_elem
          FROM generate_subscripts(c.confkey, 1) AS idx
        ) indexed_confkeys
        JOIN pg_attribute a ON a.attrelid = t2.oid
        AND a.attnum = indexed_confkeys.confkey_elem
      ) AS confkey_names
    FROM pg_constraint c
    JOIN pg_class t1 ON c.conrelid = t1.oid
    JOIN pg_class t2 ON c.confrelid = t2.oid
    JOIN pg_namespace n ON c.connamespace = n.oid
    WHERE c.contype = 'f'
      AND t1.relname = #{scope[:name]}
      AND n.nspname = #{scope[:schema]}
    ORDER BY c.conname
  SQL

  fk_info.map do |row|
    to_table = Utils.unquote_identifier(row["to_table"])

    column = decode_string_array(row["conkey_names"])
    primary_key = decode_string_array(row["confkey_names"])

    options = {
      column: column.size == 1 ? column.first : column,
      name: row["name"],
      primary_key: primary_key.size == 1 ? primary_key.first : primary_key
    }

    options[:on_delete] = extract_foreign_key_action(row["on_delete"])
    options[:on_update] = extract_foreign_key_action(row["on_update"])
    options[:deferrable] = extract_constraint_deferrable(row["deferrable"], row["deferred"])

    options[:validate] = row["valid"]

    ForeignKeyDefinition.new(table_name, to_table, options)
  end
end

#foreign_table_exists?(table_name) ⇒ Boolean

Returns:

  • (Boolean) 


811
812
813
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 811

def foreign_table_exists?(table_name)
  query_values(data_source_sql(table_name, type: "FOREIGN TABLE")).any? if table_name.present?
end

#foreign_tables ⇒ Object 



807
808
809
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 807

def foreign_tables
  query_values(data_source_sql(type: "FOREIGN TABLE"))
end

#index_name(table_name, options) ⇒ Object

:nodoc:



742
743
744
745
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 742

def index_name(table_name, options) # :nodoc:
  _schema, table_name = extract_schema_qualified_name(table_name.to_s)
  super
end

#index_name_exists?(table_name, index_name) ⇒ Boolean

Verifies existence of an index with a given name.

Returns:

  • (Boolean) 


80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 80

def index_name_exists?(table_name, index_name)
  table = quoted_scope(table_name)
  index = quoted_scope(index_name)

  query_value(<<~SQL).to_i > 0
    SELECT COUNT(*)
    FROM pg_class t
    INNER JOIN pg_index d ON t.oid = d.indrelid
    INNER JOIN pg_class i ON d.indexrelid = i.oid
    LEFT JOIN pg_namespace n ON n.oid = t.relnamespace
    WHERE i.relkind IN ('i', 'I')
      AND i.relname = #{index[:name]}
      AND t.relname = #{table[:name]}
      AND n.nspname = #{table[:schema]}
  SQL
end

#indexes(table_name) ⇒ Object

Returns an array of indexes for the given table.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
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
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 98

def indexes(table_name) # :nodoc:
  scope = quoted_scope(table_name)

  result = query_rows(<<~SQL)
    SELECT distinct i.relname, d.indisunique, d.indkey, pg_get_indexdef(d.indexrelid),
                    pg_catalog.obj_description(i.oid, 'pg_class') AS comment, d.indisvalid,
                    ARRAY(
                      SELECT pg_get_indexdef(d.indexrelid, k + 1, true)
                      FROM generate_subscripts(d.indkey, 1) AS k
                      ORDER BY k
                    ) AS columns
    FROM pg_class t
    INNER JOIN pg_index d ON t.oid = d.indrelid
    INNER JOIN pg_class i ON d.indexrelid = i.oid
    LEFT JOIN pg_namespace n ON n.oid = t.relnamespace
    WHERE i.relkind IN ('i', 'I')
      AND d.indisprimary = 'f'
      AND t.relname = #{scope[:name]}
      AND n.nspname = #{scope[:schema]}
    ORDER BY i.relname
  SQL

  result.map do |row|
    index_name = row[0]
    unique = row[1]
    indkey = row[2].split(" ").map(&:to_i)
    inddef = row[3]
    comment = row[4]
    valid = row[5]
    columns = decode_string_array(row[6]).map { |c| Utils.unquote_identifier(c.strip.gsub('""', '"')) }

    using, expressions, include, nulls_not_distinct, where = inddef.scan(/ USING (\w+?) \((.+?)\)(?: INCLUDE \((.+?)\))?( NULLS NOT DISTINCT)?(?: WHERE (.+))?\z/m).flatten

    orders = {}
    opclasses = {}
    include_columns = include ? include.split(",").map { |c| Utils.unquote_identifier(c.strip.gsub('""', '"')) } : []

    if indkey.include?(0)
      columns = expressions
    else
      # prevent INCLUDE columns from being matched
      columns.reject! { |c| include_columns.include?(c) }

      # add info on sort order (only desc order is explicitly specified, asc is the default)
      # and non-default opclasses
      expressions.scan(/(?<column>\w+)"?\s?(?<opclass>\w+_ops(_\w+)?)?\s?(?<desc>DESC)?\s?(?<nulls>NULLS (?:FIRST|LAST))?/).each do |column, opclass, desc, nulls|
        opclasses[column] = opclass.to_sym if opclass
        if nulls
          orders[column] = [desc, nulls].compact.join(" ")
        else
          orders[column] = :desc if desc
        end
      end
    end

    IndexDefinition.new(
      table_name,
      index_name,
      unique,
      columns,
      orders: orders,
      opclasses: opclasses,
      where: where,
      using: using.to_sym,
      include: include_columns.presence,
      nulls_not_distinct: nulls_not_distinct.present?,
      comment: comment.presence,
      valid: valid
    )
  end
end

#inherited_table_names(table_name) ⇒ Object

Returns the inherited table name of a given table



220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 220

def inherited_table_names(table_name) # :nodoc:
  scope = quoted_scope(table_name, type: "BASE TABLE")

  query_values(<<~SQL)
    SELECT parent.relname
    FROM pg_catalog.pg_inherits i
      JOIN pg_catalog.pg_class child ON i.inhrelid = child.oid
      JOIN pg_catalog.pg_class parent ON i.inhparent = parent.oid
      LEFT JOIN pg_namespace n ON n.oid = child.relnamespace
    WHERE child.relname = #{scope[:name]}
      AND child.relkind IN (#{scope[:type]})
      AND n.nspname = #{scope[:schema]}
  SQL
end

#pk_and_sequence_for(table) ⇒ Object

Returns a table’s primary key and belonging sequence.



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 531

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_rows(<<~SQL)[0]
    SELECT attr.attname, nsp.nspname, seq.relname
    FROM pg_class      seq,
         pg_attribute  attr,
         pg_depend     dep,
         pg_constraint cons,
         pg_namespace  nsp
    WHERE seq.oid           = dep.objid
      AND seq.relkind       = 'S'
      AND attr.attrelid     = dep.refobjid
      AND attr.attnum       = dep.refobjsubid
      AND attr.attrelid     = cons.conrelid
      AND attr.attnum       = cons.conkey[1]
      AND seq.relnamespace  = nsp.oid
      AND cons.contype      = 'p'
      AND dep.classid       = 'pg_class'::regclass
      AND dep.refobjid      = #{quote(quote_table_name(table))}::regclass
  SQL

  if result.nil? || result.empty?
    result = query_rows(<<~SQL)[0]
      SELECT attr.attname, nsp.nspname,
        CASE
          WHEN pg_get_expr(def.adbin, def.adrelid) !~* 'nextval' THEN NULL
          WHEN split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2) ~ '.' THEN
            substr(split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2),
                   strpos(split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2), '.')+1)
          ELSE split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2)
        END
      FROM pg_class       t
      JOIN pg_attribute   attr ON (t.oid = attrelid)
      JOIN pg_attrdef     def  ON (adrelid = attrelid AND adnum = attnum)
      JOIN pg_constraint  cons ON (conrelid = adrelid AND adnum = conkey[1])
      JOIN pg_namespace   nsp  ON (t.relnamespace = nsp.oid)
      WHERE t.oid = #{quote(quote_table_name(table))}::regclass
        AND cons.contype = 'p'
        AND pg_get_expr(def.adbin, def.adrelid) ~* 'nextval|uuid_generate|gen_random_uuid'
    SQL
  end

  pk = result.shift
  if result.last
    [pk, PostgreSQL::Name.new(*result)]
  else
    [pk, nil]
  end
rescue
  nil
end

#primary_keys(table_name) ⇒ Object

:nodoc:



584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 584

def primary_keys(table_name) # :nodoc:
  query_values(<<~SQL)
    SELECT a.attname
    FROM pg_index i
    JOIN pg_attribute a
      ON a.attrelid = i.indrelid
      AND a.attnum = ANY(i.indkey)
    WHERE i.indrelid = #{quote(quote_table_name(table_name))}::regclass
      AND i.indisprimary
    ORDER BY array_position(i.indkey, a.attnum)
  SQL
end

#quoted_include_columns_for_index(column_names) ⇒ Object

:nodoc:



1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 1130

def quoted_include_columns_for_index(column_names) # :nodoc:
  return quote_column_name(column_names) if column_names.is_a?(Symbol)

  quoted_columns = column_names.each_with_object({}) do |name, result|
    result[name.to_sym] = quote_column_name(name).dup
  end
  add_options_for_index_columns(quoted_columns).values.join(", ")
end

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

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



9
10
11
12
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 9

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

#remove_exclusion_constraint(table_name, expression = nil, **options) ⇒ Object

Removes the given exclusion constraint from the table.

remove_exclusion_constraint :products, name: "price_check"

The expression parameter will be ignored if present. It can be helpful to provide this in a migration’s change method so it can be reverted. In that case, expression will be used by #add_exclusion_constraint.



954
955
956
957
958
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 954

def remove_exclusion_constraint(table_name, expression = nil, **options)
  excl_name_to_delete = exclusion_constraint_for!(table_name, expression: expression, **options).name

  remove_constraint(table_name, excl_name_to_delete)
end

#remove_index(table_name, column_name = nil, **options) ⇒ Object

:nodoc:



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 712

def remove_index(table_name, column_name = nil, **options) # :nodoc:
  table = Utils.extract_schema_qualified_name(table_name.to_s)

  if options.key?(:name)
    provided_index = Utils.extract_schema_qualified_name(options[:name].to_s)

    options[:name] = provided_index.identifier
    table = PostgreSQL::Name.new(provided_index.schema, table.identifier) unless table.schema.present?

    if provided_index.schema.present? && table.schema != provided_index.schema
      raise ArgumentError.new("Index schema '#{provided_index.schema}' does not match table schema '#{table.schema}'")
    end
  end

  return if options[:if_exists] && !index_exists?(table_name, column_name, **options)

  index_to_remove = PostgreSQL::Name.new(table.schema, index_name_for_remove(table.to_s, column_name, options))

  execute "DROP INDEX #{index_algorithm(options[:algorithm])} #{quote_table_name(index_to_remove)}"
end

#remove_unique_constraint(table_name, column_name = nil, **options) ⇒ Object

Removes the given unique constraint from the table.

remove_unique_constraint :sections, name: "unique_position"

The column_name parameter will be ignored if present. It can be helpful to provide this in a migration’s change method so it can be reverted. In that case, column_name will be used by #add_unique_constraint.



1009
1010
1011
1012
1013
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 1009

def remove_unique_constraint(table_name, column_name = nil, **options)
  unique_name_to_delete = unique_constraint_for!(table_name, column: column_name, **options).name

  remove_constraint(table_name, unique_name_to_delete)
end

#rename_column(table_name, column_name, new_column_name) ⇒ Object

Renames a column in a table.



692
693
694
695
696
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 692

def rename_column(table_name, column_name, new_column_name) # :nodoc:
  clear_cache!
  execute("ALTER TABLE #{quote_table_name(table_name)} #{rename_column_sql(table_name, 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

Renames an index of a table. Raises error if length of new index name is greater than allowed limit.



735
736
737
738
739
740
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 735

def rename_index(table_name, old_name, new_name)
  validate_index_length!(table_name, new_name)

  schema, = extract_schema_qualified_name(table_name)
  execute "ALTER INDEX #{quote_table_name(schema) + '.' if schema}#{quote_column_name(old_name)} RENAME TO #{quote_table_name(new_name)}"
end

#rename_schema(schema_name, new_name) ⇒ Object

Renames the schema for the given schema name.



298
299
300
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 298

def rename_schema(schema_name, new_name)
  execute "ALTER SCHEMA #{quote_schema_name(schema_name)} RENAME TO #{quote_schema_name(new_name)}"
end

#rename_table(table_name, new_name, **options) ⇒ Object

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

Example:

rename_table('octopuses', 'octopi')



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 603

def rename_table(table_name, new_name, **options)
  validate_table_length!(new_name) unless options[:_uses_legacy_table_name]
  clear_cache!
  schema_cache.clear_data_source_cache!(table_name.to_s)
  schema_cache.clear_data_source_cache!(new_name.to_s)
  execute "ALTER TABLE #{quote_table_name(table_name)} RENAME TO #{quote_table_name(new_name)}"
  pk, seq = pk_and_sequence_for(new_name)
  if pk
    # PostgreSQL automatically creates an index for PRIMARY KEY with name consisting of
    # truncated table name and "_pkey" suffix fitting into max_identifier_length number of characters.
    max_pkey_prefix = max_identifier_length - "_pkey".size
    idx = "#{table_name[0, max_pkey_prefix]}_pkey"
    new_idx = "#{new_name[0, max_pkey_prefix]}_pkey"
    execute "ALTER INDEX #{quote_table_name(idx)} RENAME TO #{quote_table_name(new_idx)}"

    # PostgreSQL automatically creates a sequence for PRIMARY KEY with name consisting of
    # truncated table name and "#{primary_key}_seq" suffix fitting into max_identifier_length number of characters.
    max_seq_prefix = max_identifier_length - "_#{pk}_seq".size
    if seq && seq.identifier == "#{table_name[0, max_seq_prefix]}_#{pk}_seq"
      new_seq = "#{new_name[0, max_seq_prefix]}_#{pk}_seq"
      execute "ALTER TABLE #{seq.quoted} RENAME TO #{quote_table_name(new_seq)}"
    end
  end
  rename_table_indexes(table_name, new_name, **options)
end

#reset_column_sequences!(tables) ⇒ Object

Batch resets column sequences. Passed in the shape of [[table, column, sequence, max_column_value, min_column_value]]. Reduces query round trips for sequence resets when there are a large amount of tables.



526
527
528
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 526

def reset_column_sequences!(tables) # :nodoc:
  SequenceReset.new(self, tables).reset
end

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

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



520
521
522
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 520

def reset_pk_sequence!(table, pk = nil, sequence = nil) # :nodoc:
  SequenceReset.new(self, table => [pk, sequence]).reset
end

#schema_creation ⇒ Object

:nodoc:



1139
1140
1141
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 1139

def schema_creation  # :nodoc:
  PostgreSQL::SchemaCreation.new(self)
end

#schema_exists?(name) ⇒ Boolean

Returns true if schema exists.

Returns:

  • (Boolean) 


75
76
77
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 75

def schema_exists?(name)
  query_value("SELECT COUNT(*) FROM pg_namespace WHERE nspname = #{quote(name)}").to_i > 0
end

#schema_names ⇒ Object

Returns an array of schema names.



269
270
271
272
273
274
275
276
277
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 269

def schema_names
  query_values(<<~SQL)
    SELECT nspname
      FROM pg_namespace
     WHERE nspname !~ '^pg_.*'
       AND nspname NOT IN ('information_schema')
     ORDER by nspname;
  SQL
end

#schema_search_path ⇒ Object

Returns the active schema search path.



316
317
318
319
320
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 316

def schema_search_path
  @schema_search_path ||=
    with_raw_connection { |conn| conn.parameter_status("search_path") } ||
    query_value("SHOW search_path")
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.



307
308
309
310
311
312
313
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 307

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

#serial_sequence(table, column) ⇒ Object 



343
344
345
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 343

def serial_sequence(table, column)
  query_value("SELECT pg_get_serial_sequence(#{quote(table)}, #{quote(column)})")
end

#set_pk_sequence!(table, value) ⇒ Object

Sets the sequence of a table’s primary key to the specified value.



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 348

def set_pk_sequence!(table, value) # :nodoc:
  pk, sequence = pk_and_sequence_for(table)

  if pk
    if sequence
      quoted_sequence = quote_table_name(sequence)

      query_command("SELECT setval(#{quote(quoted_sequence)}, #{value})")
    else
      @logger.warn "#{table} has primary key #{pk} with no default sequence." if @logger
    end
  end
end

#table_comment(table_name) ⇒ Object

Returns a comment stored in database for given table



191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 191

def table_comment(table_name) # :nodoc:
  scope = quoted_scope(table_name, type: "BASE TABLE")
  if scope[:name]
    query_value(<<~SQL)
      SELECT pg_catalog.obj_description(c.oid, 'pg_class')
      FROM pg_catalog.pg_class c
        LEFT JOIN pg_namespace n ON n.oid = c.relnamespace
      WHERE c.relname = #{scope[:name]}
        AND c.relkind IN (#{scope[:type]})
        AND n.nspname = #{scope[:schema]}
    SQL
  end
end

#table_options(table_name) ⇒ Object

:nodoc:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 170

def table_options(table_name) # :nodoc:
  options = {}

  comment = table_comment(table_name)

  options[:comment] = comment if comment

  inherited_table_names = inherited_table_names(table_name).presence

  options[:options] = "INHERITS (#{inherited_table_names.join(", ")})" if inherited_table_names

  if !options[:options] && supports_native_partitioning?
    partition_definition = table_partition_definition(table_name)

    options[:options] = "PARTITION BY #{partition_definition}" if partition_definition
  end

  options
end

#table_partition_definition(table_name) ⇒ Object

Returns the partition definition of a given table



206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 206

def table_partition_definition(table_name) # :nodoc:
  scope = quoted_scope(table_name, type: "BASE TABLE")

  query_value(<<~SQL)
    SELECT pg_catalog.pg_get_partkeydef(c.oid)
    FROM pg_catalog.pg_class c
      LEFT JOIN pg_namespace n ON n.oid = c.relnamespace
    WHERE c.relname = #{scope[:name]}
      AND c.relkind IN (#{scope[:type]})
      AND n.nspname = #{scope[:schema]}
  SQL
end

#type_to_sql(type, limit: nil, precision: nil, scale: nil, array: nil, enum_type: nil) ⇒ Object

Maps logical Rails types to PostgreSQL-specific data types.



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 1016

def type_to_sql(type, limit: nil, precision: nil, scale: nil, array: nil, enum_type: nil, **) # :nodoc:
  sql = \
    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 ArgumentError, "No binary type has byte size #{limit}. The limit on binary can be at most 1GB - 1byte."
      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 ArgumentError, "No text type has byte size #{limit}. The limit on text can be at most 1GB - 1byte."
      end
    when "integer"
      case limit
      when 1, 2; "smallint"
      when nil, 3, 4; "integer"
      when 5..8; "bigint"
      else raise ArgumentError, "No integer type has byte size #{limit}. Use a numeric with scale 0 instead."
      end
    when "enum"
      raise ArgumentError, "enum_type is required for enums" if enum_type.nil?

      enum_type
    else
      super
    end

  sql = "#{sql}[]" if array && type != :primary_key
  sql
end

#unique_constraint_options(table_name, column_name, options) ⇒ Object

:nodoc:



990
991
992
993
994
995
996
997
998
999
1000
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 990

def unique_constraint_options(table_name, column_name, options) # :nodoc:
  assert_valid_deferrable(options[:deferrable])

  if column_name && options[:using_index]
    raise ArgumentError, "Cannot specify both column_name and :using_index options."
  end

  options = options.dup
  options[:name] ||= unique_constraint_name(table_name, column: column_name, **options)
  options
end

#unique_constraints(table_name) ⇒ Object

Returns an array of unique constraints for the given table. The unique constraints are represented as UniqueConstraintDefinition objects.



875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 875

def unique_constraints(table_name)
  scope = quoted_scope(table_name)

  unique_info = query_all(<<~SQL)
    SELECT c.conname, c.conrelid, c.condeferrable, c.condeferred, pg_get_constraintdef(c.oid) AS constraintdef,
    (
      SELECT array_agg(a.attname ORDER BY idx)
      FROM (
        SELECT idx, c.conkey[idx] AS conkey_elem
        FROM generate_subscripts(c.conkey, 1) AS idx
      ) indexed_conkeys
      JOIN pg_attribute a ON a.attrelid = t.oid
      AND a.attnum = indexed_conkeys.conkey_elem
    ) AS conkey_names
    FROM pg_constraint c
    JOIN pg_class t ON c.conrelid = t.oid
    JOIN pg_namespace n ON n.oid = c.connamespace
    WHERE c.contype = 'u'
      AND t.relname = #{scope[:name]}
      AND n.nspname = #{scope[:schema]}
  SQL

  unique_info.map do |row|
    columns = decode_string_array(row["conkey_names"])

    nulls_not_distinct = row["constraintdef"].start_with?("UNIQUE NULLS NOT DISTINCT")
    deferrable = extract_constraint_deferrable(row["condeferrable"], row["condeferred"])

    options = {
      name: row["conname"],
      nulls_not_distinct: nulls_not_distinct,
      deferrable: deferrable
    }

    UniqueConstraintDefinition.new(table_name, columns, options)
  end
end

#update_table_definition(table_name, base) ⇒ Object

:nodoc:



1066
1067
1068
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 1066

def update_table_definition(table_name, base) # :nodoc:
  PostgreSQL::Table.new(table_name, base)
end

#validate_check_constraint(table_name, **options) ⇒ Object

Validates the given check constraint.

validate_check_constraint :products, name: "price_check"

The options hash accepts the same keys as add_check_constraint.



1112
1113
1114
1115
1116
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 1112

def validate_check_constraint(table_name, **options)
  chk_name_to_validate = check_constraint_for!(table_name, **options).name

  validate_constraint table_name, chk_name_to_validate
end

#validate_constraint(table_name, constraint_name) ⇒ Object

Validates the given constraint.

Validates the constraint named constraint_name on accounts.

validate_constraint :accounts, :constraint_name



1079
1080
1081
1082
1083
1084
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 1079

def validate_constraint(table_name, constraint_name)
  at = create_alter_table table_name
  at.validate_constraint constraint_name

  execute schema_creation.accept(at)
end

#validate_foreign_key(from_table, to_table = nil, **options) ⇒ Object

Validates the given foreign key.

Validates the foreign key on accounts.branch_id.

validate_foreign_key :accounts, :branches

Validates the foreign key on accounts.owner_id.

validate_foreign_key :accounts, column: :owner_id

Validates the foreign key named special_fk_name on the accounts table.

validate_foreign_key :accounts, name: :special_fk_name

The options hash accepts the same keys as SchemaStatements#add_foreign_key.



1101
1102
1103
1104
1105
 
# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb', line 1101

def validate_foreign_key(from_table, to_table = nil, **options)
  fk_name_to_validate = foreign_key_for!(from_table, to_table: to_table, **options).name

  validate_constraint from_table, fk_name_to_validate
end