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

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

Адаптер PostgreSQL работает с родным C-драйвером (bitbucket.org/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

CACHED_PLAN_HEURISTIC

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

Это охватывает различные типы ошибок, поэтому нам необходимо выполнить дополнительные действия для окончательной классификации исключения как ActiveRecord::PreparedStatementCacheExpired.

Подробнее см.: git.postgresql.org/gitweb/?p=postgresql.git;a=blob;f=src/backend/utils/cache/plancache.c#l573

DEADLOCK_DETECTED

FOREIGN_KEY_VIOLATION

LOCK_NOT_AVAILABLE

NATIVE_DATABASE_TYPES

NOT_NULL_VIOLATION

NUMERIC_VALUE_OUT_OF_RANGE

QUERY_CANCELED

SERIALIZATION_FAILURE

UNIQUE_VIOLATION

VALUE_LIMIT_VIOLATION

См. www.postgresql.org/docs/current/static/errcodes-appendix.html

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 214
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

  connect
  add_pg_encoders
  @statements = StatementPool.new @connection,
                                  self.class.type_cast_config_to_integer(config[:statement_limit])

  if postgresql_version < 90100
    raise "Your version of PostgreSQL (#{postgresql_version}) is too old. Active Record supports PostgreSQL >= 9.1."
  end

  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

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

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

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 241
def clear_cache!
  @lock.synchronize do
    @statements.clear
  end
end

Очищает кэш подготовленных операторов.

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 357
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 284
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 351
def enable_extension(name)
  exec_query("CREATE EXTENSION IF NOT EXISTS \"#{name}\"").tap {
    reload_type_map
  }
end

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 363
def extension_enabled?(name)
  res = exec_query("SELECT EXISTS(SELECT * FROM pg_available_extensions WHERE name = '#{name}' AND installed_version IS NOT NULL) as enabled", "SCHEMA")
  res.cast_values.first
end

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 368
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 181
def index_algorithms
  { concurrently: "CONCURRENTLY" }
end

index_name_length()

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

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

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

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

Также псевдоним для: table_alias_length, index_name_length

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 400
def postgresql_version
  @connection.server_version
end

Возвращает версию подключенного сервера PostgreSQL.

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 262
def reconnect!
  @lock.synchronize do
    super
    @connection.reset
    configure_connection
  end
end

Закрыть, а затем снова открыть подключение.

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 270
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 380
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 300
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 308
def supports_advisory_locks?
  true
end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 329
def supports_foreign_tables?
  postgresql_version >= 90300
end

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 169
def supports_json?
  postgresql_version >= 90200
end

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 325
def supports_materialized_views?
  postgresql_version >= 90300
end

END_OF_DOCUMENT_MARKER

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 333
def supports_pgcrypto_uuid?
  postgresql_version >= 90400
end

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 320
def supports_ranges?
  # Range datatypes weren't introduced until PostgreSQL 9.2
  postgresql_version >= 90200
end

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

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

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

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

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

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

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

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

table_alias_length()

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

truncate(table_name, name = nil) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 247
def truncate(table_name, name = nil)
  exec_query "TRUNCATE TABLE #{quote_table_name(table_name)}", name, []
end

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

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