Module: ActiveRecord::Tasks::DatabaseTasks
Relationships & Source Files | |
Defined in: | activerecord/lib/active_record/tasks/database_tasks.rb |
Overview
Active Record DatabaseTasks
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:
-
#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')
Constant Summary
-
LOCAL_HOSTS =
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 63["127.0.0.1", "localhost"]
Class Attribute Summary
-
.structure_dump_flags
rw
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:
-
.structure_load_flags
rw
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).
Instance Attribute Summary
- #database_configuration rw
- #db_dir rw
- #db_dir=(value) rw
- #env rw
- #env=(value) rw
- #fixtures_path rw
- #fixtures_path=(value) rw
- #migrations_paths rw
- #migrations_paths=(value) rw
- #root rw
- #root=(value) rw
- #seed_loader rw
- #seed_loader=(value) rw
- #verbose? ⇒ Boolean readonly private
Instance Method Summary
- #cache_dump_filename(db_config, schema_cache_path: nil)
- #charset(configuration, *arguments)
- #charset_current(env_name = env, db_name = name)
- #check_protected_environments!(environment = env)
- #check_schema_file(filename)
- #check_target_version
- #clear_schema_cache(filename)
- #collation(configuration, *arguments)
- #collation_current(env_name = env, db_name = name)
- #create(configuration, *arguments)
- #create_all
- #create_current(environment = env, name = nil)
- #drop(configuration, *arguments)
- #drop_all
- #drop_current(environment = env)
-
#dump_schema_cache(conn_or_pool, filename)
Dumps the schema cache in YAML format for the connection into the file.
- #load_schema_current(format = ActiveRecord.schema_format, file = nil, environment = env)
- #load_seed
- #migrate(version = nil, skip_initialize: false)
- #migrate_all
- #migrate_status
- #name
- #prepare_all
- #purge(configuration)
- #purge_all
- #purge_current(environment = env)
- #register_task(pattern, task)
- #schema_dump_path(db_config, format = ActiveRecord.schema_format)
- #schema_up_to_date?(configuration, format = ActiveRecord.schema_format, file = nil) ⇒ Boolean
- #structure_dump(configuration, *arguments)
- #structure_load(configuration, *arguments)
- #target_version
- #truncate_all(environment = env)
- #check_current_protected_environment!(db_config) private
- #class_for_adapter(adapter) private
- #configs_for(**options) private
-
#database_adapter_for(db_config, *arguments)
private
Create a new instance for the specified db configuration object For classes that have been converted to use db_config objects, pass a
DatabaseConfig
, otherwise pass a::Hash
- #each_current_configuration(environment, name = nil) private
- #each_current_environment(environment, &block) private
- #each_local_configuration private
- #initialize_database(db_config) private
- #local_database?(db_config) ⇒ Boolean private
- #resolve_configuration(configuration) private
- #schema_sha1(file) private
- #structure_dump_flags_for(adapter) private
- #structure_load_flags_for(adapter) private
- #truncate_tables(db_config) private
- #with_temporary_pool(db_config, clobber: false) private
- #db_configs_with_versions(environment = env) Internal use only
- #dump_schema(db_config, format = ActiveRecord.schema_format) Internal use only
- #for_each(databases) Internal use only
- #load_schema(db_config, format = ActiveRecord.schema_format, file = nil) Internal use only
- #migration_class Internal use only
- #migration_connection Internal use only
- #migration_connection_pool Internal use only
- #raise_for_multi_db(environment = env, command:) Internal use only
- #reconstruct_from_schema(db_config, format = ActiveRecord.schema_format, file = nil) Internal use only
- #setup_initial_database_yaml Internal use only
- #with_temporary_connection(db_config, clobber: false, &block) Internal use only
- #with_temporary_pool_for_each(env: ActiveRecord::Tasks::DatabaseTasks.env, name: nil, clobber: false, &block) Internal use only
Class Attribute Details
.structure_dump_flags (rw)
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
.structure_load_flags (rw)
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
Instance Attribute Details
#database_configuration (rw)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 61
attr_accessor :database_configuration
#db_dir (rw)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 83
def db_dir @db_dir ||= Rails.application.config.paths["db"].first end
#db_dir=(value) (rw)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 60
attr_writer :db_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader
#env (rw)
[ GitHub ]#env=(value) (rw)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 60
attr_writer :db_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader
#fixtures_path (rw)
[ GitHub ]#fixtures_path=(value) (rw)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 60
attr_writer :db_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader
#migrations_paths (rw)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 87
def migrations_paths @migrations_paths ||= Rails.application.paths["db/migrate"].to_a end
#migrations_paths=(value) (rw)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 60
attr_writer :db_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader
#root (rw)
[ GitHub ]#root=(value) (rw)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 60
attr_writer :db_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader
#seed_loader (rw)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 111
def seed_loader @seed_loader ||= Rails.application end
#seed_loader=(value) (rw)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 60
attr_writer :db_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader
#verbose? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 559
def verbose? ENV["VERBOSE"] ? ENV["VERBOSE"] != "false" : true end
Instance Method Details
#cache_dump_filename(db_config, schema_cache_path: nil)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 468
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
#charset(configuration, *arguments)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 332
def charset(configuration, *arguments) db_config = resolve_configuration(configuration) database_adapter_for(db_config, *arguments).charset end
#charset_current(env_name = env, db_name = name)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 327
def charset_current(env_name = env, db_name = name) db_config = configs_for(env_name: env_name, name: db_name) charset(db_config) end
#check_current_protected_environment!(db_config) (private)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 635
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
#check_protected_environments!(environment = env)
[ GitHub ]# 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
#check_schema_file(filename)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 482
def check_schema_file(filename) unless File.exist?(filename) = +%{#{filename} doesn't exist yet. Run `bin/rails db:migrate` to create it, then try again.} << %{ 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 end end
#check_target_version
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 317
def check_target_version if target_version && !Migration.valid_version_format?(ENV["VERSION"]) raise "Invalid format of target version: `VERSION=#{ENV['VERSION']}`" end end
#class_for_adapter(adapter) (private)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 574
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
#clear_schema_cache(filename)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 508
def clear_schema_cache(filename) FileUtils.rm_f filename, verbose: false end
#collation(configuration, *arguments)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 342
def collation(configuration, *arguments) db_config = resolve_configuration(configuration) database_adapter_for(db_config, *arguments).collation end
#collation_current(env_name = env, db_name = name)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 337
def collation_current(env_name = env, db_name = name) db_config = configs_for(env_name: env_name, name: db_name) collation(db_config) end
#configs_for(**options) (private)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 551
def configs_for(** ) Base.configurations.configs_for(** ) end
#create(configuration, *arguments)
[ GitHub ]# 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
#create_all
[ GitHub ]# 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
#create_current(environment = env, name = nil)
[ GitHub ]# 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
#database_adapter_for(db_config, *arguments) (private)
Create a new instance for the specified db configuration object For classes that have been converted to use db_config objects, pass a DatabaseConfig
, otherwise pass a ::Hash
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 566
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
#db_configs_with_versions(environment = env)
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 285
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
#drop(configuration, *arguments)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 210
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
#drop_all
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 222
def drop_all each_local_configuration { |db_config| drop(db_config) } end
#drop_current(environment = env)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 226
def drop_current(environment = env) each_current_configuration(environment) { |db_config| drop(db_config) } end
#dump_schema(db_config, format = ActiveRecord.schema_format)
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 431
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
#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")
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 504
def dump_schema_cache(conn_or_pool, filename) conn_or_pool.schema_cache.dump_to(filename) end
#each_current_configuration(environment, name = nil) (private)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 582
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
#each_current_environment(environment, &block) (private)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 592
def each_current_environment(environment, &block) environments = [environment] environments << "test" if environment == "development" && !ENV["SKIP_TEST_DATABASE"] && !ENV["DATABASE_URL"] environments.each(&block) end
#each_local_configuration (private)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 598
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
#for_each(databases)
# 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
#initialize_database(db_config) (private)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 652
def initialize_database(db_config) with_temporary_pool(db_config) do begin database_already_initialized = migration_connection_pool.schema_migration.table_exists? rescue ActiveRecord::NoDatabaseError create(db_config) retry end unless database_already_initialized schema_dump_path = schema_dump_path(db_config) if schema_dump_path && File.exist?(schema_dump_path) load_schema(db_config, ActiveRecord.schema_format, nil) end end !database_already_initialized end end
#load_schema(db_config, format = ActiveRecord.schema_format, file = nil)
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 376
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. .create_table_and_set_flags(db_config.env_name, schema_sha1(file)) ensure Migration.verbose = verbose_was end
#load_schema_current(format = ActiveRecord.schema_format, file = nil, environment = env)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 474
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
#load_seed
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 490
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
#local_database?(db_config) ⇒ Boolean
(private)
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 610
def local_database?(db_config) host = db_config.host host.blank? || LOCAL_HOSTS.include?(host) end
#migrate(version = nil, skip_initialize: false)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 262
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
#migrate_all
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 243
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
#migrate_status
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 302
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
#migration_class
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 529
def migration_class # :nodoc: ActiveRecord::Base end
#migration_connection
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 533
def migration_connection # :nodoc: migration_class.lease_connection end
#migration_connection_pool
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 537
def migration_connection_pool # :nodoc: migration_class.connection_pool end
#name
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 107
def name @name ||= "primary" end
#prepare_all
[ GitHub ]# 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| 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
#purge(configuration)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 347
def purge(configuration) db_config = resolve_configuration(configuration) database_adapter_for(db_config).purge end
#purge_all
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 352
def purge_all each_local_configuration { |db_config| purge(db_config) } end
#purge_current(environment = env)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 356
def purge_current(environment = env) each_current_configuration(environment) { |db_config| purge(db_config) } migration_class.establish_connection(environment.to_sym) end
#raise_for_multi_db(environment = env, command:)
# 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
#reconstruct_from_schema(db_config, format = ActiveRecord.schema_format, file = nil)
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 413
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
#register_task(pattern, task)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 73
def register_task(pattern, task) @tasks ||= {} @tasks[pattern] = task end
#resolve_configuration(configuration) (private)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 555
def resolve_configuration(configuration) Base.configurations.resolve(configuration) end
#schema_dump_path(db_config, format = ActiveRecord.schema_format)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 455
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
#schema_sha1(file) (private)
[ GitHub ]
#schema_up_to_date?(configuration, format = ActiveRecord.schema_format, file = nil) ⇒ Boolean
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 397
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| = pool. return false unless .enabled? return false unless .table_exists? [:schema_sha1] == schema_sha1(file) end end
#setup_initial_database_yaml
# 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
#structure_dump(configuration, *arguments)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 362
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
#structure_dump_flags_for(adapter) (private)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 619
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
#structure_load(configuration, *arguments)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 369
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
#structure_load_flags_for(adapter) (private)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 627
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
#target_version
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 323
def target_version ENV["VERSION"].to_i if ENV["VERSION"] && !ENV["VERSION"].empty? end
#truncate_all(environment = env)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 237
def truncate_all(environment = env) configs_for(env_name: environment).each do |db_config| truncate_tables(db_config) end end
#truncate_tables(db_config) (private)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 230
def truncate_tables(db_config) with_temporary_connection(db_config) do |conn| conn.truncate_tables(*conn.tables) end end
#with_temporary_connection(db_config, clobber: false, &block)
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 523
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
#with_temporary_pool(db_config, clobber: false) (private)
[ GitHub ]# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 542
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
#with_temporary_pool_for_each(env: ActiveRecord::Tasks::DatabaseTasks.env, name: nil, clobber: false, &block)
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 512
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