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 inconfig/database.yml
). -
db_dir
: yourdb
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 theload_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')
- C
- D
- E
- F
- L
- M
- P
- R
- S
- T
LOCAL_HOSTS | = | ["127.0.0.1", "localhost"] |
[W] | current_config | |
[RW] | database_configuration | |
[W] | db_dir | |
[W] | env | |
[W] | fixtures_path | |
[W] | migrations_paths | |
[W] | root | |
[W] | seed_loader |
Extra flags passed to database CLI tool (mysqldump/pg_dump) when calling db:structure:dump
Extra flags passed to database CLI tool when calling db:structure:load
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 54 def check_protected_environments! unless ENV["DISABLE_DATABASE_ENVIRONMENT_CHECK"] current = ActiveRecord::Base.connection.migration_context.current_environment stored = ActiveRecord::Base.connection.migration_context.last_stored_environment if ActiveRecord::Base.connection.migration_context.protected_environment? raise ActiveRecord::ProtectedEnvironmentError.new(stored) end if stored && stored != current raise ActiveRecord::EnvironmentMismatchError.new(current: current, stored: stored) end end rescue ActiveRecord::NoDatabaseError end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 270 def check_schema_file(filename) unless File.exist?(filename) message = %{#{filename} doesn't exist yet. Run `rails db:migrate` to create it, then try again.}.dup message << %{ 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.root) Kernel.abort message end end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 179 def check_target_version if target_version && !(Migration::MigrationFilenameRegexp.match?(ENV["VERSION"]) || /\A\d+\z/.match?(ENV["VERSION"])) raise "Invalid format of target version: `VERSION=#{ENV['VERSION']}`" end end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 116 def create(*arguments) configuration = arguments.first class_for_adapter(configuration["adapter"]).new(*arguments).create $stdout.puts "Created database '#{configuration['database']}'" rescue DatabaseAlreadyExists $stderr.puts "Database '#{configuration['database']}' already exists" rescue Exception => error $stderr.puts error $stderr.puts "Couldn't create database for #{configuration.inspect}" raise end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 128 def create_all old_pool = ActiveRecord::Base.connection_handler.retrieve_connection_pool(ActiveRecord::Base.connection_specification_name) each_local_configuration { |configuration| create configuration } if old_pool ActiveRecord::Base.connection_handler.establish_connection(old_pool.spec.to_hash) end end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 107 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
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 143 def drop(*arguments) configuration = arguments.first class_for_adapter(configuration["adapter"]).new(*arguments).drop $stdout.puts "Dropped database '#{configuration['database']}'" rescue ActiveRecord::NoDatabaseError $stderr.puts "Database '#{configuration['database']}' does not exist" rescue Exception => error $stderr.puts error $stderr.puts "Couldn't drop database '#{configuration['database']}'" raise end
Dumps the schema cache in YAML format for the connection into the file
Examples:
ActiveRecord::Tasks::DatabaseTasks.dump_schema_cache(ActiveRecord::Base.connection, "tmp/schema_dump.yaml")
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 263 def load_schema_current(format = ActiveRecord::Base.schema_format, file = nil, environment = env) each_current_configuration(environment) { |configuration, configuration_environment| load_schema configuration, format, file, configuration_environment } ActiveRecord::Base.establish_connection(environment.to_sym) end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 278 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
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 165 def migrate check_target_version verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] != "false" : true scope = ENV["SCOPE"] verbose_was, Migration.verbose = Migration.verbose, verbose Base.connection.migration_context.migrate(target_version) do |migration| scope.blank? || scope == migration.scope end ActiveRecord::Base.clear_cache! ensure Migration.verbose = verbose_was end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 224 def structure_dump(*arguments) configuration = arguments.first filename = arguments.delete_at 1 class_for_adapter(configuration["adapter"]).new(*arguments).structure_dump(filename, structure_dump_flags) end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 230 def structure_load(*arguments) configuration = arguments.first filename = arguments.delete_at 1 class_for_adapter(configuration["adapter"]).new(*arguments).structure_load(filename, structure_load_flags) end