Class: ActiveRecord::ConnectionAdapters::AbstractAdapter

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

Overview

ActiveRecord 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 SchemaStatement are very useful.

Direct Known Subclasses

MysqlAdapter, PostgreSQLAdapter, SQLiteAdapter

Constant Summary collapse

@@row_even = 
true

Instance Method Summary collapse

Methods included from QueryCache

#cache, #uncached

Methods included from Quoting

#quote, #quote_column_name, #quote_string, #quoted_date, #quoted_false, #quoted_string_prefix, #quoted_true

Methods included from DatabaseStatements

#add_limit!, #add_limit_offset!, #add_lock!, #begin_db_transaction, #case_sensitive_equality_operator, #commit_db_transaction, #default_sequence_name, #delete, #empty_insert_statement, #execute, #insert, #insert_fixture, #limited_update_conditions, #reset_sequence!, #rollback_db_transaction, #select_all, #select_one, #select_rows, #select_value, #select_values, #transaction, #update

Methods included from SchemaStatements

#add_column, #add_column_options!, #add_index, #add_order_by_for_association_limiting!, #add_timestamps, #assume_migrated_upto_version, #change_column, #change_column_default, #change_table, #columns, #create_table, #distinct, #drop_table, #dump_schema_information, #index_name, #initialize_schema_migrations_table, #native_database_types, #remove_column, #remove_index, #remove_timestamps, #rename_column, #rename_table, #structure_dump, #table_alias_for, #table_alias_length, #table_exists?, #type_to_sql

Constructor Details

#initialize(connection, logger = nil) ⇒ AbstractAdapter

:nodoc:



37
38
39
40
41
42
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 37

def initialize(connection, logger = nil) #:nodoc:
  @connection, @logger = connection, logger
  @runtime = 0
  @last_verification = 0
  @query_cache_enabled = false
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) 


101
102
103
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 101

def active?
  @active != false
end

#adapter_name ⇒ Object

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



46
47
48
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 46

def adapter_name
  'Abstract'
end

#decrement_open_transactions ⇒ Object 



158
159
160
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 158

def decrement_open_transactions
  @open_transactions -= 1
end

#disable_referential_integrity(&block) ⇒ Object

Override to turn off referential integrity while executing &block.



92
93
94
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 92

def disable_referential_integrity(&block)
  yield
end

#disconnect! ⇒ Object

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



113
114
115
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 113

def disconnect!
  @active = false
end

#increment_open_transactions ⇒ Object 



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

def increment_open_transactions
  @open_transactions ||= 0
  @open_transactions += 1
end

#log_info(sql, name, seconds) ⇒ Object 



162
163
164
165
166
167
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 162

def log_info(sql, name, seconds)
  if @logger && @logger.debug?
    name = "#{name.nil? ? "SQL" : name} (#{sprintf("%.1f", seconds * 1000)}ms)"
    @logger.debug(format_log_entry(name, sql.squeeze(' ')))
  end
end

#open_transactions ⇒ Object 



149
150
151
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 149

def open_transactions
  @open_transactions ||= 0
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. This is false for all adapters but Firebird.

Returns:

  • (Boolean) 


73
74
75
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 73

def prefetch_primary_key?(table_name = nil)
  false
end

#quote_table_name(name) ⇒ Object

Override to return the quoted table name. Defaults to column quoting.



85
86
87
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 85

def quote_table_name(name)
  quote_column_name(name)
end

#raw_connection ⇒ Object

Provides access to the underlying database driver for this adapter. For example, this method returns a Mysql object in case of MysqlAdapter, and a PGconn object in case of PostgreSQLAdapter.

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



145
146
147
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 145

def raw_connection
  @connection
end

#reconnect! ⇒ Object

Disconnects from the database if already connected, and establishes a new connection with the database.



107
108
109
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 107

def reconnect!
  @active = true
end

#requires_reloading? ⇒ Boolean

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

Returns:

  • (Boolean) 


128
129
130
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 128

def requires_reloading?
  true
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.



123
124
125
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 123

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

#reset_runtime ⇒ Object

:nodoc:



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

def reset_runtime #:nodoc:
  rt, @runtime = @runtime, 0
  rt
end

#supports_count_distinct? ⇒ Boolean

Does this adapter support using DISTINCT within COUNT? This is true for all adapters except sqlite.

Returns:

  • (Boolean) 


58
59
60
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 58

def supports_count_distinct?
  true
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? PostgreSQL, SQL Server, and others support this. MySQL and others do not.

Returns:

  • (Boolean) 


65
66
67
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 65

def supports_ddl_transactions?
  false
end

#supports_migrations? ⇒ Boolean

Does this adapter support migrations? Backend specific, as the abstract adapter always returns false.

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 52

def supports_migrations?
  false
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.



135
136
137
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 135

def verify!(*ignored)
  reconnect! unless active?
end