класс 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 - Необязательный boolean для управления использованием 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
DEADLOCK_DETECTED
DUPLICATE_DATABASE
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

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

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

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

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

ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.create_unlogged_tables = true

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 251
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
  else
    raise ActiveRecord::ConnectionNotEstablished, error.message
  end
end

Методы экземпляра Public

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

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

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

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

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

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 414
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 287
def reconnect!
  @lock.synchronize do
    super
    @connection.reset
    configure_connection
  rescue PG::ConnectionBad
    connect
  end
end

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 297
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 419
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 328
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 336
def supports_advisory_locks?
  true
end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Также переименовано в: supports_insert_on_duplicate_skip?, supports_insert_on_duplicate_update?, supports_insert_conflict_target?

END_OF_DOCUMENT_MARKER

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 207
def supports_insert_returning?
  true
end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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