Module: ActiveRecord::Tasks::DatabaseTasks

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 56

mattr_accessor :structure_load_flags, instance_accessor: false

# 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 60

attr_writer :db_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader

# 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 60

attr_writer :db_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader

# 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 60

attr_writer :db_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader

# 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 60

attr_writer :db_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader

# 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 60

attr_writer :db_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader

# 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 60

attr_writer :db_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 578

def verbose?
  ENV["VERBOSE"] ? ENV["VERBOSE"] != "false" : true
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 654

def check_current_protected_environment!(db_config)
  with_temporary_pool(db_config) do |pool|
    migration_context = pool.migration_context
    current = migration_context.current_environment
    stored  = migration_context.last_stored_environment

    if migration_context.protected_environment?
      raise ActiveRecord::ProtectedEnvironmentError.new(stored)
    end

    if stored && stored != current
      raise ActiveRecord::EnvironmentMismatchError.new(current: current, stored: stored)
    end
  rescue ActiveRecord::NoDatabaseError
  end
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 490

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 593

def class_for_adapter(adapter)
  _key, task = @tasks.reverse_each.detect { |pattern, _task| adapter[pattern] }
  unless task
    raise DatabaseNotSupported, "Rake tasks not supported by '#{adapter}' adapter"
  end
  task.is_a?(String) ? task.constantize : task
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 516

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 570

def configs_for(**options)
  Base.configurations.configs_for(**options)
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
  db_config = migration_connection.pool.db_config

  each_local_configuration { |db_config| create(db_config) }

  migration_class.establish_connection(db_config)
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 585

def database_adapter_for(db_config, *arguments)
  klass = class_for_adapter(db_config.adapter)
  converted = klass.respond_to?(:using_database_configurations?) && klass.using_database_configurations?

  config = converted ? db_config : db_config.configuration_hash
  klass.new(config, *arguments)
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 277

def db_configs_with_versions(environment = env) # :nodoc:
  db_configs_with_versions = Hash.new { |h, k| h[k] = [] }

  with_temporary_pool_for_each(env: environment) do |pool|
    db_config = pool.db_config
    versions_to_run = pool.migration_context.pending_migration_versions
    target_version = ActiveRecord::Tasks::DatabaseTasks.target_version

    versions_to_run.each do |version|
      next if target_version && target_version != version
      db_configs_with_versions[version] << db_config
    end
  end

  db_configs_with_versions
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

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 423

def dump_schema(db_config, format = ActiveRecord.schema_format) # :nodoc:
  return unless db_config.schema_dump

  require "active_record/schema_dumper"
  filename = schema_dump_path(db_config, format)
  return unless filename

  FileUtils.mkdir_p(db_dir)
  case format
  when :ruby
    File.open(filename, "w:utf-8") do |file|
      ActiveRecord::SchemaDumper.dump(migration_connection_pool, file)
    end
  when :sql
    structure_dump(db_config, filename)
    if migration_connection_pool.schema_migration.table_exists?
      File.open(filename, "a") do |f|
        f.puts migration_connection.dump_schema_information
        f.print "\n"
      end
    end
  end
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 512

def dump_schema_cache(conn_or_pool, filename)
  conn_or_pool.schema_cache.dump_to(filename)
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 601

def each_current_configuration(environment, name = nil)
  each_current_environment(environment) do |env|
    configs_for(env_name: env).each do |db_config|
      next if name && name != db_config.name

      yield db_config
    end
  end
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 611

def each_current_environment(environment, &block)
  environments = [environment]
  environments << "test" if environment == "development" && !ENV["SKIP_TEST_DATABASE"] && !ENV["DATABASE_URL"]
  environments.each(&block)
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 617

def each_local_configuration
  configs_for.each do |db_config|
    next unless db_config.database

    if local_database?(db_config)
      yield db_config
    else
      $stderr.puts "This task only modifies local databases. #{db_config.database} is on a remote host."
    end
  end
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 141

def for_each(databases) # :nodoc:
  return {} unless defined?(Rails)

  database_configs = ActiveRecord::DatabaseConfigurations.new(databases).configs_for(env_name: Rails.env)

  # if this is a single database application we don't want tasks for each primary database
  return if database_configs.count == 1

  database_configs.each do |db_config|
    next unless db_config.database_tasks?

    yield db_config.name
  end
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 368

def load_schema(db_config, format = ActiveRecord.schema_format, file = nil) # :nodoc:
  file ||= schema_dump_path(db_config, format)
  return unless file

  verbose_was, Migration.verbose = Migration.verbose, verbose? && ENV["VERBOSE"]
  check_schema_file(file)

  case format
  when :ruby
    load(file)
  when :sql
    structure_load(db_config, file)
  else
    raise ArgumentError, "unknown format #{format.inspect}"
  end

  migration_connection_pool.internal_metadata.create_table_and_set_flags(db_config.env_name, schema_sha1(file))
ensure
  Migration.verbose = verbose_was
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 482

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 498

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 629

def local_database?(db_config)
  host = db_config.host
  host.blank? || LOCAL_HOSTS.include?(host)
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_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

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 294

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

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 537

def migration_class # :nodoc:
  ActiveRecord::Base
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 541

def migration_connection # :nodoc:
  migration_class.lease_connection
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 545

def migration_connection_pool # :nodoc:
  migration_class.connection_pool
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_pool.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 156

def raise_for_multi_db(environment = env, command:) # :nodoc:
  db_configs = configs_for(env_name: environment)

  if db_configs.count > 1
    dbs_list = []

    db_configs.each do |db|
      dbs_list << "#{command}:#{db.name}"
    end

    raise "You're using a multiple database application. To use `#{command}` you must run the namespaced task with a VERSION. Available tasks are #{dbs_list.to_sentence}."
  end
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 405

def reconstruct_from_schema(db_config, format = ActiveRecord.schema_format, file = nil) # :nodoc:
  file ||= schema_dump_path(db_config, format)

  check_schema_file(file) if file

  with_temporary_pool(db_config, clobber: true) do
    if schema_up_to_date?(db_config, format, file)
      truncate_tables(db_config) unless ENV["SKIP_TEST_DATABASE_TRUNCATE"]
    else
      purge(db_config)
      load_schema(db_config, format, file)
    end
  rescue ActiveRecord::NoDatabaseError
    create(db_config)
    load_schema(db_config, format, file)
  end
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 574

def resolve_configuration(configuration)
  Base.configurations.resolve(configuration)
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 550

def schema_cache_env
  if ENV["SCHEMA_CACHE"]
    ActiveRecord.deprecator.warn(<<~MSG.squish)
      Setting `ENV["SCHEMA_CACHE"]` is deprecated and will be removed in Rails 8.0.
      Configure the `:schema_cache_path` in the database configuration instead.
    MSG

    nil
  end
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 447

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 634

def schema_sha1(file)
  OpenSSL::Digest::SHA1.hexdigest(File.read(file))
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_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

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 135

def setup_initial_database_yaml # :nodoc:
  return {} unless defined?(Rails)

  Rails.application.config.load_database_yaml
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 638

def structure_dump_flags_for(adapter)
  if structure_dump_flags.is_a?(Hash)
    structure_dump_flags[adapter.to_sym]
  else
    structure_dump_flags
  end
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 646

def structure_load_flags_for(adapter)
  if structure_load_flags.is_a?(Hash)
    structure_load_flags[adapter.to_sym]
  else
    structure_load_flags
  end
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

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 243

def truncate_tables(db_config)
  with_temporary_connection(db_config) do |conn|
    conn.truncate_tables(*conn.tables)
  end
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 531

def with_temporary_connection(db_config, clobber: false, &block) # :nodoc:
  with_temporary_pool(db_config, clobber: clobber) do |pool|
    pool.with_connection(&block)
  end
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 561

def with_temporary_pool(db_config, clobber: false)
  original_db_config = migration_class.connection_db_config
  pool = migration_class.connection_handler.establish_connection(db_config, clobber: clobber)

  yield pool
ensure
  migration_class.connection_handler.establish_connection(original_db_config, clobber: clobber)
end

# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 520

def with_temporary_pool_for_each(env: ActiveRecord::Tasks::DatabaseTasks.env, name: nil, clobber: false, &block) # :nodoc:
  if name
    db_config = ActiveRecord::Base.configurations.configs_for(env_name: env, name: name)
    with_temporary_pool(db_config, clobber: clobber, &block)
  else
    ActiveRecord::Base.configurations.configs_for(env_name: env, name: name).each do |db_config|
      with_temporary_pool(db_config, clobber: clobber, &block)
    end
  end
end