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

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

Адаптер 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

FOREIGN_KEY_VIOLATION

NATIVE_DATABASE_TYPES

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 208
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(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 244
def active?
  @connection.query 'SELECT 1'
  true
rescue PG::Error
  false
end

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 235
def clear_cache!
  @statements.clear
end

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 338
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 270
def disconnect!
  super
  @connection.close rescue nil
end

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 332
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 344
def extension_enabled?(name)
  if supports_extensions?
    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
end

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 352
def extensions
  if supports_extensions?
    exec_query("SELECT extname from pg_extension", "SCHEMA").cast_values
  else
    super
  end
end

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 175
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 361
def max_identifier_length
  @max_identifier_length ||= query('SHOW max_identifier_length', 'SCHEMA')[0][0].to_i
end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Возвращает true, так как этот адаптер соединения поддерживает миграции.

END_OF_DOCUMENT_MARKER

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

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

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

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

Диапазоны типов данных появились только в PostgreSQL 9.2

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

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

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

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

Возвращает true, так как этот адаптер подключения поддерживает кэширование подготовленных запросов.

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 155
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 239
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 373
def use_insert_returning?
  @use_insert_returning
end

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 377
def valid_type?(type)
  !native_database_types[type].nil?
end

Защищённые методы экземпляра

translate_exception(exception, message) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 412
def translate_exception(exception, message)
  return exception unless exception.respond_to?(:result)

  case exception.result.try(:error_field, PG::PG_DIAG_SQLSTATE)
  when UNIQUE_VIOLATION
    RecordNotUnique.new(message)
  when FOREIGN_KEY_VIOLATION
    InvalidForeignKey.new(message)
  when VALUE_LIMIT_VIOLATION
    ValueTooLong.new(message)
  else
    super
  end
end

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