Class: ActiveRecord::ConnectionAdapters::AbstractAdapter

Inherits:
Object
  • Object
show all
Includes:
ColumnDumper, DatabaseLimits, DatabaseStatements, QueryCache, Quoting, Savepoints, SchemaStatements, ActiveSupport::Callbacks
Defined in:
lib/active_record/connection_adapters/abstract_adapter.rb,
lib/active_record/connection_adapters/abstract/schema_creation.rb

Overview

Active Record supports multiple database systems. AbstractAdapter and related classes form the abstraction layer which makes this possible. An AbstractAdapter represents a connection to a database, and provides an abstract interface for database-specific functionality such as establishing a connection, escaping values, building the right SQL fragments for :offset and :limit options, etc.

All the concrete database adapters follow the interface laid down in this class. ActiveRecord::Base.connection returns an AbstractAdapter object, which you can use.

Most of the methods in the adapter are useful during migrations. Most notably, the instance methods provided by SchemaStatements are very useful.

Defined Under Namespace

Classes: BindCollector, SQLString, SchemaCreation, Version

Constant Summary collapse

ADAPTER_NAME = 
"Abstract".freeze
SIMPLE_INT = 
/\A\d+\z/

Instance Attribute Summary collapse

Attributes included from QueryCache

#query_cache, #query_cache_enabled

Attributes included from DatabaseStatements

#transaction_manager

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Savepoints

#create_savepoint, #current_savepoint_name, #exec_rollback_to_savepoint, #release_savepoint

Methods included from ColumnDumper

#column_spec, #column_spec_for_primary_key, #migration_keys, #prepare_column_options

Methods included from QueryCache

#cache, #clear_query_cache, dirties_query_cache, #disable_query_cache!, #enable_query_cache!, included, #select_all, #uncached

Methods included from DatabaseLimits

#allowed_index_name_length, #column_name_length, #columns_per_multicolumn_index, #columns_per_table, #in_clause_length, #index_name_length, #indexes_per_table, #joins_per_query, #sql_query_length, #table_alias_length, #table_name_length

Methods included from Quoting

#fetch_type_metadata, #lookup_cast_type_from_column, #quote, #quote_column_name, #quote_default_expression, #quote_string, #quote_table_name, #quote_table_name_for_assignment, #quoted_binary, #quoted_date, #quoted_false, #quoted_time, #quoted_true, #type_cast, #type_cast_from_column, #type_casted_binds, #unquoted_false, #unquoted_true

Methods included from DatabaseStatements

#add_transaction_record, #begin_db_transaction, #begin_isolated_db_transaction, #cacheable_query, #commit_db_transaction, #default_sequence_name, #delete, #empty_insert_statement_value, #exec_delete, #exec_insert, #exec_query, #exec_rollback_db_transaction, #exec_update, #execute, #insert, #insert_fixture, #join_to_update, #query, #query_value, #query_values, #reset_sequence!, #reset_transaction, #rollback_db_transaction, #rollback_to_savepoint, #sanitize_limit, #select_all, #select_one, #select_rows, #select_value, #select_values, #supports_statement_cache?, #to_sql, #transaction, #transaction_isolation_levels, #transaction_open?, #transaction_state, #truncate, #update

Methods included from SchemaStatements

#add_column, #add_foreign_key, #add_index, #add_index_options, #add_reference, #add_timestamps, #assume_migrated_upto_version, #change_column, #change_column_comment, #change_column_default, #change_column_null, #change_table, #change_table_comment, #column_exists?, #columns_for_distinct, #create_join_table, #create_table, #data_source_exists?, #data_sources, #drop_join_table, #drop_table, #dump_schema_information, #foreign_key_column_for, #foreign_key_exists?, #foreign_key_for, #foreign_key_for!, #foreign_key_options, #foreign_keys, #index_exists?, #index_name, #index_name_exists?, #indexes, #initialize_internal_metadata_table, #initialize_schema_migrations_table, #insert_versions_sql, #internal_string_options_for_primary_key, #native_database_types, #options_include_default?, #primary_key, #remove_column, #remove_columns, #remove_foreign_key, #remove_index, #remove_reference, #remove_timestamps, #rename_column, #rename_index, #rename_table, #table_alias_for, #table_comment, #table_exists?, #table_options, #tables, #type_to_sql, #update_table_definition, #view_exists?, #views

Constructor Details

#initialize(connection, logger = nil, config = {}) ⇒ AbstractAdapter

:nodoc:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 97

def initialize(connection, logger = nil, config = {}) # :nodoc:
  super()

  @connection          = connection
  @owner               = nil
  @instrumenter        = ActiveSupport::Notifications.instrumenter
  @logger              = logger
  @config              = config
  @pool                = nil
  @schema_cache        = SchemaCache.new self
  @quoted_column_names, @quoted_table_names = {}, {}
  @visitor = arel_visitor
  @lock = ActiveSupport::Concurrency::LoadInterlockAwareMonitor.new

  if self.class.type_cast_config_to_boolean(config.fetch(:prepared_statements) { true })
    @prepared_statements = true
    @visitor.extend(DetermineIfPreparableVisitor)
  else
    @prepared_statements = false
  end
end

Instance Attribute Details

#lock ⇒ Object (readonly)

Returns the value of attribute lock.



78
79
80
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 78

def lock
  @lock
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



78
79
80
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 78

def logger
  @logger
end

#owner ⇒ Object (readonly) Also known as: in_use?

Returns the value of attribute owner.



78
79
80
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 78

def owner
  @owner
end

#pool ⇒ Object

Returns the value of attribute pool.



77
78
79
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 77

def pool
  @pool
end

#prepared_statements ⇒ Object (readonly)

Returns the value of attribute prepared_statements.



78
79
80
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 78

def prepared_statements
  @prepared_statements
end

#schema_cache ⇒ Object

Returns the value of attribute schema_cache.



78
79
80
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 78

def schema_cache
  @schema_cache
end

#visitor ⇒ Object

Returns the value of attribute visitor.



77
78
79
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 77

def visitor
  @visitor
end

Class Method Details

.type_cast_config_to_boolean(config) ⇒ Object 



89
90
91
92
93
94
95
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 89

def self.type_cast_config_to_boolean(config)
  if config == "false"
    false
  else
    config
  end
end

.type_cast_config_to_integer(config) ⇒ Object 



81
82
83
84
85
86
87
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 81

def self.type_cast_config_to_integer(config)
  if config =~ SIMPLE_INT
    config.to_i
  else
    config
  end
end

Instance Method Details

#active? ⇒ Boolean

Checks whether the connection to the database is still active. This includes checking whether the database is actually capable of responding, i.e. whether the connection isn’t stale.

Returns:

  • (Boolean) 


397
398
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 397

def active?
end

#adapter_name ⇒ Object

Returns the human-readable name of the adapter. Use mixed case - one can always use downcase if needed.



230
231
232
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 230

def adapter_name
  self.class::ADAPTER_NAME
end

#arel_visitor ⇒ Object

:nodoc:



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

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

#case_insensitive_comparison(table, attribute, column, value) ⇒ Object

:nodoc:



461
462
463
464
465
466
467
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 461

def case_insensitive_comparison(table, attribute, column, value) # :nodoc:
  if can_perform_case_insensitive_comparison_for?(column)
    table[attribute].lower.eq(table.lower(value))
  else
    table[attribute].eq(value)
  end
end

#case_sensitive_comparison(table, attribute, column, value) ⇒ Object

:nodoc:



457
458
459
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 457

def case_sensitive_comparison(table, attribute, column, value) # :nodoc:
  table[attribute].eq(value)
end

#clear_cache! ⇒ Object

Clear any caching the database adapter may be doing, for example clearing the prepared statement cache. This is database specific.



428
429
430
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 428

def clear_cache!
  # this should be overridden by concrete adapters
end

#close ⇒ Object

Check the connection back in to the connection pool



475
476
477
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 475

def close
  pool.checkin self
end

#collector ⇒ Object 



144
145
146
147
148
149
150
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 144

def collector
  if prepared_statements
    SQLString.new
  else
    BindCollector.new
  end
end

#column_name_for_operation(operation, node) ⇒ Object

:nodoc:



493
494
495
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 493

def column_name_for_operation(operation, node) # :nodoc:
  visitor.accept(node, collector).value
end

#columns(table_name) ⇒ Object

Returns an array of Column objects for the table specified by table_name.



165
166
167
168
169
170
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 165

def columns(table_name) # :nodoc:
  table_name = table_name.to_s
  column_definitions(table_name).map do |field|
    new_column_from_field(table_name, field)
  end
end

#combine_bind_parameters(from_clause: [], join_clause: [], where_clause: [], having_clause: [], limit: nil, offset: nil) ⇒ Object 



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 497

def combine_bind_parameters(
  from_clause: [],
  join_clause: [],
  where_clause: [],
  having_clause: [],
  limit: nil,
  offset: nil
) # :nodoc:
  result = from_clause + join_clause + where_clause + having_clause
  if limit
    result << limit
  end
  if offset
    result << offset
  end
  result
end

#default_index_type?(index) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


515
516
517
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 515

def default_index_type?(index) # :nodoc:
  index.using.nil?
end

#disable_extension(name) ⇒ Object

This is meant to be implemented by the adapters that support extensions



354
355
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 354

def disable_extension(name)
end

#disable_referential_integrity ⇒ Object

Override to turn off referential integrity while executing &block.



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

def disable_referential_integrity
  yield
end

#disconnect! ⇒ Object

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



410
411
412
413
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 410

def disconnect!
  clear_cache!
  reset_transaction
end

#enable_extension(name) ⇒ Object

This is meant to be implemented by the adapters that support extensions



358
359
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 358

def enable_extension(name)
end

#expire ⇒ Object

this method must only be called while holding connection pool’s mutex



194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 194

def expire
  if in_use?
    if @owner != Thread.current
      raise ActiveRecordError, "Cannot expire connection, " \
        "it is owned by a different thread: #{@owner}. " \
        "Current thread: #{Thread.current}."
    end

    @owner = nil
  else
    raise ActiveRecordError, "Cannot expire connection, it is not currently leased."
  end
end

#extensions ⇒ Object

A list of extensions, to be filled in by adapters that support them.



376
377
378
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 376

def extensions
  []
end

#get_advisory_lock(lock_id) ⇒ Object

This is meant to be implemented by the adapters that support advisory locks

Return true if we got the lock, otherwise false



365
366
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 365

def get_advisory_lock(lock_id) # :nodoc:
end

#index_algorithms ⇒ Object

A list of index algorithms, to be filled by adapters that support them.



381
382
383
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 381

def index_algorithms
  {}
end

#lease ⇒ Object

this method must only be called while holding connection pool’s mutex



173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 173

def lease
  if in_use?
    msg = "Cannot lease connection, "
    if @owner == Thread.current
      msg << "it is already leased by the current thread."
    else
      msg << "it is already in use by a different thread: #{@owner}. " \
             "Current thread: #{Thread.current}."
    end
    raise ActiveRecordError, msg
  end

  @owner = Thread.current
end

#lookup_cast_type(sql_type) ⇒ Object

:nodoc:



489
490
491
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 489

def lookup_cast_type(sql_type) # :nodoc:
  type_map.lookup(sql_type)
end

#new_column(name, default, sql_type_metadata, null, table_name, default_function = nil, collation = nil) ⇒ Object

:nodoc:



485
486
487
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 485

def new_column(name, default, sql_type_metadata, null, table_name, default_function = nil, collation = nil) # :nodoc:
  Column.new(name, default, sql_type_metadata, null, table_name, default_function, collation)
end

#prefetch_primary_key?(table_name = nil) ⇒ Boolean

Should primary key values be selected from their corresponding sequence before the insert statement? If true, next_sequence_value is called before each insert to set the record’s primary key.

Returns:

  • (Boolean) 


267
268
269
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 267

def prefetch_primary_key?(table_name = nil)
  false
end

#raw_connection ⇒ Object

Provides access to the underlying database driver for this adapter. For example, this method returns a Mysql2::Client object in case of Mysql2Adapter, and a PG::Connection object in case of PostgreSQLAdapter.

This is useful for when you need to call a proprietary method such as PostgreSQL’s lo_* methods.



453
454
455
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 453

def raw_connection
  @connection
end

#reconnect! ⇒ Object

Disconnects from the database if already connected, and establishes a new connection with the database. Implementors should call super if they override the default implementation.



403
404
405
406
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 403

def reconnect!
  clear_cache!
  reset_transaction
end

#release_advisory_lock(lock_id) ⇒ Object

This is meant to be implemented by the adapters that support advisory locks.

Return true if we released the lock, otherwise false



372
373
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 372

def release_advisory_lock(lock_id) # :nodoc:
end

#requires_reloading? ⇒ Boolean

Returns true if its required to reload the connection between requests for development mode.

Returns:

  • (Boolean) 


433
434
435
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 433

def requires_reloading?
  false
end

#reset! ⇒ Object

Reset the state of this connection, directing the DBMS to clear transactions and other connection-related server-side state. Usually a database-dependent operation.

The default implementation does nothing; the implementation should be overridden by concrete adapters.



421
422
423
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 421

def reset!
  # this should be overridden by concrete adapters
end

#schema_creation ⇒ Object 



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

def schema_creation
  SchemaCreation.new self
end

#steal! ⇒ Object

this method must only be called while holding connection pool’s mutex (and a desire for segfaults)



209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 209

def steal! # :nodoc:
  if in_use?
    if @owner != Thread.current
      pool.send :remove_connection_from_thread_cache, self, @owner

      @owner = Thread.current
    end
  else
    raise ActiveRecordError, "Cannot steal connection, it is not currently leased."
  end
end

#supports_advisory_locks? ⇒ Boolean

Does this adapter support application-enforced advisory locking?

Returns:

  • (Boolean) 


260
261
262
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 260

def supports_advisory_locks?
  false
end

#supports_bulk_alter? ⇒ Boolean

Returns:

  • (Boolean) 


250
251
252
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 250

def supports_bulk_alter?
  false
end

#supports_comments? ⇒ Boolean

Does this adapter support metadata comments on database objects (tables, columns, indexes)?

Returns:

  • (Boolean) 


334
335
336
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 334

def supports_comments?
  false
end

#supports_comments_in_create? ⇒ Boolean

Can comments for tables, columns, and indexes be specified in create/alter table statements?

Returns:

  • (Boolean) 


339
340
341
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 339

def supports_comments_in_create?
  false
end

#supports_datetime_with_precision? ⇒ Boolean

Does this adapter support datetime with precision?

Returns:

  • (Boolean) 


324
325
326
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 324

def supports_datetime_with_precision?
  false
end

#supports_ddl_transactions? ⇒ Boolean

Does this adapter support DDL rollbacks in transactions? That is, would CREATE TABLE or ALTER TABLE get rolled back by a transaction?

Returns:

  • (Boolean) 


246
247
248
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 246

def supports_ddl_transactions?
  false
end

#supports_explain? ⇒ Boolean

Does this adapter support explain?

Returns:

  • (Boolean) 


287
288
289
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 287

def supports_explain?
  false
end

#supports_expression_index? ⇒ Boolean

Does this adapter support expression indices?

Returns:

  • (Boolean) 


282
283
284
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 282

def supports_expression_index?
  false
end

#supports_extensions? ⇒ Boolean

Does this adapter support database extensions?

Returns:

  • (Boolean) 


297
298
299
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 297

def supports_extensions?
  false
end

#supports_foreign_keys? ⇒ Boolean

Does this adapter support creating foreign key constraints?

Returns:

  • (Boolean) 


308
309
310
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 308

def supports_foreign_keys?
  false
end

#supports_index_sort_order? ⇒ Boolean

Does this adapter support index sort order?

Returns:

  • (Boolean) 


272
273
274
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 272

def supports_index_sort_order?
  false
end

#supports_json? ⇒ Boolean

Does this adapter support json data type?

Returns:

  • (Boolean) 


329
330
331
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 329

def supports_json?
  false
end

#supports_migrations? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


234
235
236
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 234

def supports_migrations? # :nodoc:
  true
end

#supports_multi_insert? ⇒ Boolean

Does this adapter support multi-value insert?

Returns:

  • (Boolean) 


344
345
346
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 344

def supports_multi_insert?
  true
end

#supports_partial_index? ⇒ Boolean

Does this adapter support partial indices?

Returns:

  • (Boolean) 


277
278
279
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 277

def supports_partial_index?
  false
end

#supports_primary_key? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


239
240
241
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 239

def supports_primary_key? # :nodoc:
  true
end

#supports_savepoints? ⇒ Boolean

Does this adapter support savepoints?

Returns:

  • (Boolean) 


255
256
257
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 255

def supports_savepoints?
  false
end

#supports_transaction_isolation? ⇒ Boolean

Does this adapter support setting the isolation level for a transaction?

Returns:

  • (Boolean) 


292
293
294
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 292

def supports_transaction_isolation?
  false
end

#supports_views? ⇒ Boolean

Does this adapter support views?

Returns:

  • (Boolean) 


319
320
321
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 319

def supports_views?
  false
end

#supports_virtual_columns? ⇒ Boolean

Does this adapter support virtual columns?

Returns:

  • (Boolean) 


349
350
351
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 349

def supports_virtual_columns?
  false
end

#type_map ⇒ Object

:nodoc:



479
480
481
482
483
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 479

def type_map # :nodoc:
  @type_map ||= Type::TypeMap.new.tap do |mapping|
    initialize_type_map(mapping)
  end
end

#unprepared_statement ⇒ Object 



221
222
223
224
225
226
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 221

def unprepared_statement
  old_prepared_statements, @prepared_statements = @prepared_statements, false
  yield
ensure
  @prepared_statements = old_prepared_statements
end

#valid_type?(type) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


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

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

#verify!(*ignored) ⇒ Object

Checks whether the connection to the database is still active (i.e. not stale). This is done under the hood by calling #active?. If the connection is no longer active, then this method will reconnect to the database.



440
441
442
443
444
445
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 440

def verify!(*ignored)
  if ignored.size > 0
    ActiveSupport::Deprecation.warn("Passing arguments to #verify method of the connection has no effect and has been deprecated. Please remove all arguments from the #verify method call.")
  end
  reconnect! unless active?
end