module ActiveRecord::Tasks::DatabaseTasks
Active Record DatabaseTasks¶ ↑
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 Rails commands 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 (likeRails.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')
Constants
- LOCAL_HOSTS
Attributes
Public Class Methods
Extra flags passed to database CLI tool (mysqldump/pg_dump) when calling db:schema:dump It can be used as a string/array (the typical case) or a hash (when you use multiple adapters) Example:
ActiveRecord::Tasks::DatabaseTasks.structure_dump_flags = { mysql2: ['--no-defaults', '--skip-add-drop-table'], postgres: '--no-tablespaces' }
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 50 mattr_accessor :structure_dump_flags, instance_accessor: false
Extra flags passed to database CLI tool when calling db:schema:load It can be used as a string/array (the typical case) or a hash (when you use multiple adapters)
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 56 mattr_accessor :structure_load_flags, instance_accessor: false
Public Instance Methods
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 459 def cache_dump_filename(db_config_name, schema_cache_path: nil) filename = if ActiveRecord::Base.configurations.primary?(db_config_name) "schema_cache.yml" else "#{db_config_name}_schema_cache.yml" end schema_cache_path || ENV["SCHEMA_CACHE"] || File.join(ActiveRecord::Tasks::DatabaseTasks.db_dir, filename) end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 324 def charset(configuration, *arguments) db_config = resolve_configuration(configuration) database_adapter_for(db_config, *arguments).charset end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 319 def charset_current(env_name = env, db_name = name) db_config = configs_for(env_name: env_name, name: db_name) charset(db_config) end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 65 def check_protected_environments!(environment = env) return if ENV["DISABLE_DATABASE_ENVIRONMENT_CHECK"] configs_for(env_name: environment).each do |db_config| check_current_protected_environment!(db_config) end end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 477 def check_schema_file(filename) unless File.exist?(filename) message = +%{#{filename} doesn't exist yet. Run `bin/rails db:migrate` to create it, then try again.} 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 309 def check_target_version if target_version && !Migration.valid_version_format?(ENV["VERSION"]) raise "Invalid format of target version: `VERSION=#{ENV['VERSION']}`" end end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 503 def clear_schema_cache(filename) FileUtils.rm_f filename, verbose: false end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 334 def collation(configuration, *arguments) db_config = resolve_configuration(configuration) database_adapter_for(db_config, *arguments).collation end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 329 def collation_current(env_name = env, db_name = name) db_config = configs_for(env_name: env_name, name: db_name) collation(db_config) end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 115 def create(configuration, *arguments) db_config = resolve_configuration(configuration) database_adapter_for(db_config, *arguments).create $stdout.puts "Created database '#{db_config.database}'" if verbose? rescue DatabaseAlreadyExists $stderr.puts "Database '#{db_config.database}' already exists" if verbose? rescue Exception => error $stderr.puts error $stderr.puts "Couldn't create '#{db_config.database}' database. Please check your configuration." raise end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 127 def create_all each_local_configuration do |db_config| with_temporary_connection(db_config) do create(db_config) end end end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 170 def create_current(environment = env, name = nil) each_current_configuration(environment, name) { |db_config| create(db_config) } migration_class.establish_connection(environment.to_sym) end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 83 def db_dir @db_dir ||= Rails.application.config.paths["db"].first end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 223 def drop(configuration, *arguments) db_config = resolve_configuration(configuration) database_adapter_for(db_config, *arguments).drop $stdout.puts "Dropped database '#{db_config.database}'" if verbose? rescue ActiveRecord::NoDatabaseError $stderr.puts "Database '#{db_config.database}' does not exist" rescue Exception => error $stderr.puts error $stderr.puts "Couldn't drop database '#{db_config.database}'" raise end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 235 def drop_all each_local_configuration { |db_config| drop(db_config) } end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 239 def drop_current(environment = env) each_current_configuration(environment) { |db_config| drop(db_config) } 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 499 def dump_schema_cache(conn, filename) conn.schema_cache.dump_to(filename) end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 103 def env @env ||= Rails.env end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 91 def fixtures_path @fixtures_path ||= if ENV["FIXTURES_PATH"] File.join(root, ENV["FIXTURES_PATH"]) else File.join(root, "test", "fixtures") end end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 469 def load_schema_current(format = ActiveRecord.schema_format, file = nil, environment = env) each_current_configuration(environment) do |db_config| with_temporary_connection(db_config) do load_schema(db_config, format, file) end end end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 485 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 256 def migrate(version = nil) scope = ENV["SCOPE"] verbose_was, Migration.verbose = Migration.verbose, verbose? check_target_version migration_connection.migration_context.migrate(target_version) do |migration| if version.blank? scope.blank? || scope == migration.scope else migration.version == version end end.tap do |migrations_ran| Migration.write("No migrations ran. (using #{scope} scope)") if scope.present? && migrations_ran.empty? end migration_connection.schema_cache.clear! ensure Migration.verbose = verbose_was end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 294 def migrate_status unless migration_connection.schema_migration.table_exists? Kernel.abort "Schema migrations table does not exist yet." end # output puts "\ndatabase: #{migration_connection.pool.db_config.database}\n\n" puts "#{'Status'.center(8)} #{'Migration ID'.ljust(14)} Migration Name" puts "-" * 50 migration_connection.migration_context.migrations_status.each do |status, version, name| puts "#{status.center(8)} #{version.ljust(14)} #{name}" end puts end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 87 def migrations_paths @migrations_paths ||= Rails.application.paths["db/migrate"].to_a end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 107 def name @name ||= "primary" end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 176 def prepare_all seed = false dump_db_configs = [] each_current_configuration(env) do |db_config| with_temporary_pool(db_config) do begin database_initialized = migration_connection.schema_migration.table_exists? rescue ActiveRecord::NoDatabaseError create(db_config) retry end unless database_initialized if File.exist?(schema_dump_path(db_config)) load_schema(db_config, ActiveRecord.schema_format, nil) end seed = true end end end each_current_environment(env) do |environment| db_configs_with_versions(environment).sort.each do |version, db_configs| dump_db_configs |= db_configs db_configs.each do |db_config| with_temporary_pool(db_config) do migrate(version) end end end end # Dump schema for databases that were migrated. if ActiveRecord.dump_schema_after_migration dump_db_configs.each do |db_config| with_temporary_pool(db_config) do dump_schema(db_config) end end end load_seed if seed end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 339 def purge(configuration) db_config = resolve_configuration(configuration) database_adapter_for(db_config).purge end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 344 def purge_all each_local_configuration { |db_config| purge(db_config) } end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 348 def purge_current(environment = env) each_current_configuration(environment) { |db_config| purge(db_config) } migration_class.establish_connection(environment.to_sym) end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 73 def register_task(pattern, task) @tasks ||= {} @tasks[pattern] = task end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 99 def root @root ||= Rails.root end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 446 def schema_dump_path(db_config, format = ActiveRecord.schema_format) return ENV["SCHEMA"] if ENV["SCHEMA"] filename = db_config.schema_dump(format) return unless filename if File.dirname(filename) == ActiveRecord::Tasks::DatabaseTasks.db_dir filename else File.join(ActiveRecord::Tasks::DatabaseTasks.db_dir, filename) end end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 389 def schema_up_to_date?(configuration, format = ActiveRecord.schema_format, file = nil) db_config = resolve_configuration(configuration) file ||= schema_dump_path(db_config) return true unless file && File.exist?(file) with_temporary_connection(db_config) do |connection| return false unless connection.internal_metadata.enabled? return false unless connection.internal_metadata.table_exists? connection.internal_metadata[:schema_sha1] == schema_sha1(file) end end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 111 def seed_loader @seed_loader ||= Rails.application end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 354 def structure_dump(configuration, *arguments) db_config = resolve_configuration(configuration) filename = arguments.delete_at(0) flags = structure_dump_flags_for(db_config.adapter) database_adapter_for(db_config, *arguments).structure_dump(filename, flags) end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 361 def structure_load(configuration, *arguments) db_config = resolve_configuration(configuration) filename = arguments.delete_at(0) flags = structure_load_flags_for(db_config.adapter) database_adapter_for(db_config, *arguments).structure_load(filename, flags) end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 315 def target_version ENV["VERSION"].to_i if ENV["VERSION"] && !ENV["VERSION"].empty? end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 250 def truncate_all(environment = env) configs_for(env_name: environment).each do |db_config| truncate_tables(db_config) end end