module ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaStatements
Открытые методы экземпляра
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 782 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
Добавляет в таблицу новое ограничение-исключение. expression — это представление в виде String списка элементов исключения и операторов.
add_exclusion_constraint :products, "price WITH =, availability_range WITH &&", using: :gist, name: "price_check"
генерирует:
ALTER TABLE "products" ADD CONSTRAINT price_check EXCLUDE USING gist (price WITH =, availability_range WITH &&)
Хеш options может содержать следующие ключи:
:name-
Имя ограничения. По умолчанию —
excl_rails_<identifier>. :deferrable-
Указывает, должно ли ограничение-исключение быть отложенным. Допустимые значения:
false,:immediateили:deferredдля указания поведения по умолчанию. По умолчанию —false. :using-
Указывает, какой метод индекса следует использовать при создании этого ограничения-исключения (например,
:btree,:gistи т. д.). :where-
Задает ограничение-исключение для подмножества таблицы (внутри PostgreSQL для этого создается частичный индекс).
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 598 def add_foreign_key(from_table, to_table, **options) assert_valid_deferrable(options[:deferrable]) super end
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 833 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
Добавляет в таблицу новое ограничение уникальности.
add_unique_constraint :sections, [:position], deferrable: :deferred, name: "unique_position", nulls_not_distinct: true
генерирует:
ALTER TABLE "sections" ADD CONSTRAINT unique_position UNIQUE (position) DEFERRABLE INITIALLY DEFERRED
Чтобы изменить существующий уникальный индекс и сделать его отложенным, можно использовать :using_index для создания отложенных ограничений уникальности.
add_unique_constraint :sections, deferrable: :deferred, name: "unique_position", using_index: "index_sections_on_position"
Хеш options может содержать следующие ключи:
:name-
Имя ограничения. По умолчанию —
uniq_rails_<identifier>. :deferrable-
Указывает, должно ли ограничение уникальности быть отложенным. Допустимые значения:
false,:immediateили:deferredдля указания поведения по умолчанию. По умолчанию —false. :using_index-
Указывает имя существующего уникального индекса. По умолчанию —
nil. :nulls_not_distinct-
Создает ограничение уникальности, при котором значения NULL считаются равными. Примечание: поддерживается только в PostgreSQL версии 15.0.0 и выше.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 314
def client_min_messages
query_value("SHOW client_min_messages", "SCHEMA")
end Возвращает текущий уровень сообщений клиента.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 319
def client_min_messages=(level)
internal_execute("SET client_min_messages TO '#{level}'", "SCHEMA")
end Задает уровень сообщений клиента.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 252
def collation
query_value("SELECT datcollate FROM pg_database WHERE datname = current_database()", "SCHEMA")
end Возвращает текущую сортировку базы данных.
# 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 Создает новую базу данных PostgreSQL. Доступны параметры :owner, :template, :encoding (по умолчанию — utf8), :locale_provider, :locale, :collation, :ctype, :tablespace и :connection_limit (обратите внимание: MySQL использует :charset, а PostgreSQL — :encoding).
Пример:
create_database config[:database], config create_database 'foo_development', encoding: 'unicode'
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 273
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 Создает схему с указанным именем.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 257
def ctype
query_value("SELECT datctype FROM pg_database WHERE datname = current_database()", "SCHEMA")
end Возвращает текущий ctype базы данных.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 229
def current_database
query_value("SELECT current_database()", "SCHEMA")
end Возвращает имя текущей базы данных.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 234
def current_schema
query_value("SELECT current_schema", "SCHEMA")
end Возвращает имя текущей схемы.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 286
def drop_schema(schema_name, **options)
execute "DROP SCHEMA#{' IF EXISTS' if options[:if_exists]} #{quote_schema_name(schema_name)} CASCADE"
end Удаляет схему с указанным именем.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 247
def encoding
query_value("SELECT pg_encoding_to_char(encoding) FROM pg_database WHERE datname = current_database()", "SCHEMA")
end Возвращает текущую кодировку базы данных.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 692
def exclusion_constraints(table_name)
scope = quoted_scope(table_name)
exclusion_info = internal_exec_query(<<-SQL, "SCHEMA")
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 Возвращает массив ограничений-исключений для указанной таблицы. Ограничения-исключения представлены объектами ExclusionConstraintDefinition.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 604
def foreign_keys(table_name)
scope = quoted_scope(table_name)
fk_info = internal_exec_query(<<~SQL, "SCHEMA", allow_retry: true, materialize_transactions: false)
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 # File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 662 def foreign_table_exists?(table_name) query_values(data_source_sql(table_name, type: "FOREIGN TABLE"), "SCHEMA").any? if table_name.present? end
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 658 def foreign_tables query_values(data_source_sql(type: "FOREIGN TABLE"), "SCHEMA") end
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 73
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 = 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 Проверяет, существует ли индекс с указанным именем.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 805 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_exclusion_constraint :products, name: "price_check"
Параметр expression будет проигнорирован, если он указан. Его полезно передавать в методе change миграции, чтобы ее можно было отменить. В этом случае метод add_exclusion_constraint использует expression.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 860 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
Удаляет указанное ограничение уникальности из таблицы.
remove_unique_constraint :sections, name: "unique_position"
Параметр column_name будет проигнорирован, если он указан. Его полезно передавать в методе change миграции, чтобы ее можно было отменить. В этом случае метод add_unique_constraint использует column_name.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 586
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 Переименовывает индекс таблицы. Вызывает ошибку, если длина нового имени индекса превышает допустимый предел.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 291
def rename_schema(schema_name, new_name)
execute "ALTER SCHEMA #{quote_schema_name(schema_name)} RENAME TO #{quote_schema_name(new_name)}"
end Переименовывает схему с указанным именем.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 454
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 Переименовывает таблицу. Также переименовывает последовательность первичного ключа таблицы, если такая последовательность существует и ее имя соответствует имени по умолчанию в Active Record.
Пример:
rename_table('octopuses', 'octopi')
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 68
def schema_exists?(name)
query_value("SELECT COUNT(*) FROM pg_namespace WHERE nspname = #{quote(name)}", "SCHEMA").to_i > 0
end Возвращает true, если схема существует.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 262
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 Возвращает массив имен схем.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 309
def schema_search_path
@schema_search_path ||= query_value("SHOW search_path", "SCHEMA")
end Возвращает активный путь поиска схем.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 300
def schema_search_path=(schema_csv)
return if schema_csv == @schema_search_path
if schema_csv
internal_execute("SET search_path TO #{schema_csv}")
@schema_search_path = schema_csv
end
end Задает путь поиска схем в виде строки с именами схем, разделенными запятыми. Имена, начинающиеся с $, необходимо заключать в кавычки (например, $user => ‘$user’). См. www.postgresql.org/docs/current/static/ddl-schemas.html
Этот параметр не следует задавать вручную; укажите его в database.yml.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 334
def serial_sequence(table, column)
query_value("SELECT pg_get_serial_sequence(#{quote(table)}, #{quote(column)})", "SCHEMA")
end # File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 726
def unique_constraints(table_name)
scope = quoted_scope(table_name)
unique_info = internal_exec_query(<<~SQL, "SCHEMA", allow_retry: true, materialize_transactions: false)
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 Возвращает массив ограничений уникальности для указанной таблицы. Ограничения уникальности представлены объектами UniqueConstraintDefinition.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 963 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
Проверяет указанное ограничение CHECK.
validate_check_constraint :products, name: "price_check"
Хеш options принимает те же ключи, что и add_check_constraint.
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 930 def validate_constraint(table_name, constraint_name) at = create_alter_table table_name at.validate_constraint constraint_name execute schema_creation.accept(at) end
Проверяет указанное ограничение.
Проверяет ограничение с именем constraint_name в accounts.
validate_constraint :accounts, :constraint_name
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 952 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
Проверяет указанный внешний ключ.
Проверяет внешний ключ в accounts.branch_id.
validate_foreign_key :accounts, :branches
Проверяет внешний ключ в accounts.owner_id.
validate_foreign_key :accounts, column: :owner_id
Проверяет внешний ключ с именем special_fk_name в таблице accounts.
validate_foreign_key :accounts, name: :special_fk_name
Хеш options принимает те же ключи, что и SchemaStatements#add_foreign_key.
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.