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 with 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:
* +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:
include ActiveRecord::Tasks
DatabaseTasks.database_configuration = YAML.load_file('my_database_config.yml')
DatabaseTasks.db_dir = 'db'
# other settings...
DatabaseTasks.create_current('production')
Methods
- C
- D
- E
- F
- L
- M
- P
- R
- S
Constants
LOCAL_HOSTS | = | ['127.0.0.1', 'localhost'] |
Attributes
[W] | current_config | |
[RW] | database_configuration | |
[W] | db_dir | |
[W] | env | |
[W] | fixtures_path | |
[W] | migrations_paths | |
[W] | root | |
[W] | seed_loader |
Instance Public methods
charset(*arguments)
Link
charset_current(environment = env)
Link
check_schema_file(filename)
Link
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 243 def check_schema_file(filename) unless File.exist?(filename) message = %Q{#{filename} doesn't exist yet. Run `rake db:migrate` to create it, then try again.} message << %Q{ If you do not intend to use a database, you should instead alter #{Rails.root}/config/application.rb to limit the frameworks that will be loaded.} if defined?(::Rails) Kernel.abort message end end
collation(*arguments)
Link
collation_current(environment = env)
Link
create(*arguments)
Link
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 91 def create(*arguments) configuration = arguments.first class_for_adapter(configuration['adapter']).new(*arguments).create rescue DatabaseAlreadyExists $stderr.puts "#{configuration['database']} already exists" rescue Exception => error $stderr.puts error, *(error.backtrace) $stderr.puts "Couldn't create database for #{configuration.inspect}" end
create_all()
Link
create_current(environment = env)
Link
current_config(options = {})
Link
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 82 def current_config(options = {}) options.reverse_merge! :env => env if options.has_key?(:config) @current_config = options[:config] else @current_config ||= ActiveRecord::Base.configurations[options[:env]] end end
db_dir()
Link
drop(*arguments)
Link
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 112 def drop(*arguments) configuration = arguments.first class_for_adapter(configuration['adapter']).new(*arguments).drop rescue ActiveRecord::NoDatabaseError $stderr.puts "Database '#{configuration['database']}' does not exist" rescue Exception => error $stderr.puts error, *(error.backtrace) $stderr.puts "Couldn't drop #{configuration['database']}" end
drop_all()
Link
drop_current(environment = env)
Link
env()
Link
fixtures_path()
Link
load_schema(format = ActiveRecord::Base.schema_format, file = nil)
Link
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 194 def load_schema(format = ActiveRecord::Base.schema_format, file = nil) ActiveSupport::Deprecation.warn(" This method will act on a specific connection in the future. To act on the current connection, use `load_schema_current` instead. ".squish) load_schema_current(format, file) end
load_schema_current(format = ActiveRecord::Base.schema_format, file = nil, environment = env)
Link
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 236 def load_schema_current(format = ActiveRecord::Base.schema_format, file = nil, environment = env) each_current_configuration(environment) { |configuration| load_schema_for configuration, format, file } ActiveRecord::Base.establish_connection(environment.to_sym) end
load_schema_current_if_exists(format = ActiveRecord::Base.schema_format, file = nil, environment = env)
Link
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 230 def load_schema_current_if_exists(format = ActiveRecord::Base.schema_format, file = nil, environment = env) if File.exist?(file || schema_file(format)) load_schema_current(format, file, environment) end end
load_seed()
Link
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 251 def load_seed if seed_loader seed_loader.load_seed else raise "You tried to load seed data, but no seed loader is specified. Please specify seed " + "loader with ActiveRecord::Tasks::DatabaseTasks.seed_loader = your_seed_loader\n" + "Seed loader should respond to load_seed method" end end
migrate()
Link
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 132 def migrate raise "Empty VERSION provided" if ENV["VERSION"] && ENV["VERSION"].empty? verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil scope = ENV['SCOPE'] verbose_was, Migration.verbose = Migration.verbose, verbose Migrator.migrate(migrations_paths, version) do |migration| scope.blank? || scope == migration.scope end ActiveRecord::Base.clear_cache! ensure Migration.verbose = verbose_was end
migrations_paths()
Link
purge(configuration)
Link
purge_all()
Link
purge_current(environment = env)
Link
register_task(pattern, task)
Link
root()
Link
schema_file(format = ActiveRecord::Base.schema_format)
Link
seed_loader()
Link
structure_dump(*arguments)
Link
structure_load(*arguments)
Link