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

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

Адаптер 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
ОБНАРУЖЕНО_ТУПИКОВОЕ_СОСТОЯНИЕ
ДУБЛИРУЮЩАЯСЯ_БАЗА_ДАННЫХ
НАРУШЕНИЕ_ОГРАНИЧЕНИЯ_ВНЕШНЕГО_КЛЮЧА
БЛОКИРОВКА_НЕДОСТУПНА
РОДНЫЕ_ТИПЫ_БАЗЫ_ДАННЫХ
НАРУШЕНИЕ_ОГРАНИЧЕНИЯ_НЕОБЯЗАТЕЛЬНОСТИ
ЧИСЛЕННОЕ_ЗНАЧЕНИЕ_ВЫХОДИТ_ЗА_ПРЕДЕЛЫ
ЗАПРОС_ОТМЕНЕН
НЕУДАЧА_СЕРИАЛИЗАЦИИ
НАРУШЕНИЕ_ОГРАНИЧЕНИЯ_УНИКАЛЬНОСТИ
НАРУШЕНИЕ_ОГРАНИЧЕНИЯ_ПРЕДЕЛА_ЗНАЧЕНИЯ: См. www.postgresql.org/docs/current/static/errcodes-appendix.html

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

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

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

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

ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.create_unlogged_tables = true

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 300
def self.database_exists?(config)
  !!ActiveRecord::Base.postgresql_connection(config)
rescue ActiveRecord::NoDatabaseError
  false
end

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

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

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

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.

new(connection, logger, connection_parameters, config) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 281
def initialize(connection, logger, connection_parameters, config)
  super(connection, logger, config)

  @connection_parameters = connection_parameters

  # @local_tz is initialized as nil to avoid warnings when connect tries to use it
  @local_tz = nil
  @max_identifier_length = nil

  configure_connection
  add_pg_encoders
  add_pg_decoders

  @type_map = Type::HashLookupTypeMap.new
  initialize_type_map
  @local_tz = execute("SHOW TIME ZONE", "SCHEMA").first["TimeZone"]
  @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 77
def new_client(conn_params)
  PG.connect(conn_params)
rescue ::PG::Error => error
  if 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[:hostname] && error.message.include?(conn_params[:hostname])
    raise ActiveRecord::DatabaseConnectionError.hostname_error(conn_params[:hostname])
  else
    raise ActiveRecord::ConnectionNotEstablished, error.message
  end
end

Методы публичного экземпляра

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

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

Является ли это соединение активным и готовым к запросам?

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 472
      def create_enum(name, values)
        sql_values = values.map { |s| "'#{s}'" }.join(", ")
        query = <<~SQL
          DO $$
          BEGIN
              IF NOT EXISTS (
                SELECT 1 FROM pg_type t
                WHERE t.typname = '#{name}'
              ) THEN
                  CREATE TYPE \"#{name}\" AS ENUM (#{sql_values});
              END IF;
          END
          $$;
        SQL
        exec_query(query)
      end

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 439
def disable_extension(name)
  exec_query("DROP EXTENSION IF EXISTS \"#{name}\" CASCADE").tap {
    reload_type_map
  }
end

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

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

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 433
def enable_extension(name)
  exec_query("CREATE EXTENSION IF NOT EXISTS \"#{name}\"").tap {
    reload_type_map
  }
end

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 458
      def enum_types
        query = <<~SQL
          SELECT
            type.typname AS name,
            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)
          GROUP BY type.typname;
        SQL
        exec_query(query, "SCHEMA").cast_values
      end

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 445
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 449
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 453
def extensions
  exec_query("SELECT extname FROM pg_extension", "SCHEMA").cast_values
end

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

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

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

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 322
def reconnect!
  @lock.synchronize do
    super
    @connection.reset
    configure_connection
    reload_type_map
  rescue PG::ConnectionBad
    connect
  end
end

Закрывает и затем повторно открывает соединение.

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 333
def reset!
  @lock.synchronize do
    clear_cache!
    reset_transaction
    unless @connection.transaction_status == ::PG::PQTRANS_IDLE
      @connection.query "ROLLBACK"
    end
    @connection.query "DISCARD ALL"
    configure_connection
  end
end

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 495
def session_auth=(user)
  clear_cache!
  execute("SET SESSION AUTHORIZATION #{user}")
end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

END_OF_DOCUMENT_MARKER

supports_insert_conflict_target?()

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 241
def supports_insert_on_conflict?
  database_version >= 90500 # >= 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 237
def supports_insert_returning?
  true
end

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

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

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

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

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 404
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 189
def supports_partial_index?
  true
end

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 185
def supports_partitioned_indexes?
  database_version >= 110_000 # >= 11.0
end

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

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

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

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

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

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

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

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

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 248
def supports_virtual_columns?
  database_version >= 120_000 # >= 12.0
end

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

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