класс ActiveRecord::ConnectionAdapters::PostgreSQLAdapter

Родитель:: ActiveRecord::ConnectionAdapters::AbstractAdapter
Включенные модули:: ActiveRecord::ConnectionAdapters::PostgreSQL::Quoting, ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaStatements, ActiveRecord::ConnectionAdapters::PostgreSQL::DatabaseStatements

Адаптер Active Record для PostgreSQL

Адаптер PostgreSQL работает с родным C-драйвером (github.com/ged/ruby-pg).

Параметры:

:host - По умолчанию используется сокет Unix-домена в /tmp. На машинах без сокетов Unix-домена по умолчанию используется подключение к localhost.
:port - По умолчанию 5432.
:username - По умолчанию совпадает с именем операционной системы пользователя, запускающего приложение.
:password - Пароль, который используется, если сервер требует аутентификацию по паролю.
:database - По умолчанию совпадает с именем пользователя.
:schema_search_path - Необязательный путь поиска схемы для подключения, заданный как строка с именами схем, разделенными запятыми. Обратно совместимо с параметром :schema_order.
:encoding - Необязательное кодирование клиента, используемое в вызове SET client_encoding TO <encoding> подключения.
:min_messages - Необязательное минимальное количество сообщений клиента, используемое в вызове SET client_min_messages TO <min_messages> подключения.
:variables - Необязательный хэш дополнительных параметров, которые будут использоваться в вызовах SET SESSION key = val подключения.
:insert_returning - Необязательный булевый параметр для управления использованием RETURNING для INSERT заявок. По умолчанию значение true.

Все дополнительные параметры используются как параметры подключения к libpq. Список параметров см. в www.postgresql.org/docs/current/static/libpq-connect.html.

Кроме того, параметры подключения по умолчанию для libpq можно задать через переменные окружения. См. www.postgresql.org/docs/current/static/libpq-envars.html.

Константы

ADAPTER_NAME
Обнаружено тупиковое состояние
Дублирующаяся база данных
Нарушение целостности внешнего ключа
Блокировка недоступна
Основные типы данных базы данных
Нарушение ограничения NOT NULL
Значение числового типа выходит за пределы диапазона
Запрос отменен
Ошибка сериализации
Нарушение ограничения UNIQUE
Нарушение ограничения на значение: См. www.postgresql.org/docs/current/static/errcodes-appendix.html

Публичные методы класса

create_unlogged_tables() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 105
class_attribute :create_unlogged_tables, default: false

PostgreSQL позволяет создавать «незалогированные» таблицы, которые не записывают данные в журнал предварительной записи PostgreSQL. Это может ускорить работу с таблицами, но значительно повышает риск потери данных в случае сбоя базы данных. Поэтому это не следует использовать в производственных средах. Если вы хотите, чтобы все созданные таблицы были незалогированными в тестовой среде, добавьте следующее в ваш файл test.rb:

ActiveSupport.on_load(:active_record_postgresqladapter) do
  self.create_unlogged_tables = true
end

datetime_type() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 123
class_attribute :datetime_type, default: :timestamp

PostgreSQL поддерживает несколько типов для значений DateTime. По умолчанию, если вы используете datetime в миграциях, Rails переведёт это в PostgreSQL «timestamp без часового пояса». Измените это в файле инициализации, чтобы использовать другой NATIVE_DATABASE_TYPES. Например, чтобы сохранять DateTime как «timestamp с часовым поясом»:

ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.datetime_type = :timestamptz

Или если вы добавляете пользовательский тип:

ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES[:my_custom_type] = { name: "my_custom_type_name" }
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.datetime_type = :my_custom_type

Если вы используете :ruby в качестве config.active_record.schema_format, и вы измените это значение, то вам необходимо сразу же выполнить bin/rails db:migrate для обновления типов в вашем файле schema.rb.

dbconsole(config, options = {}) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 73
def dbconsole(config, options = {})
  pg_config = config.configuration_hash

  ENV["PGUSER"]         = pg_config[:username] if pg_config[:username]
  ENV["PGHOST"]         = pg_config[:host] if pg_config[:host]
  ENV["PGPORT"]         = pg_config[:port].to_s if pg_config[:port]
  ENV["PGPASSWORD"]     = pg_config[:password].to_s if pg_config[:password] && options[:include_password]
  ENV["PGSSLMODE"]      = pg_config[:sslmode].to_s if pg_config[:sslmode]
  ENV["PGSSLCERT"]      = pg_config[:sslcert].to_s if pg_config[:sslcert]
  ENV["PGSSLKEY"]       = pg_config[:sslkey].to_s if pg_config[:sslkey]
  ENV["PGSSLROOTCERT"]  = pg_config[:sslrootcert].to_s if pg_config[:sslrootcert]
  if pg_config[:variables]
    ENV["PGOPTIONS"] = pg_config[:variables].filter_map do |name, value|
      "-c #{name}=#{value.to_s.gsub(/[ \\]/, '\\\\\0')}" unless value == ":default" || value == :default
    end.join(" ")
  end
  find_cmd_and_exec(ActiveRecord.database_cli[:postgresql], config.database)
end

decode_dates() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 132
class_attribute :decode_dates, default: false

Включает/выключает автоматическое декодирование столбцов даты.

ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.select_value("select '2024-01-01'::date").class #=> String
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.decode_dates = true
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.select_value("select '2024-01-01'::date").class #=> Date

new(...) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 320
def initialize(...)
  super

  conn_params = @config.compact

  # Map ActiveRecords param names to PGs.
  conn_params[:user] = conn_params.delete(:username) if conn_params[:username]
  conn_params[:dbname] = conn_params.delete(:database) if conn_params[:database]

  # Forward only valid config params to PG::Connection.connect.
  valid_conn_param_keys = PG::Connection.conndefaults_hash.keys + [:requiressl]
  conn_params.slice!(*valid_conn_param_keys)

  @connection_parameters = conn_params

  @max_identifier_length = nil
  @type_map = nil
  @raw_connection = nil
  @notice_receiver_sql_warnings = []

  @use_insert_returning = @config.key?(:insert_returning) ? self.class.type_cast_config_to_boolean(@config[:insert_returning]) : true
end

Инициализирует и подключает адаптер PostgreSQL.

Вызывается метод родительского класса ActiveRecord::ConnectionAdapters::QueryCache::new

new_client(conn_params) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 57
def new_client(conn_params)
  PG.connect(**conn_params)
rescue ::PG::Error => error
  if conn_params && conn_params[:dbname] == "postgres"
    raise ActiveRecord::ConnectionNotEstablished, error.message
  elsif conn_params && conn_params[:dbname] && error.message.include?(conn_params[:dbname])
    raise ActiveRecord::NoDatabaseError.db_error(conn_params[:dbname])
  elsif conn_params && conn_params[:user] && error.message.include?(conn_params[:user])
    raise ActiveRecord::DatabaseConnectionError.username_error(conn_params[:user])
  elsif conn_params && conn_params[:host] && error.message.include?(conn_params[:host])
    raise ActiveRecord::DatabaseConnectionError.hostname_error(conn_params[:host])
  else
    raise ActiveRecord::ConnectionNotEstablished, error.message
  end
end

Публичные методы экземпляров

active?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 348
def active?
  @lock.synchronize do
    return false unless @raw_connection
    @raw_connection.query ";"
  end
  true
rescue PG::Error
  false
end

Подключено ли это соединение и готово ли оно к запросам?

add_enum_value(type_name, value, **options) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 587
def add_enum_value(type_name, value, **options)
  before, after = options.values_at(:before, :after)
  sql = +"ALTER TYPE #{quote_table_name(type_name)} ADD VALUE"
  sql << " IF NOT EXISTS" if options[:if_not_exists]
  sql << " #{quote(value)}"

  if before && after
    raise ArgumentError, "Cannot have both :before and :after at the same time"
  elsif before
    sql << " BEFORE #{quote(before)}"
  elsif after
    sql << " AFTER #{quote(after)}"
  end

  execute(sql).tap { reload_type_map }
end

Добавить значение перечисления к существующему типу перечисления.

connected?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 343
def connected?
  !(@raw_connection.nil? || @raw_connection.finished?)
end

create_enum(name, values, **options) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 540
      def create_enum(name, values, **options)
        sql_values = values.map { |s| quote(s) }.join(", ")
        scope = quoted_scope(name)
        query = <<~SQL
          DO $$
          BEGIN
              IF NOT EXISTS (
                SELECT 1
                FROM pg_type t
                JOIN pg_namespace n ON t.typnamespace = n.oid
                WHERE t.typname = #{scope[:name]}
                  AND n.nspname = #{scope[:schema]}
              ) THEN
                  CREATE TYPE #{quote_table_name(name)} AS ENUM (#{sql_values});
              END IF;
          END
          $$;
        SQL
        internal_exec_query(query).tap { reload_type_map }
      end

Создает тип перечисления на основе имени и массива значений.

disable_extension(name, force: false) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 485
def disable_extension(name, force: false)
  _schema, name = name.to_s.split(".").values_at(-2, -1)
  internal_exec_query("DROP EXTENSION IF EXISTS \"#{name}\"#{' CASCADE' if force == :cascade}").tap {
    reload_type_map
  }
end

Удаляет расширение из базы данных.

:force: Установите в :cascade для удаления зависимых объектов. По умолчанию false.

disconnect!() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 385
def disconnect!
  @lock.synchronize do
    super
    @raw_connection&.close rescue nil
    @raw_connection = nil
  end
end

Отсоединяется от базы данных, если она уже подключена. В противном случае этот метод ничего не делает.

Вызывает метод суперкласса ActiveRecord::ConnectionAdapters::AbstractAdapter#disconnect!

drop_enum(name, values = nil, **options) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 570
      def drop_enum(name, values = nil, **options)
        query = <<~SQL
          DROP TYPE#{' IF EXISTS' if options[:if_exists]} #{quote_table_name(name)};
        SQL
        internal_exec_query(query).tap { reload_type_map }
      end

Удаляет тип перечисления.

Если параметр if_exists: true указан, тип перечисления удаляется только если он существует. В противном случае, если тип перечисления не существует, генерируется ошибка.

Параметр values будет игнорироваться, если он присутствует. Он может быть полезен для указания в методе миграции change, чтобы его можно было отменить. В этом случае values будет использоваться методом create_enum.

enable_extension(name, **) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 472
def enable_extension(name, **)
  schema, name = name.to_s.split(".").values_at(-2, -1)
  sql = +"CREATE EXTENSION IF NOT EXISTS \"#{name}\""
  sql << " SCHEMA #{schema}" if schema

  internal_exec_query(sql).tap { reload_type_map }
end

enum_types() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 517
      def enum_types
        query = <<~SQL
          SELECT
            type.typname AS name,
            type.OID AS oid,
            n.nspname AS schema,
            string_agg(enum.enumlabel, ',' ORDER BY enum.enumsortorder) AS value
          FROM pg_enum AS enum
          JOIN pg_type AS type ON (type.oid = enum.enumtypid)
          JOIN pg_namespace n ON type.typnamespace = n.oid
          WHERE n.nspname = ANY (current_schemas(false))
          GROUP BY type.OID, n.nspname, type.typname;
        SQL

        internal_exec_query(query, "SCHEMA", allow_retry: true, materialize_transactions: false).cast_values.each_with_object({}) do |row, memo|
          name, schema = row[0], row[2]
          schema = nil if schema == current_schema
          full_name = [schema, name].compact.join(".")
          memo[full_name] = row.last
        end.to_a
      end

Возвращает список определенных типов перечислений и их значений.

extension_available?(name) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 492
def extension_available?(name)
  query_value("SELECT true FROM pg_available_extensions WHERE name = #{quote(name)}", "SCHEMA")
end

extension_enabled?(name) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 496
def extension_enabled?(name)
  query_value("SELECT installed_version IS NOT NULL FROM pg_available_extensions WHERE name = #{quote(name)}", "SCHEMA")
end

extensions() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 500
      def extensions
        query = <<~SQL
          SELECT
            pg_extension.extname,
            n.nspname AS schema
          FROM pg_extension
          JOIN pg_namespace n ON pg_extension.extnamespace = n.oid
        SQL

        internal_exec_query(query, "SCHEMA", allow_retry: true, materialize_transactions: false).cast_values.map do |row|
          name, schema = row[0], row[1]
          schema = nil if schema == current_schema
          [schema, name].compact.join(".")
        end
      end

index_algorithms() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 291
def index_algorithms
  { concurrently: "CONCURRENTLY" }
end

max_identifier_length() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 619
def max_identifier_length
  @max_identifier_length ||= query_value("SHOW max_identifier_length", "SCHEMA").to_i
end

Возвращает поддерживаемую длину идентификатора, настроенную в PostgreSQL.

rename_enum(name, new_name = nil, **options) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 578
def rename_enum(name, new_name = nil, **options)
  new_name ||= options.fetch(:to) do
    raise ArgumentError, "rename_enum requires two from/to name positional arguments."
  end

  exec_query("ALTER TYPE #{quote_table_name(name)} RENAME TO #{quote_table_name(new_name)}").tap { reload_type_map }
end

Переименовывает существующий тип перечисления.

rename_enum_value(type_name, **options) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 605
def rename_enum_value(type_name, **options)
  unless database_version >= 10_00_00 # >= 10.0
    raise ArgumentError, "Renaming enum values is only supported in PostgreSQL 10 or later"
  end

  from = options.fetch(:from) { raise ArgumentError, ":from is required" }
  to = options.fetch(:to) { raise ArgumentError, ":to is required" }

  execute("ALTER TYPE #{quote_table_name(type_name)} RENAME VALUE #{quote(from)} TO #{quote(to)}").tap {
    reload_type_map
  }
end

Переименовывает значение перечисления существующего типа перечисления.

reset!() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 370
def reset!
  @lock.synchronize do
    return connect! unless @raw_connection

    unless @raw_connection.transaction_status == ::PG::PQTRANS_IDLE
      @raw_connection.query "ROLLBACK"
    end
    @raw_connection.query "DISCARD ALL"

    super
  end
end

Вызывает метод суперкласса ActiveRecord::ConnectionAdapters::AbstractAdapter#reset!

session_auth=(user) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 624
def session_auth=(user)
  clear_cache!
  internal_execute("SET SESSION AUTHORIZATION #{user}", nil, materialize_transactions: true)
end

Устанавливает авторизованного пользователя для данной сессии.

set_standard_conforming_strings() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 411
def set_standard_conforming_strings
  internal_execute("SET standard_conforming_strings = on", "SCHEMA")
end

supports_advisory_locks?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 419
def supports_advisory_locks?
  true
end

supports_bulk_alter?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 188
def supports_bulk_alter?
  true
end

supports_check_constraints?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 220
def supports_check_constraints?
  true
end

supports_comments?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 252
def supports_comments?
  true
end

supports_common_table_expressions?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 450
def supports_common_table_expressions?
  true
end

supports_datetime_with_precision?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 244
def supports_datetime_with_precision?
  true
end

supports_ddl_transactions?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 415
def supports_ddl_transactions?
  true
end

supports_deferrable_constraints?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 236
def supports_deferrable_constraints?
  true
end

supports_exclusion_constraints?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 224
def supports_exclusion_constraints?
  true
end

supports_explain?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 423
def supports_explain?
  true
end

supports_expression_index?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 208
def supports_expression_index?
  true
end

supports_extensions?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 427
def supports_extensions?
  true
end

supports_foreign_keys?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 216
def supports_foreign_keys?
  true
end

supports_foreign_tables?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 435
def supports_foreign_tables?
  true
end

supports_index_include?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 204
def supports_index_include?
  database_version >= 11_00_00 # >= 11.0
end

supports_index_sort_order?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 192
def supports_index_sort_order?
  true
end

supports_insert_conflict_target?()

Псевдоним для: supports_insert_on_conflict?

supports_insert_on_conflict?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 268
def supports_insert_on_conflict?
  database_version >= 9_05_00 # >= 9.5
end

Также является псевдонимом для: supports_insert_on_duplicate_skip?, supports_insert_on_duplicate_update?, supports_insert_conflict_target?

supports_insert_on_duplicate_skip?()

Псевдоним для: supports_insert_on_conflict?

supports_insert_on_duplicate_update?()

Псевдоним для: supports_insert_on_conflict?

supports_insert_returning?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 264
def supports_insert_returning?
  true
end

supports_json?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 248
def supports_json?
  true
end

supports_lazy_transactions?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 454
def supports_lazy_transactions?
  true
end

supports_materialized_views?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 431
def supports_materialized_views?
  true
end

supports_nulls_not_distinct?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 283
def supports_nulls_not_distinct?
  database_version >= 15_00_00 # >= 15.0
end

supports_optimizer_hints?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 443
def supports_optimizer_hints?
  unless defined?(@has_pg_hint_plan)
    @has_pg_hint_plan = extension_available?("pg_hint_plan")
  end
  @has_pg_hint_plan
end

supports_partial_index?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 200
def supports_partial_index?
  true
end

supports_partitioned_indexes?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 196
def supports_partitioned_indexes?
  database_version >= 11_00_00 # >= 11.0
end

supports_pgcrypto_uuid?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 439
def supports_pgcrypto_uuid?
  database_version >= 9_04_00 # >= 9.4
end

supports_restart_db_transaction?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 260
def supports_restart_db_transaction?
  database_version >= 12_00_00 # >= 12.0
end

supports_savepoints?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 256
def supports_savepoints?
  true
end

supports_transaction_isolation?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 212
def supports_transaction_isolation?
  true
end

supports_unique_constraints?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 228
def supports_unique_constraints?
  true
end

supports_validate_constraints?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 232
def supports_validate_constraints?
  true
end

supports_views?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 240
def supports_views?
  true
end

supports_virtual_columns?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 275
def supports_virtual_columns?
  database_version >= 12_00_00 # >= 12.0
end

use_insert_returning?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 629
def use_insert_returning?
  @use_insert_returning
end