Type:
Module
Constants:
LOCAL_HOSTS : ['127.0.0.1', 'localhost']

ActiveRecord::Tasks::DatabaseTasks is a utility class, which encapsulates logic behind common tasks used to manage database and migrations.

The tasks defined here are used in rake tasks provided by Active Record.

In order to use DatabaseTasks, a few config values need to be set. All the needed config values are set by Rails already, so it's necessary to do it only if you want to change the defaults or when you want to use Active Record outside of Rails (in such case after configuring the database tasks, you can also use the rake tasks defined in Active Record).

The possible config values are:

1
2
3
4
5
6
7
* +env+: current environment (like Rails.env).
* +database_configuration+: configuration of your databases (as in +config/database.yml+).
* +db_dir+: your +db+ directory.
* +fixtures_path+: a path to fixtures directory.
* +migrations_paths+: a list of paths to directories with migrations.
* +seed_loader+: an object which will load seeds, it needs to respond to the +load_seed+ method.
* +root+: a path to the root of the application.

Example usage of DatabaseTasks outside Rails could look as such:

1
2
3
4
5
6
include ActiveRecord::Tasks
DatabaseTasks.database_configuration = YAML.load(File.read('my_database_config.yml'))
DatabaseTasks.db_dir = 'db'
# other settings...
 
DatabaseTasks.create_current('production')
collation_current
  • References/Ruby on Rails/Rails/Classes/ActiveRecord/ActiveRecord::Tasks/ActiveRecord::Tasks::DatabaseTasks

collation_current(environment = env) Instance Public methods

2025-01-10 15:47:30
check_schema_file
  • References/Ruby on Rails/Rails/Classes/ActiveRecord/ActiveRecord::Tasks/ActiveRecord::Tasks::DatabaseTasks

check_schema_file(filename) Instance Public methods

2025-01-10 15:47:30
drop_current
  • References/Ruby on Rails/Rails/Classes/ActiveRecord/ActiveRecord::Tasks/ActiveRecord::Tasks::DatabaseTasks

drop_current(environment = env) Instance Public methods

2025-01-10 15:47:30
load_seed
  • References/Ruby on Rails/Rails/Classes/ActiveRecord/ActiveRecord::Tasks/ActiveRecord::Tasks::DatabaseTasks

load_seed() Instance Public methods

2025-01-10 15:47:30
current_config
  • References/Ruby on Rails/Rails/Classes/ActiveRecord/ActiveRecord::Tasks/ActiveRecord::Tasks::DatabaseTasks

current_config(options = {}) Instance Public methods

2025-01-10 15:47:30
structure_load
  • References/Ruby on Rails/Rails/Classes/ActiveRecord/ActiveRecord::Tasks/ActiveRecord::Tasks::DatabaseTasks

structure_load(*arguments) Instance Public methods

2025-01-10 15:47:30
root
  • References/Ruby on Rails/Rails/Classes/ActiveRecord/ActiveRecord::Tasks/ActiveRecord::Tasks::DatabaseTasks

root() Instance Public methods

2025-01-10 15:47:30
register_task
  • References/Ruby on Rails/Rails/Classes/ActiveRecord/ActiveRecord::Tasks/ActiveRecord::Tasks::DatabaseTasks

register_task(pattern, task) Instance Public methods

2025-01-10 15:47:30
charset_current
  • References/Ruby on Rails/Rails/Classes/ActiveRecord/ActiveRecord::Tasks/ActiveRecord::Tasks::DatabaseTasks

charset_current(environment = env) Instance Public methods

2025-01-10 15:47:30
fixtures_path
  • References/Ruby on Rails/Rails/Classes/ActiveRecord/ActiveRecord::Tasks/ActiveRecord::Tasks::DatabaseTasks

fixtures_path() Instance Public methods

2025-01-10 15:47:30