module ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaStatements

Public Instance Methods

bulk_change_table(table_name, operations) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 370
def bulk_change_table(table_name, operations)
  sql_fragments = []
  non_combinable_operations = []

  operations.each do |command, args|
    table, arguments = args.shift, args
    method = :"#{command}_for_alter"

    if respond_to?(method, true)
      sqls, procs = Array(send(method, table, *arguments)).partition { |v| v.is_a?(String) }
      sql_fragments << sqls
      non_combinable_operations.concat(procs)
    else
      execute "ALTER TABLE #{quote_table_name(table_name)} #{sql_fragments.join(", ")}" unless sql_fragments.empty?
      non_combinable_operations.each(&:call)
      sql_fragments = []
      non_combinable_operations = []
      send(command, table, *arguments)
    end
  end

  execute "ALTER TABLE #{quote_table_name(table_name)} #{sql_fragments.join(", ")}" unless sql_fragments.empty?
  non_combinable_operations.each(&:call)
end
client_min_messages() click to toggle source

Returns the current client message level.

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 235
def client_min_messages
  query_value("SHOW client_min_messages", "SCHEMA")
end
client_min_messages=(level) click to toggle source

Set the client message level.

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 240
def client_min_messages=(level)
  execute("SET client_min_messages TO '#{level}'", "SCHEMA")
end
collation() click to toggle source

Returns the current database collation.

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 187
def collation
  query_value("SELECT datcollate FROM pg_database WHERE datname = current_database()", "SCHEMA")
end
create_database(name, options = {}) click to toggle source

Create a new PostgreSQL database. Options include :owner, :template, :encoding (defaults to utf8), :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'
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 21
def create_database(name, options = {})
  options = { encoding: "utf8" }.merge!(options.symbolize_keys)

  option_string = options.inject("") do |memo, (key, value)|
    memo += 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) click to toggle source

Creates a schema for the given schema name.

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 208
def create_schema(schema_name)
  execute "CREATE SCHEMA #{quote_schema_name(schema_name)}"
end
ctype() click to toggle source

Returns the current database ctype.

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 192
def ctype
  query_value("SELECT datctype FROM pg_database WHERE datname = current_database()", "SCHEMA")
end
current_database() click to toggle source

Returns the current database name.

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 172
def current_database
  query_value("SELECT current_database()", "SCHEMA")
end
current_schema() click to toggle source

Returns the current schema name.

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 177
def current_schema
  query_value("SELECT current_schema", "SCHEMA")
end
drop_schema(schema_name, options = {}) click to toggle source

Drops the schema for the given schema name.

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 213
def drop_schema(schema_name, options = {})
  execute "DROP SCHEMA#{' IF EXISTS' if options[:if_exists]} #{quote_schema_name(schema_name)} CASCADE"
end
encoding() click to toggle source

Returns the current database encoding format.

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 182
def encoding
  query_value("SELECT pg_encoding_to_char(encoding) FROM pg_database WHERE datname = current_database()", "SCHEMA")
end
foreign_keys(table_name) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 502
        def foreign_keys(table_name)
          scope = quoted_scope(table_name)
          fk_info = exec_query(<<-SQL.strip_heredoc, "SCHEMA")
            SELECT t2.oid::regclass::text AS to_table, a1.attname AS column, a2.attname AS primary_key, c.conname AS name, c.confupdtype AS on_update, c.confdeltype AS on_delete, c.convalidated AS valid
            FROM pg_constraint c
            JOIN pg_class t1 ON c.conrelid = t1.oid
            JOIN pg_class t2 ON c.confrelid = t2.oid
            JOIN pg_attribute a1 ON a1.attnum = c.conkey[1] AND a1.attrelid = t1.oid
            JOIN pg_attribute a2 ON a2.attnum = c.confkey[1] AND a2.attrelid = t2.oid
            JOIN pg_namespace t3 ON c.connamespace = t3.oid
            WHERE c.contype = 'f'
              AND t1.relname = #{scope[:name]}
              AND t3.nspname = #{scope[:schema]}
            ORDER BY c.conname
          SQL

          fk_info.map do |row|
            options = {
              column: row["column"],
              name: row["name"],
              primary_key: row["primary_key"]
            }

            options[:on_delete] = extract_foreign_key_action(row["on_delete"])
            options[:on_update] = extract_foreign_key_action(row["on_update"])
            options[:validate] = row["valid"]

            ForeignKeyDefinition.new(table_name, row["to_table"], options)
          end
        end
foreign_table_exists?(table_name) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 537
def foreign_table_exists?(table_name)
  query_values(data_source_sql(table_name, type: "FOREIGN TABLE"), "SCHEMA").any? if table_name.present?
end
foreign_tables() click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 533
def foreign_tables
  query_values(data_source_sql(type: "FOREIGN TABLE"), "SCHEMA")
end
index_name_exists?(table_name, index_name) click to toggle source

Verifies existence of an index with a given name.

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 66
        def index_name_exists?(table_name, index_name)
          table = quoted_scope(table_name)
          index = quoted_scope(index_name)

          query_value(<<-SQL, "SCHEMA").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 = i.relnamespace
            WHERE i.relkind = 'i'
              AND i.relname = #{index[:name]}
              AND t.relname = #{table[:name]}
              AND n.nspname = #{index[:schema]}
          SQL
        end
rename_index(table_name, old_name, new_name) click to toggle source

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

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 496
def rename_index(table_name, old_name, new_name)
  validate_index_length!(table_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) click to toggle source

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')
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 401
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 pk
    idx = "#{table_name}_pkey"
    new_idx = "#{new_name}_pkey"
    execute "ALTER INDEX #{quote_table_name(idx)} RENAME TO #{quote_table_name(new_idx)}"
    if seq && seq.identifier == "#{table_name}_#{pk}_seq"
      new_seq = "#{new_name}_#{pk}_seq"
      execute "ALTER TABLE #{seq.quoted} RENAME TO #{quote_table_name(new_seq)}"
    end
  end
  rename_table_indexes(table_name, new_name)
end
schema_exists?(name) click to toggle source

Returns true if schema exists.

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 61
def schema_exists?(name)
  query_value("SELECT COUNT(*) FROM pg_namespace WHERE nspname = #{quote(name)}", "SCHEMA").to_i > 0
end
schema_names() click to toggle source

Returns an array of schema names.

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 197
        def schema_names
          query_values(<<-SQL, "SCHEMA")
            SELECT nspname
              FROM pg_namespace
             WHERE nspname !~ '^pg_.*'
               AND nspname NOT IN ('information_schema')
             ORDER by nspname;
          SQL
        end
schema_search_path() click to toggle source

Returns the active schema search path.

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 230
def schema_search_path
  @schema_search_path ||= query_value("SHOW search_path", "SCHEMA")
end
schema_search_path=(schema_csv) click to toggle source

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.

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 222
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) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 253
def serial_sequence(table, column)
  query_value("SELECT pg_get_serial_sequence(#{quote(table)}, #{quote(column)})", "SCHEMA")
end
validate_constraint(table_name, constraint_name) click to toggle source

Validates the given constraint.

Validates the constraint named constraint_name on accounts.

validate_constraint :accounts, :constraint_name
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 601
def validate_constraint(table_name, constraint_name)
  return unless supports_validate_constraints?

  at = create_alter_table table_name
  at.validate_constraint constraint_name

  execute schema_creation.accept(at)
end
validate_foreign_key(from_table, options_or_to_table = {}) click to toggle source

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.

# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 625
def validate_foreign_key(from_table, options_or_to_table = {})
  return unless supports_validate_constraints?

  fk_name_to_validate = foreign_key_for!(from_table, options_or_to_table).name

  validate_constraint from_table, fk_name_to_validate
end

Private Instance Methods

add_index_opclass(quoted_columns, **options) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 739
def add_index_opclass(quoted_columns, **options)
  opclasses = options_for_index_columns(options[:opclass])
  quoted_columns.each do |name, column|
    column << " #{opclasses[name]}" if opclasses[name].present?
  end
end
add_options_for_index_columns(quoted_columns, **options) click to toggle source
Calls superclass method
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 746
def add_options_for_index_columns(quoted_columns, **options)
  quoted_columns = add_index_opclass(quoted_columns, options)
  super
end
add_timestamps_for_alter(table_name, options = {}) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 731
def add_timestamps_for_alter(table_name, options = {})
  [add_column_for_alter(table_name, :created_at, :datetime, options), add_column_for_alter(table_name, :updated_at, :datetime, options)]
end
change_column_for_alter(table_name, column_name, type, options = {}) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 702
def change_column_for_alter(table_name, column_name, type, options = {})
  sqls = [change_column_sql(table_name, column_name, type, options)]
  sqls << change_column_default_for_alter(table_name, column_name, options[:default]) if options.key?(:default)
  sqls << change_column_null_for_alter(table_name, column_name, options[:null], options[:default]) if options.key?(:null)
  sqls << Proc.new { change_column_comment(table_name, column_name, options[:comment]) } if options.key?(:comment)
  sqls
end
change_column_sql(table_name, column_name, type, options = {}) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 685
def change_column_sql(table_name, column_name, type, options = {})
  quoted_column_name = quote_column_name(column_name)
  sql_type = type_to_sql(type, options)
  sql = "ALTER COLUMN #{quoted_column_name} TYPE #{sql_type}".dup
  if options[:collation]
    sql << " COLLATE \"#{options[:collation]}\""
  end
  if options[:using]
    sql << " USING #{options[:using]}"
  elsif options[:cast_as]
    cast_as_type = type_to_sql(options[:cast_as], options)
    sql << " USING CAST(#{quoted_column_name} AS #{cast_as_type})"
  end

  sql
end
create_alter_table(name) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 642
def create_alter_table(name)
  PostgreSQL::AlterTable.new create_table_definition(name)
end
create_table_definition(*args) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 638
def create_table_definition(*args)
  PostgreSQL::TableDefinition.new(*args)
end
data_source_sql(name = nil, type: nil) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 751
def data_source_sql(name = nil, type: nil)
  scope = quoted_scope(name, type: type)
  scope[:type] ||= "'r','v','m','p','f'" # (r)elation/table, (v)iew, (m)aterialized view, (p)artitioned table, (f)oreign table

  sql = "SELECT c.relname FROM pg_class c LEFT JOIN pg_namespace n ON n.oid = c.relnamespace".dup
  sql << " WHERE n.nspname = #{scope[:schema]}"
  sql << " AND c.relname = #{scope[:name]}" if scope[:name]
  sql << " AND c.relkind IN (#{scope[:type]})"
  sql
end
extract_foreign_key_action(specifier) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 677
def extract_foreign_key_action(specifier)
  case specifier
  when "c"; :cascade
  when "n"; :nullify
  when "r"; :restrict
  end
end
extract_schema_qualified_name(string) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 780
def extract_schema_qualified_name(string)
  name = Utils.extract_schema_qualified_name(string.to_s)
  [name.schema, name.identifier]
end
fetch_type_metadata(column_name, sql_type, oid, fmod) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 665
def fetch_type_metadata(column_name, sql_type, oid, fmod)
  cast_type = get_oid_type(oid, fmod, column_name, sql_type)
  simple_type = SqlTypeMetadata.new(
    sql_type: sql_type,
    type: cast_type.type,
    limit: cast_type.limit,
    precision: cast_type.precision,
    scale: cast_type.scale,
  )
  PostgreSQLTypeMetadata.new(simple_type, oid: oid, fmod: fmod)
end
new_column_from_field(table_name, field) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 646
def new_column_from_field(table_name, field)
  column_name, type, default, notnull, oid, fmod, collation, comment = field
  type_metadata = fetch_type_metadata(column_name, type, oid.to_i, fmod.to_i)
  default_value = extract_value_from_default(default)
  default_function = extract_default_function(default_value, default)

  PostgreSQLColumn.new(
    column_name,
    default_value,
    type_metadata,
    !notnull,
    table_name,
    default_function,
    collation,
    comment: comment.presence,
    max_identifier_length: max_identifier_length
  )
end
quoted_scope(name = nil, type: nil) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 762
def quoted_scope(name = nil, type: nil)
  schema, name = extract_schema_qualified_name(name)
  type = \
    case type
    when "BASE TABLE"
      "'r','p'"
    when "VIEW"
      "'v','m'"
    when "FOREIGN TABLE"
      "'f'"
    end
  scope = {}
  scope[:schema] = schema ? quote(schema) : "ANY (current_schemas(false))"
  scope[:name] = quote(name) if name
  scope[:type] = type if type
  scope
end
remove_timestamps_for_alter(table_name, options = {}) click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 735
def remove_timestamps_for_alter(table_name, options = {})
  [remove_column_for_alter(table_name, :updated_at), remove_column_for_alter(table_name, :created_at)]
end
schema_creation() click to toggle source
# File lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 634
def schema_creation
  PostgreSQL::SchemaCreation.new(self)
end