- Inheritance
- < Object
- Included Modules
- Quoting, DatabaseStatements, SchemaStatements, QueryCache, ActiveSupport::Callbacks
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.
Methods
Instance
| Visibility | Signature |
|---|---|
| public | active? () |
| public | adapter_name () |
| public | create_savepoint () |
| public | current_savepoint_name () |
| public | decrement_open_transactions () |
| public | disable_referential_integrity () {|| ...} |
| public | disconnect! () |
| public | increment_open_transactions () |
| public | log_info (sql, name, ms) |
| public | open_transactions () |
| public | prefetch_primary_key? (table_name = nil) |
| public | quote_table_name (name) |
| public | raw_connection () |
| public | reconnect! () |
| public | release_savepoint () |
| public | requires_reloading? () |
| public | reset! () |
| public | rollback_to_savepoint () |
| public | supports_count_distinct? () |
| public | supports_ddl_transactions? () |
| public | supports_migrations? () |
| public | supports_savepoints? () |
| public | transaction_joinable= (joinable) |
| public | verify! (*ignored) |
| protected | format_log_entry (message, dump = nil) |
| protected | log (sql, name) {|| ...} |
Instance Method Detail
active?()
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.
adapter_name()
Returns the human-readable name of the adapter. Use mixed case - one can always use downcase if needed.
create_savepoint()
current_savepoint_name()
decrement_open_transactions()
disable_referential_integrity() {|| ...}
Override to turn off referential integrity while executing &block.
disconnect!()
Disconnects from the database if already connected. Otherwise, this method does nothing.
increment_open_transactions()
log_info(sql, name, ms)
open_transactions()
prefetch_primary_key?(table_name = nil)
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.
quote_table_name(name)
Override to return the quoted table name. Defaults to column quoting.
raw_connection()
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.
reconnect!()
Disconnects from the database if already connected, and establishes a new connection with the database.
release_savepoint()
requires_reloading?()
Returns true if its safe to reload the connection between requests for development mode.
reset!()
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.
rollback_to_savepoint()
supports_count_distinct?()
Does this adapter support using DISTINCT within COUNT? This is true for all adapters except sqlite.
supports_ddl_transactions?()
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.
supports_migrations?()
Does this adapter support migrations? Backend specific, as the abstract adapter always returns false.
supports_savepoints?()
Does this adapter support savepoints? PostgreSQL and MySQL do, SQLite does not.
transaction_joinable=(joinable)
verify!(*ignored)
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.