Methods
C
E
R
Instance Public methods
connected?()

Returns true if Active Record is connected.

# File activerecord/lib/active_record/connection_handling.rb, line 83
def connected?
  connection_handler.connected?(self)
end
connection()

Returns the connection currently associated with the class. This can also be used to “borrow” the connection to do database work unrelated to any of the specific Active Records.

# File activerecord/lib/active_record/connection_handling.rb, line 52
def connection
  retrieve_connection
end
connection_config()

Returns the configuration of the associated connection as a hash:

ActiveRecord::Base.connection_config
# => {pool: 5, timeout: 5000, database: "db/development.sqlite3", adapter: "sqlite3"}

Please use only for reading.

# File activerecord/lib/active_record/connection_handling.rb, line 70
def connection_config
  connection_pool.spec.config
end
connection_id()
# File activerecord/lib/active_record/connection_handling.rb, line 56
def connection_id
  ActiveRecord::RuntimeRegistry.connection_id
end
connection_id=(connection_id)
# File activerecord/lib/active_record/connection_handling.rb, line 60
def connection_id=(connection_id)
  ActiveRecord::RuntimeRegistry.connection_id = connection_id
end
connection_pool()
# File activerecord/lib/active_record/connection_handling.rb, line 74
def connection_pool
  connection_handler.retrieve_connection_pool(self) or raise ConnectionNotEstablished
end
establish_connection(spec = ENV["DATABASE_URL"])

Establishes the connection to the database. Accepts a hash as input where the :adapter key must be specified with the name of a database adapter (in lower-case) example for regular databases (MySQL, Postgresql, etc):

ActiveRecord::Base.establish_connection(
  adapter:  "mysql",
  host:     "localhost",
  username: "myuser",
  password: "mypass",
  database: "somedatabase"
)

Example for SQLite database:

ActiveRecord::Base.establish_connection(
  adapter:  "sqlite3",
  database: "path/to/dbfile"
)

Also accepts keys as strings (for parsing from YAML for example):

ActiveRecord::Base.establish_connection(
  "adapter"  => "sqlite3",
  "database" => "path/to/dbfile"
)

Or a URL:

ActiveRecord::Base.establish_connection(
  "postgres://myuser:mypass@localhost/somedatabase"
)

The exceptions AdapterNotSpecified, AdapterNotFound and ArgumentError may be returned on an error.

# File activerecord/lib/active_record/connection_handling.rb, line 37
def establish_connection(spec = ENV["DATABASE_URL"])
  resolver = ConnectionAdapters::ConnectionSpecification::Resolver.new spec, configurations
  spec = resolver.spec

  unless respond_to?(spec.adapter_method)
    raise AdapterNotFound, "database configuration specifies nonexistent #{spec.config[:adapter]} adapter"
  end

  remove_connection
  connection_handler.establish_connection self, spec
end
remove_connection(klass = self)
# File activerecord/lib/active_record/connection_handling.rb, line 87
def remove_connection(klass = self)
  connection_handler.remove_connection(klass)
end
retrieve_connection()
# File activerecord/lib/active_record/connection_handling.rb, line 78
def retrieve_connection
  connection_handler.retrieve_connection(self)
end