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:

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

Constants

LOCAL_HOSTS = ["127.0.0.1", "localhost"]

Attributes

[RW] database_configuration
[W] db_dir
[W] env
[W] fixtures_path
[W] migrations_paths
[W] root
[W] seed_loader

Class Public methods

structure_dump_flags

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'],
  postgresql: '--no-tablespaces'
}
πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 50
mattr_accessor :structure_dump_flags, instance_accessor: false
πŸ”Ž See on GitHub

structure_load_flags

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)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 56
mattr_accessor :structure_load_flags, instance_accessor: false
πŸ”Ž See on GitHub

Instance Public methods

cache_dump_filename(db_config, schema_cache_path: nil)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 484
def cache_dump_filename(db_config, schema_cache_path: nil)
  schema_cache_path ||
    db_config.schema_cache_path ||
    db_config.default_schema_cache_path(ActiveRecord::Tasks::DatabaseTasks.db_dir)
end
πŸ”Ž See on GitHub

charset(configuration, *arguments)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 330
def charset(configuration, *arguments)
  db_config = resolve_configuration(configuration)
  database_adapter_for(db_config, *arguments).charset
end
πŸ”Ž See on GitHub

charset_current(env_name = env, db_name = name)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 325
def charset_current(env_name = env, db_name = name)
  db_config = configs_for(env_name: env_name, name: db_name)
  charset(db_config)
end
πŸ”Ž See on GitHub

check_protected_environments!(environment = env)

πŸ“ Source code
# 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|
    database_adapter_for(db_config).check_current_protected_environment!(db_config, migration_class)
  end
end
πŸ”Ž See on GitHub

check_schema_file(filename)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 498
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
πŸ”Ž See on GitHub

check_target_version()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 315
def check_target_version
  if target_version && !Migration.valid_version_format?(ENV["VERSION"])
    raise "Invalid format of target version: `VERSION=#{ENV['VERSION']}`"
  end
end
πŸ”Ž See on GitHub

clear_schema_cache(filename)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 524
def clear_schema_cache(filename)
  FileUtils.rm_f filename, verbose: false
end
πŸ”Ž See on GitHub

collation(configuration, *arguments)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 340
def collation(configuration, *arguments)
  db_config = resolve_configuration(configuration)
  database_adapter_for(db_config, *arguments).collation
end
πŸ”Ž See on GitHub

collation_current(env_name = env, db_name = name)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 335
def collation_current(env_name = env, db_name = name)
  db_config = configs_for(env_name: env_name, name: db_name)
  collation(db_config)
end
πŸ”Ž See on GitHub

create(configuration, *arguments)

πŸ“ Source code
# 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
πŸ”Ž See on GitHub

create_all()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 127
def create_all
  db_config = migration_connection.pool.db_config

  each_local_configuration { |db_config| create(db_config) }

  migration_class.establish_connection(db_config)
end
πŸ”Ž See on GitHub

create_current(environment = env, name = nil)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 168
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
πŸ”Ž See on GitHub

db_dir()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 83
def db_dir
  @db_dir ||= Rails.application.config.paths["db"].first
end
πŸ”Ž See on GitHub

drop(configuration, *arguments)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 208
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
πŸ”Ž See on GitHub

drop_all()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 220
def drop_all
  each_local_configuration { |db_config| drop(db_config) }
end
πŸ”Ž See on GitHub

drop_current(environment = env)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 224
def drop_current(environment = env)
  each_current_configuration(environment) { |db_config| drop(db_config) }
end
πŸ”Ž See on GitHub

dump_all()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 430
def dump_all
  seen_schemas = []

  ActiveRecord::Base.configurations.configs_for(env_name: ActiveRecord::Tasks::DatabaseTasks.env).each do |db_config|
    schema_path = schema_dump_path(db_config, ENV["SCHEMA_FORMAT"] || db_config.schema_format)

    next if seen_schemas.include?(schema_path)

    ActiveRecord::Tasks::DatabaseTasks.dump_schema(db_config, ENV["SCHEMA_FORMAT"] || db_config.schema_format)
    seen_schemas << schema_path
  end
end
πŸ”Ž See on GitHub

dump_schema_cache(conn_or_pool, filename)

Dumps the schema cache in YAML format for the connection into the file

Examples

ActiveRecord::Tasks::DatabaseTasks.dump_schema_cache(ActiveRecord::Base.lease_connection, "tmp/schema_dump.yaml")
πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 520
def dump_schema_cache(conn_or_pool, filename)
  conn_or_pool.schema_cache.dump_to(filename)
end
πŸ”Ž See on GitHub

env()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 103
def env
  @env ||= Rails.env
end
πŸ”Ž See on GitHub

fixtures_path()

πŸ“ Source code
# 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
πŸ”Ž See on GitHub

load_schema_current(format = nil, file = nil, environment = env)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 490
def load_schema_current(format = nil, file = nil, environment = env)
  each_current_configuration(environment) do |db_config|
    with_temporary_connection(db_config) do
      load_schema(db_config, format || db_config.schema_format, file)
    end
  end
end
πŸ”Ž See on GitHub

load_seed()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 506
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
πŸ”Ž See on GitHub

migrate(version = nil, skip_initialize: false)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 260
def migrate(version = nil, skip_initialize: false)
  scope = ENV["SCOPE"]
  verbose_was, Migration.verbose = Migration.verbose, verbose?

  check_target_version

  initialize_database(migration_connection_pool.db_config) unless skip_initialize

  migration_connection_pool.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_pool.schema_cache.clear!
ensure
  Migration.verbose = verbose_was
end
πŸ”Ž See on GitHub

migrate_all()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 241
def migrate_all
  db_configs = ActiveRecord::Base.configurations.configs_for(env_name: ActiveRecord::Tasks::DatabaseTasks.env)
  db_configs.each { |db_config| initialize_database(db_config) }

  if db_configs.size == 1 && db_configs.first.primary?
    ActiveRecord::Tasks::DatabaseTasks.migrate(skip_initialize: true)
  else
    mapped_versions = ActiveRecord::Tasks::DatabaseTasks.db_configs_with_versions

    mapped_versions.sort.each do |version, db_configs|
      db_configs.each do |db_config|
        ActiveRecord::Tasks::DatabaseTasks.with_temporary_connection(db_config) do
          ActiveRecord::Tasks::DatabaseTasks.migrate(version, skip_initialize: true)
        end
      end
    end
  end
end
πŸ”Ž See on GitHub

migrate_status()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 300
def migrate_status
  unless migration_connection_pool.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_pool.migration_context.migrations_status.each do |status, version, name|
    puts "#{status.center(8)}  #{version.ljust(14)}  #{name}"
  end
  puts
end
πŸ”Ž See on GitHub

migrations_paths()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 87
def migrations_paths
  @migrations_paths ||= Rails.application.paths["db/migrate"].to_a
end
πŸ”Ž See on GitHub

name()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 107
def name
  @name ||= "primary"
end
πŸ”Ž See on GitHub

prepare_all()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 174
def prepare_all
  seed = false
  dump_db_configs = []

  each_current_configuration(env) do |db_config|
    database_initialized = initialize_database(db_config)

    seed = true if database_initialized && db_config.seeds?
  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
πŸ”Ž See on GitHub

purge(configuration)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 345
def purge(configuration)
  db_config = resolve_configuration(configuration)
  database_adapter_for(db_config).purge
end
πŸ”Ž See on GitHub

purge_all()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 350
def purge_all
  each_local_configuration { |db_config| purge(db_config) }
end
πŸ”Ž See on GitHub

purge_current(environment = env)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 354
def purge_current(environment = env)
  each_current_configuration(environment) { |db_config| purge(db_config) }

  migration_class.establish_connection(environment.to_sym)
end
πŸ”Ž See on GitHub

register_task(pattern, task)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 73
def register_task(pattern, task)
  @tasks ||= {}
  @tasks[pattern] = task
end
πŸ”Ž See on GitHub

root()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 99
def root
  @root ||= Rails.root
end
πŸ”Ž See on GitHub

schema_dump_path(db_config, format = db_config.schema_format)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 471
def schema_dump_path(db_config, format = db_config.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
πŸ”Ž See on GitHub

schema_up_to_date?(configuration, _ = nil, file = nil)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 396
def schema_up_to_date?(configuration, _ = nil, file = nil)
  db_config = resolve_configuration(configuration)

  file ||= schema_dump_path(db_config)

  return true unless file && File.exist?(file)

  with_temporary_pool(db_config) do |pool|
    internal_metadata = pool.internal_metadata
    return false unless internal_metadata.enabled?
    return false unless internal_metadata.table_exists?

    internal_metadata[:schema_sha1] == schema_sha1(file)
  end
end
πŸ”Ž See on GitHub

seed_loader()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 111
def seed_loader
  @seed_loader ||= Rails.application
end
πŸ”Ž See on GitHub

structure_dump(configuration, *arguments)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 360
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
πŸ”Ž See on GitHub

structure_load(configuration, *arguments)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 367
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
πŸ”Ž See on GitHub

target_version()

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 321
def target_version
  ENV["VERSION"].to_i if ENV["VERSION"] && !ENV["VERSION"].empty?
end
πŸ”Ž See on GitHub

truncate_all(environment = env)

πŸ“ Source code
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 235
def truncate_all(environment = env)
  configs_for(env_name: environment).each do |db_config|
    truncate_tables(db_config)
  end
end
πŸ”Ž See on GitHub