Module: ActiveRecord::Tasks::DatabaseTasks

Extended by:
DatabaseTasks
Included in:
DatabaseTasks
Defined in:
lib/active_record/tasks/database_tasks.rb

Overview

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 (like Rails.env).

  • 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 collapse

LOCAL_HOSTS =
["127.0.0.1", "localhost"]

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#database_configurationObject

Returns the value of attribute database_configuration.



61
62
63
# File 'lib/active_record/tasks/database_tasks.rb', line 61

def database_configuration
  @database_configuration
end

#db_dirObject



83
84
85
# File 'lib/active_record/tasks/database_tasks.rb', line 83

def db_dir
  @db_dir ||= Rails.application.config.paths["db"].first
end

#envObject



103
104
105
# File 'lib/active_record/tasks/database_tasks.rb', line 103

def env
  @env ||= Rails.env
end

#fixtures_pathObject



91
92
93
94
95
96
97
# File '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

#migrations_pathsObject



87
88
89
# File 'lib/active_record/tasks/database_tasks.rb', line 87

def migrations_paths
  @migrations_paths ||= Rails.application.paths["db/migrate"].to_a
end

#rootObject



99
100
101
# File 'lib/active_record/tasks/database_tasks.rb', line 99

def root
  @root ||= Rails.root
end

#seed_loaderObject



111
112
113
# File 'lib/active_record/tasks/database_tasks.rb', line 111

def seed_loader
  @seed_loader ||= Rails.application
end

Instance Method Details

#cache_dump_filename(db_config, schema_cache_path: nil) ⇒ Object



484
485
486
487
488
# File '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

#charset(configuration, *arguments) ⇒ Object



330
331
332
333
# File '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

#charset_current(env_name = env, db_name = name) ⇒ Object



325
326
327
328
# File '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

#check_protected_environments!(environment = env) ⇒ Object



65
66
67
68
69
70
71
# File '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

#check_schema_file(filename) ⇒ Object



498
499
500
501
502
503
504
# File '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

#check_target_versionObject



315
316
317
318
319
# File '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

#clear_schema_cache(filename) ⇒ Object



524
525
526
# File 'lib/active_record/tasks/database_tasks.rb', line 524

def clear_schema_cache(filename)
  FileUtils.rm_f filename, verbose: false
end

#collation(configuration, *arguments) ⇒ Object



340
341
342
343
# File '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

#collation_current(env_name = env, db_name = name) ⇒ Object



335
336
337
338
# File '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

#create(configuration, *arguments) ⇒ Object



115
116
117
118
119
120
121
122
123
124
125
# File '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_allObject



127
128
129
130
131
132
133
# File '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) ⇒ Object



168
169
170
171
172
# File '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

#db_configs_with_versions(environment = env) ⇒ Object

:nodoc:



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/active_record/tasks/database_tasks.rb', line 283

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) ⇒ Object



208
209
210
211
212
213
214
215
216
217
218
# File '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

#drop_allObject



220
221
222
# File 'lib/active_record/tasks/database_tasks.rb', line 220

def drop_all
  each_local_configuration { |db_config| drop(db_config) }
end

#drop_current(environment = env) ⇒ Object



224
225
226
# File 'lib/active_record/tasks/database_tasks.rb', line 224

def drop_current(environment = env)
  each_current_configuration(environment) { |db_config| drop(db_config) }
end

#dump_allObject



430
431
432
433
434
435
436
437
438
439
440
441
# File '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

#dump_schema(db_config, format = db_config.schema_format) ⇒ Object

:nodoc:



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'lib/active_record/tasks/database_tasks.rb', line 443

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

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

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

#dump_schema_cache(conn_or_pool, filename) ⇒ Object

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")


520
521
522
# File '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

#for_each(databases) ⇒ Object

:nodoc:



141
142
143
144
145
146
147
148
149
150
151
152
# File '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|
    yield db_config.name
  end
end

#load_schema(db_config, format = db_config.schema_format, file = nil) ⇒ Object

:nodoc:



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
# File 'lib/active_record/tasks/database_tasks.rb', line 374

def load_schema(db_config, format = db_config.schema_format, file = nil) # :nodoc:
  format = format.to_sym
  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 = nil, file = nil, environment = env) ⇒ Object



490
491
492
493
494
495
496
# File '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

#load_seedObject



506
507
508
509
510
511
512
513
514
# File '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

#migrate(version = nil, skip_initialize: false) ⇒ Object



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File '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

#migrate_allObject



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# File '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

#migrate_statusObject



300
301
302
303
304
305
306
307
308
309
310
311
312
313
# File '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

#migration_classObject

:nodoc:



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

def migration_class # :nodoc:
  ActiveRecord::Base
end

#migration_connectionObject

:nodoc:



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

def migration_connection # :nodoc:
  migration_class.lease_connection
end

#migration_connection_poolObject

:nodoc:



553
554
555
# File 'lib/active_record/tasks/database_tasks.rb', line 553

def migration_connection_pool # :nodoc:
  migration_class.connection_pool
end

#nameObject



107
108
109
# File 'lib/active_record/tasks/database_tasks.rb', line 107

def name
  @name ||= "primary"
end

#prepare_allObject



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
# File '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

#purge(configuration) ⇒ Object



345
346
347
348
# File 'lib/active_record/tasks/database_tasks.rb', line 345

def purge(configuration)
  db_config = resolve_configuration(configuration)
  database_adapter_for(db_config).purge
end

#purge_allObject



350
351
352
# File 'lib/active_record/tasks/database_tasks.rb', line 350

def purge_all
  each_local_configuration { |db_config| purge(db_config) }
end

#purge_current(environment = env) ⇒ Object



354
355
356
357
358
# File '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

#raise_for_multi_db(environment = env, command:) ⇒ Object

:nodoc:



154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/active_record/tasks/database_tasks.rb', line 154

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, file = nil) ⇒ Object

:nodoc:



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
# File 'lib/active_record/tasks/database_tasks.rb', line 412

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

  check_schema_file(file) if file

  with_temporary_pool(db_config, clobber: true) do
    if schema_up_to_date?(db_config, nil, file)
      truncate_tables(db_config) unless ENV["SKIP_TEST_DATABASE_TRUNCATE"]
    else
      purge(db_config)
      load_schema(db_config, db_config.schema_format, file)
    end
  rescue ActiveRecord::NoDatabaseError
    create(db_config)
    load_schema(db_config, db_config.schema_format, file)
  end
end

#register_task(pattern, task) ⇒ Object



73
74
75
76
# File 'lib/active_record/tasks/database_tasks.rb', line 73

def register_task(pattern, task)
  @tasks ||= {}
  @tasks[pattern] = task
end

#schema_dump_path(db_config, format = db_config.schema_format) ⇒ Object



471
472
473
474
475
476
477
478
479
480
481
482
# File '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

#schema_up_to_date?(configuration, _ = nil, file = nil) ⇒ Boolean

Returns:

  • (Boolean)


396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
# File '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|
     = pool.
    return false unless .enabled?
    return false unless .table_exists?

    [:schema_sha1] == schema_sha1(file)
  end
end

#setup_initial_database_yamlObject

:nodoc:



135
136
137
138
139
# File '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) ⇒ Object



360
361
362
363
364
365
# File '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

#structure_dump_flagsObject

:singleton-method: 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'
}


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

mattr_accessor :structure_dump_flags, instance_accessor: false

#structure_load(configuration, *arguments) ⇒ Object



367
368
369
370
371
372
# File '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

#structure_load_flagsObject

:singleton-method: 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)



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

mattr_accessor :structure_load_flags, instance_accessor: false

#target_versionObject



321
322
323
# File 'lib/active_record/tasks/database_tasks.rb', line 321

def target_version
  ENV["VERSION"].to_i if ENV["VERSION"] && !ENV["VERSION"].empty?
end

#truncate_all(environment = env) ⇒ Object



235
236
237
238
239
# File '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

#with_temporary_connection(db_config, clobber: false, &block) ⇒ Object

:nodoc:



539
540
541
542
543
# File 'lib/active_record/tasks/database_tasks.rb', line 539

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_for_each(env: ActiveRecord::Tasks::DatabaseTasks.env, name: nil, clobber: false, &block) ⇒ Object

:nodoc:



528
529
530
531
532
533
534
535
536
537
# File 'lib/active_record/tasks/database_tasks.rb', line 528

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