Class: ActiveRecord::ConnectionAdapters::OvirtLegacyPostgreSQLAdapter

Inherits:
AbstractAdapter
  • Object
show all
Includes:
ActiveRecord::ConnectionAdapters::OvirtLegacyPostgreSQL::ColumnDumper, ActiveRecord::ConnectionAdapters::OvirtLegacyPostgreSQL::DatabaseStatements, ActiveRecord::ConnectionAdapters::OvirtLegacyPostgreSQL::Quoting, ActiveRecord::ConnectionAdapters::OvirtLegacyPostgreSQL::ReferentialIntegrity, ActiveRecord::ConnectionAdapters::OvirtLegacyPostgreSQL::SchemaStatements
Defined in:
lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb

Overview

The OvirtLegacyPostgreSQL adapter works with the native C (bitbucket.org/ged/ruby-pg) driver.

Options:

  • :host - Defaults to a Unix-domain socket in /tmp. On machines without Unix-domain sockets, the default is to connect to localhost.

  • :port - Defaults to 5432.

  • :username - Defaults to be the same as the operating system name of the user running the application.

  • :password - Password to be used if the server demands password authentication.

  • :database - Defaults to be the same as the user name.

  • :schema_search_path - An optional schema search path for the connection given as a string of comma-separated schema names. This is backward-compatible with the :schema_order option.

  • :encoding - An optional client encoding that is used in a SET client_encoding TO <encoding> call on the connection.

  • :min_messages - An optional client min messages that is used in a SET client_min_messages TO <min_messages> call on the connection.

  • :variables - An optional hash of additional parameters that will be used in SET SESSION key = val calls on the connection.

  • :insert_returning - An optional boolean to control the use of RETURNING for INSERT statements defaults to true.

Any further options are used as connection parameters to libpq. See www.postgresql.org/docs/current/static/libpq-connect.html for the list of parameters.

In addition, default connection parameters of libpq can be set per environment variables. See www.postgresql.org/docs/current/static/libpq-envars.html .

Defined Under Namespace

Classes: StatementPool

Constant Summary collapse

ADAPTER_NAME = 
'OvirtLegacyPostgreSQL'.freeze
NATIVE_DATABASE_TYPES = 
{
  primary_key: "serial primary key",
  string:      { name: "character varying" },
  text:        { name: "text" },
  integer:     { name: "integer" },
  float:       { name: "float" },
  decimal:     { name: "decimal" },
  datetime:    { name: "timestamp" },
  time:        { name: "time" },
  date:        { name: "date" },
  daterange:   { name: "daterange" },
  numrange:    { name: "numrange" },
  tsrange:     { name: "tsrange" },
  tstzrange:   { name: "tstzrange" },
  int4range:   { name: "int4range" },
  int8range:   { name: "int8range" },
  binary:      { name: "bytea" },
  boolean:     { name: "boolean" },
  xml:         { name: "xml" },
  tsvector:    { name: "tsvector" },
  hstore:      { name: "hstore" },
  inet:        { name: "inet" },
  cidr:        { name: "cidr" },
  macaddr:     { name: "macaddr" },
  uuid:        { name: "uuid" },
  json:        { name: "json" },
  jsonb:       { name: "jsonb" },
  ltree:       { name: "ltree" },
  citext:      { name: "citext" },
  point:       { name: "point" },
  line:        { name: "line" },
  lseg:        { name: "lseg" },
  box:         { name: "box" },
  path:        { name: "path" },
  polygon:     { name: "polygon" },
  circle:      { name: "circle" },
  bit:         { name: "bit" },
  bit_varying: { name: "bit varying" },
  money:       { name: "money" },
}
OID =

:nodoc:

OvirtLegacyPostgreSQL::OID
OPERATION_ALIASES =

:nodoc:

{ # :nodoc:
  "maximum" => "max",
  "minimum" => "min",
  "average" => "avg",
}

Constants included from ActiveRecord::ConnectionAdapters::OvirtLegacyPostgreSQL::DatabaseStatements

ActiveRecord::ConnectionAdapters::OvirtLegacyPostgreSQL::DatabaseStatements::BYTEA_COLUMN_TYPE_OID, ActiveRecord::ConnectionAdapters::OvirtLegacyPostgreSQL::DatabaseStatements::MONEY_COLUMN_TYPE_OID

Instance Method Summary collapse

Methods included from ActiveRecord::ConnectionAdapters::OvirtLegacyPostgreSQL::ColumnDumper

#column_spec_for_primary_key, #migration_keys, #prepare_column_options

Methods included from ActiveRecord::ConnectionAdapters::OvirtLegacyPostgreSQL::DatabaseStatements

#begin_db_transaction, #begin_isolated_db_transaction, #commit_db_transaction, #exec_delete, #exec_insert, #exec_query, #exec_rollback_db_transaction, #execute, #explain, #query, #result_as_array, #select_rows, #select_value, #select_values, #sql_for_insert

Methods included from ActiveRecord::ConnectionAdapters::OvirtLegacyPostgreSQL::SchemaStatements

#add_column, #add_index, #change_column, #change_column_comment, #change_column_default, #change_column_null, #change_table_comment, #client_min_messages, #client_min_messages=, #collation, #columns, #columns_for_distinct, #create_database, #create_schema, #ctype, #current_database, #current_schema, #data_source_exists?, #data_sources, #default_sequence_name, #drop_database, #drop_schema, #drop_table, #encoding, #extract_foreign_key_action, #fetch_type_metadata, #foreign_keys, #index_name_exists?, #index_name_length, #indexes, #new_column, #pk_and_sequence_for, #primary_keys, #recreate_database, #remove_index, #rename_column, #rename_index, #rename_table, #reset_pk_sequence!, #schema_exists?, #schema_names, #schema_search_path, #schema_search_path=, #serial_sequence, #set_pk_sequence!, #table_comment, #table_exists?, #tables, #type_to_sql, #view_exists?, #views

Methods included from ActiveRecord::ConnectionAdapters::OvirtLegacyPostgreSQL::ReferentialIntegrity

#disable_referential_integrity, #supports_disable_referential_integrity?

Methods included from ActiveRecord::ConnectionAdapters::OvirtLegacyPostgreSQL::Quoting

#escape_bytea, #lookup_cast_type_from_column, #quote_column_name, #quote_default_expression, #quote_schema_name, #quote_string, #quote_table_name, #quote_table_name_for_assignment, #quoted_date, #unescape_bytea

Constructor Details

#initialize(connection, logger, connection_parameters, config) ⇒ OvirtLegacyPostgreSQLAdapter

Initializes and connects a OvirtLegacyPostgreSQL adapter.



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 221

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
  @table_alias_length = nil

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

  if postgresql_version < 80200
    raise "Your version of PostgreSQL (#{postgresql_version}) is too old, please upgrade!"
  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

Instance Method Details

#active? ⇒ Boolean

Is this connection alive and ready for queries?

Returns:

  • (Boolean) 


257
258
259
260
261
262
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 257

def active?
  @connection.query 'SELECT 1'
  true
rescue PGError
  false
end

#arel_visitor ⇒ Object

:nodoc:



130
131
132
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 130

def arel_visitor # :nodoc:
  Arel::Visitors::PostgreSQL.new(self)
end

#clear_cache! ⇒ Object

Clears the prepared statements cache.



248
249
250
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 248

def clear_cache!
  @statements.clear
end

#column_name_for_operation(operation, node) ⇒ Object

:nodoc:



401
402
403
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 401

def column_name_for_operation(operation, node) # :nodoc:
  OPERATION_ALIASES.fetch(operation) { operation.downcase }
end

#disable_extension(name) ⇒ Object 



351
352
353
354
355
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 351

def disable_extension(name)
  exec_query("DROP EXTENSION IF EXISTS \"#{name}\" CASCADE").tap {
    reload_type_map
  }
end

#disconnect! ⇒ Object

Disconnects from the database if already connected. Otherwise, this method does nothing.



283
284
285
286
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 283

def disconnect!
  super
  @connection.close rescue nil
end

#enable_extension(name) ⇒ Object 



345
346
347
348
349
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 345

def enable_extension(name)
  exec_query("CREATE EXTENSION IF NOT EXISTS \"#{name}\"").tap {
    reload_type_map
  }
end

#extension_enabled?(name) ⇒ Boolean

Returns:

  • (Boolean) 


357
358
359
360
361
362
363
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 357

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 ⇒ Object 



365
366
367
368
369
370
371
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 365

def extensions
  if supports_extensions?
    exec_query("SELECT extname from pg_extension", "SCHEMA").cast_values
  else
    super
  end
end

#get_advisory_lock(lock_id) ⇒ Object

:nodoc:



331
332
333
334
335
336
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 331

def get_advisory_lock(lock_id) # :nodoc:
  unless lock_id.is_a?(Integer) && lock_id.bit_length <= 63
    raise(ArgumentError, "Postgres requires advisory lock ids to be a signed 64 bit integer")
  end
  select_value("SELECT pg_try_advisory_lock(#{lock_id});")
end

#index_algorithms ⇒ Object 



188
189
190
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 188

def index_algorithms
  { concurrently: 'CONCURRENTLY' }
end

#lookup_cast_type(sql_type) ⇒ Object

:nodoc:



396
397
398
399
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 396

def lookup_cast_type(sql_type) # :nodoc:
  oid = execute("SELECT #{quote(sql_type)}::regtype::oid", "SCHEMA").first['oid'].to_i
  super(oid)
end

#native_database_types ⇒ Object

:nodoc:



288
289
290
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 288

def native_database_types #:nodoc:
  NATIVE_DATABASE_TYPES
end

#postgresql_version ⇒ Object

Returns the version of the connected PostgreSQL server.



412
413
414
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 412

def postgresql_version
  @connection.server_version
end

#reconnect! ⇒ Object

Close then reopen the connection.



265
266
267
268
269
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 265

def reconnect!
  super
  @connection.reset
  configure_connection
end

#release_advisory_lock(lock_id) ⇒ Object

:nodoc:



338
339
340
341
342
343
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 338

def release_advisory_lock(lock_id) # :nodoc:
  unless lock_id.is_a?(Integer) && lock_id.bit_length <= 63
    raise(ArgumentError, "Postgres requires advisory lock ids to be a signed 64 bit integer")
  end
  select_value("SELECT pg_advisory_unlock(#{lock_id})")
end

#reset! ⇒ Object 



271
272
273
274
275
276
277
278
279
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 271

def reset!
  clear_cache!
  reset_transaction
  unless @connection.transaction_status == ::PG::PQTRANS_IDLE
    @connection.query 'ROLLBACK'
  end
  @connection.query 'DISCARD ALL'
  configure_connection
end

#schema_creation ⇒ Object

:nodoc:



126
127
128
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 126

def schema_creation # :nodoc:
  OvirtLegacyPostgreSQL::SchemaCreation.new self
end

#session_auth=(user) ⇒ Object

Set the authorized user for this session



379
380
381
382
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 379

def session_auth=(user)
  clear_cache!
  exec_query "SET SESSION AUTHORIZATION #{user}"
end

#set_standard_conforming_strings ⇒ Object 



302
303
304
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 302

def set_standard_conforming_strings
  execute('SET standard_conforming_strings = on', 'SCHEMA')
end

#supports_advisory_locks? ⇒ Boolean

Returns:

  • (Boolean) 


310
311
312
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 310

def supports_advisory_locks?
  true
end

#supports_collation? ⇒ Boolean

Returns:

  • (Boolean) 


184
185
186
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 184

def supports_collation?
  postgresql_version >= 90100
end

#supports_comments? ⇒ Boolean

Returns:

  • (Boolean) 


172
173
174
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 172

def supports_comments?
  true
end

#supports_comments_in_create? ⇒ Boolean

Returns:

  • (Boolean) 


176
177
178
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 176

def supports_comments_in_create?
  false
end

#supports_datetime_with_precision? ⇒ Boolean

Returns:

  • (Boolean) 


164
165
166
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 164

def supports_datetime_with_precision?
  true
end

#supports_ddl_transactions? ⇒ Boolean

Returns:

  • (Boolean) 


306
307
308
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 306

def supports_ddl_transactions?
  true
end

#supports_explain? ⇒ Boolean

Returns:

  • (Boolean) 


314
315
316
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 314

def supports_explain?
  true
end

#supports_expression_index? ⇒ Boolean

Returns:

  • (Boolean) 


148
149
150
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 148

def supports_expression_index?
  true
end

#supports_extensions? ⇒ Boolean

Returns:

  • (Boolean) 


318
319
320
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 318

def supports_extensions?
  postgresql_version >= 90100
end

#supports_foreign_keys? ⇒ Boolean

Returns:

  • (Boolean) 


156
157
158
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 156

def supports_foreign_keys?
  true
end

#supports_index_sort_order? ⇒ Boolean

Returns:

  • (Boolean) 


140
141
142
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 140

def supports_index_sort_order?
  true
end

#supports_json? ⇒ Boolean

Returns:

  • (Boolean) 


168
169
170
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 168

def supports_json?
  postgresql_version >= 90200
end

#supports_materialized_views? ⇒ Boolean

Returns:

  • (Boolean) 


327
328
329
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 327

def supports_materialized_views?
  postgresql_version >= 90300
end

#supports_migrations? ⇒ Boolean

Returns true, since this connection adapter supports migrations.

Returns:

  • (Boolean) 


293
294
295
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 293

def supports_migrations?
  true
end

#supports_partial_index? ⇒ Boolean

Returns:

  • (Boolean) 


144
145
146
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 144

def supports_partial_index?
  true
end

#supports_primary_key? ⇒ Boolean

Does PostgreSQL support finding primary key on non-Active Record tables?

Returns:

  • (Boolean) 


298
299
300
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 298

def supports_primary_key? #:nodoc:
  true
end

#supports_ranges? ⇒ Boolean

Range datatypes weren’t introduced until PostgreSQL 9.2

Returns:

  • (Boolean) 


323
324
325
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 323

def supports_ranges?
  postgresql_version >= 90200
end

#supports_savepoints? ⇒ Boolean

Returns:

  • (Boolean) 


180
181
182
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 180

def supports_savepoints?
  true
end

#supports_statement_cache? ⇒ Boolean

Returns true, since this connection adapter supports prepared statement caching.

Returns:

  • (Boolean) 


136
137
138
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 136

def supports_statement_cache?
  true
end

#supports_transaction_isolation? ⇒ Boolean

Returns:

  • (Boolean) 


152
153
154
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 152

def supports_transaction_isolation?
  true
end

#supports_views? ⇒ Boolean

Returns:

  • (Boolean) 


160
161
162
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 160

def supports_views?
  true
end

#table_alias_length ⇒ Object

Returns the configured supported identifier length supported by PostgreSQL



374
375
376
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 374

def table_alias_length
  @table_alias_length ||= query('SHOW max_identifier_length', 'SCHEMA')[0][0].to_i
end

#truncate(table_name, name = nil) ⇒ Object 



252
253
254
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 252

def truncate(table_name, name = nil)
  exec_query "TRUNCATE TABLE #{quote_table_name(table_name)}", name, []
end

#update_table_definition(table_name, base) ⇒ Object

:nodoc:



392
393
394
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 392

def update_table_definition(table_name, base) #:nodoc:
  OvirtLegacyPostgreSQL::Table.new(table_name, base)
end

#use_insert_returning? ⇒ Boolean

Returns:

  • (Boolean) 


384
385
386
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 384

def use_insert_returning?
  @use_insert_returning
end

#valid_type?(type) ⇒ Boolean

Returns:

  • (Boolean) 


388
389
390
 
# File 'lib/active_record/connection_adapters/ovirt_legacy_postgresql_adapter.rb', line 388

def valid_type?(type)
  !native_database_types[type].nil?
end