класс 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/9.1/static/libpq-connect.html.

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

Константы

ADAPTER_NAME
FOREIGN_KEY_VIOLATION: См. www.postgresql.org/docs/9.1/static/errcodes-appendix.html
NATIVE_DATABASE_TYPES
UNIQUE_VIOLATION

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

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

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

  @visitor = Arel::Visitors::PostgreSQL.new self
  if self.class.type_cast_config_to_boolean(config.fetch(:prepared_statements) { true })
    @prepared_statements = true
  else
    @prepared_statements = false
  end

  @connection_parameters, @config = connection_parameters, config

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

  connect
  @statements = StatementPool.new @connection,
                                  self.class.type_cast_config_to_integer(config.fetch(:statement_limit) { 1000 })

  if postgresql_version < 80200
    raise "Your version of PostgreSQL (#{postgresql_version}) is too old, please upgrade!"
  end

  @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 266
def active?
  @connection.query 'SELECT 1'
  true
rescue PGError
  false
end

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

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

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 343
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 292
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 337
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 349
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 357
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 168
def index_algorithms
  { concurrently: 'CONCURRENTLY' }
end

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 138
def migration_keys
  super + [:array]
end

Добавляет :array в качестве допустимого ключа миграции

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

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

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

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 280
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 371
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 311
def set_standard_conforming_strings
  execute('SET standard_conforming_strings = on', 'SCHEMA')
end

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

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

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 324
def supports_extensions?
  postgresql_version >= 90100
end

Возвращает true, если pg > 9.1

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

# File activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb, line 366
def table_alias_length
  @table_alias_length ||= query('SHOW max_identifier_length', 'SCHEMA')[0][0].to_i
end

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

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

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

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

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

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

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

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

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

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

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

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

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