Module: ActiveRecord::Tasks::DatabaseTasks

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

Overview

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

Returns the value of attribute database_configuration.



59
60
61
 
# File 'lib/active_record/tasks/database_tasks.rb', line 59

def database_configuration
  @database_configuration
end

#db_dir ⇒ Object 



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

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

#env ⇒ Object 



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

def env
  @env ||= Rails.env
end

#fixtures_path ⇒ Object 



96
97
98
99
100
101
102
 
# File 'lib/active_record/tasks/database_tasks.rb', line 96

def fixtures_path
  @fixtures_path ||= if ENV["FIXTURES_PATH"]
    File.join(root, ENV["FIXTURES_PATH"])
  else
    File.join(root, "test", "fixtures")
  end
end

#migrations_paths ⇒ Object 



92
93
94
 
# File 'lib/active_record/tasks/database_tasks.rb', line 92

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

#root ⇒ Object 



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

def root
  @root ||= Rails.root
end

#seed_loader ⇒ Object 



116
117
118
 
# File 'lib/active_record/tasks/database_tasks.rb', line 116

def seed_loader
  @seed_loader ||= Rails.application
end

Instance Method Details

#cache_dump_filename(db_config_name, schema_cache_path: nil) ⇒ Object 



465
466
467
468
469
470
471
472
473
 
# File 'lib/active_record/tasks/database_tasks.rb', line 465

def cache_dump_filename(db_config_name, schema_cache_path: nil)
  filename = if ActiveRecord::Base.configurations.primary?(db_config_name)
    "schema_cache.yml"
  else
    "#{db_config_name}_schema_cache.yml"
  end

  schema_cache_path || ENV["SCHEMA_CACHE"] || File.join(ActiveRecord::Tasks::DatabaseTasks.db_dir, filename)
end

#charset(configuration, *arguments) ⇒ Object 



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

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 



317
318
319
320
 
# File 'lib/active_record/tasks/database_tasks.rb', line 317

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/active_record/tasks/database_tasks.rb', line 63

def check_protected_environments!
  unless ENV["DISABLE_DATABASE_ENVIRONMENT_CHECK"]
    current = ActiveRecord::Base.connection.migration_context.current_environment
    stored  = ActiveRecord::Base.connection.migration_context.last_stored_environment

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

    if stored && stored != current
      raise ActiveRecord::EnvironmentMismatchError.new(current: current, stored: stored)
    end
  end
rescue ActiveRecord::NoDatabaseError
end

#check_schema_file(filename) ⇒ Object 



482
483
484
485
486
487
488
 
# File 'lib/active_record/tasks/database_tasks.rb', line 482

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



307
308
309
310
311
 
# File 'lib/active_record/tasks/database_tasks.rb', line 307

def check_target_version
  if target_version && !(Migration::MigrationFilenameRegexp.match?(ENV["VERSION"]) || /\A\d+\z/.match?(ENV["VERSION"]))
    raise "Invalid format of target version: `VERSION=#{ENV['VERSION']}`"
  end
end

#clear_schema_cache(filename) ⇒ Object 



508
509
510
 
# File 'lib/active_record/tasks/database_tasks.rb', line 508

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

#collation(configuration, *arguments) ⇒ Object 



332
333
334
335
 
# File 'lib/active_record/tasks/database_tasks.rb', line 332

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 



327
328
329
330
 
# File 'lib/active_record/tasks/database_tasks.rb', line 327

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 



120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/active_record/tasks/database_tasks.rb', line 120

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



132
133
134
135
136
137
138
 
# File 'lib/active_record/tasks/database_tasks.rb', line 132

def create_all
  old_pool = ActiveRecord::Base.connection_handler.retrieve_connection_pool(ActiveRecord::Base.connection_specification_name)
  each_local_configuration { |db_config| create(db_config) }
  if old_pool
    ActiveRecord::Base.connection_handler.establish_connection(old_pool.db_config)
  end
end

#create_current(environment = env, name = nil) ⇒ Object 



183
184
185
186
 
# File 'lib/active_record/tasks/database_tasks.rb', line 183

def create_current(environment = env, name = nil)
  each_current_configuration(environment, name) { |db_config| create(db_config) }
  ActiveRecord::Base.establish_connection(environment.to_sym)
end

#db_configs_with_versions(db_configs) ⇒ Object

:nodoc:



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/active_record/tasks/database_tasks.rb', line 275

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

  db_configs.each do |db_config|
    ActiveRecord::Base.establish_connection(db_config)
    versions_to_run = ActiveRecord::Base.connection.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 



220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/active_record/tasks/database_tasks.rb', line 220

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



232
233
234
 
# File 'lib/active_record/tasks/database_tasks.rb', line 232

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

#drop_current(environment = env) ⇒ Object 



236
237
238
 
# File 'lib/active_record/tasks/database_tasks.rb', line 236

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

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

:nodoc:



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/active_record/tasks/database_tasks.rb', line 420

def dump_schema(db_config, format = ActiveRecord.schema_format) # :nodoc:
  require "active_record/schema_dumper"
  filename = schema_dump_path(db_config, format)
  connection = ActiveRecord::Base.connection

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

#dump_schema_cache(conn, filename) ⇒ Object

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

Examples:

ActiveRecord::Tasks::DatabaseTasks.dump_schema_cache(ActiveRecord::Base.connection, "tmp/schema_dump.yaml")



504
505
506
 
# File 'lib/active_record/tasks/database_tasks.rb', line 504

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

#for_each(databases) ⇒ Object 



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

def for_each(databases)
  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

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

:nodoc:



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/active_record/tasks/database_tasks.rb', line 365

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

  verbose_was, Migration.verbose = Migration.verbose, verbose? && ENV["VERBOSE"]
  check_schema_file(file)
  ActiveRecord::Base.establish_connection(db_config)

  case format
  when :ruby
    load(file)
  when :sql
    structure_load(db_config, file)
  else
    raise ArgumentError, "unknown format #{format.inspect}"
  end
  ActiveRecord::InternalMetadata.create_table
  ActiveRecord::InternalMetadata[:environment] = db_config.env_name
  ActiveRecord::InternalMetadata[:schema_sha1] = schema_sha1(file)
ensure
  Migration.verbose = verbose_was
end

#load_schema_current(format = ActiveRecord.schema_format, file = nil, environment = env) ⇒ Object 



475
476
477
478
479
480
 
# File 'lib/active_record/tasks/database_tasks.rb', line 475

def load_schema_current(format = ActiveRecord.schema_format, file = nil, environment = env)
  each_current_configuration(environment) do |db_config|
    load_schema(db_config, format, file)
  end
  ActiveRecord::Base.establish_connection(environment.to_sym)
end

#load_seed ⇒ Object 



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

#migrate(version = nil) ⇒ Object 



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/active_record/tasks/database_tasks.rb', line 254

def migrate(version = nil)
  check_target_version

  scope = ENV["SCOPE"]
  verbose_was, Migration.verbose = Migration.verbose, verbose?

  Base.connection.migration_context.migrate(target_version) do |migration|
    if version.blank?
      scope.blank? || scope == migration.scope
    else
      migration.version == version
    end
  end.tap do |migrations_ran|
    Migration.write("No migrations ran. (using #{scope} scope)") if scope.present? && migrations_ran.empty?
  end

  ActiveRecord::Base.clear_cache!
ensure
  Migration.verbose = verbose_was
end

#migrate_status ⇒ Object 



292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/active_record/tasks/database_tasks.rb', line 292

def migrate_status
  unless ActiveRecord::Base.connection.schema_migration.table_exists?
    Kernel.abort "Schema migrations table does not exist yet."
  end

  # output
  puts "\ndatabase: #{ActiveRecord::Base.connection_db_config.database}\n\n"
  puts "#{'Status'.center(8)}  #{'Migration ID'.ljust(14)}  Migration Name"
  puts "-" * 50
  ActiveRecord::Base.connection.migration_context.migrations_status.each do |status, version, name|
    puts "#{status.center(8)}  #{version.ljust(14)}  #{name}"
  end
  puts
end

#name ⇒ Object 



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

def name
  @name ||= "primary"
end

#prepare_all ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/active_record/tasks/database_tasks.rb', line 188

def prepare_all
  seed = false

  configs_for(env_name: env).each do |db_config|
    ActiveRecord::Base.establish_connection(db_config)

    # Skipped when no database
    migrate

    if ActiveRecord.dump_schema_after_migration
      dump_schema(db_config, ActiveRecord.schema_format)
    end
  rescue ActiveRecord::NoDatabaseError
    create_current(db_config.env_name, db_config.name)

    if File.exist?(schema_dump_path(db_config))
      load_schema(
        db_config,
        ActiveRecord.schema_format,
        nil
      )
    else
      migrate
    end

    seed = true
  end

  ActiveRecord::Base.establish_connection
  load_seed if seed
end

#purge(configuration) ⇒ Object 



337
338
339
340
 
# File 'lib/active_record/tasks/database_tasks.rb', line 337

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

#purge_all ⇒ Object 



342
343
344
 
# File 'lib/active_record/tasks/database_tasks.rb', line 342

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

#purge_current(environment = env) ⇒ Object 



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

def purge_current(environment = env)
  each_current_configuration(environment) { |db_config| purge(db_config) }
  ActiveRecord::Base.establish_connection(environment.to_sym)
end

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



169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/active_record/tasks/database_tasks.rb', line 169

def raise_for_multi_db(environment = env, command:)
  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) ⇒ Object

:nodoc:



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/active_record/tasks/database_tasks.rb', line 402

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

  check_schema_file(file)

  ActiveRecord::Base.establish_connection(db_config)

  if schema_up_to_date?(db_config, format, file)
    truncate_tables(db_config)
  else
    purge(db_config)
    load_schema(db_config, format, file)
  end
rescue ActiveRecord::NoDatabaseError
  create(db_config)
  load_schema(db_config, format, file)
end

#register_task(pattern, task) ⇒ Object 



79
80
81
82
 
# File 'lib/active_record/tasks/database_tasks.rb', line 79

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

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



452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/active_record/tasks/database_tasks.rb', line 452

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_file_type(format = ActiveRecord.schema_format) ⇒ Object 



442
443
444
445
446
447
448
449
 
# File 'lib/active_record/tasks/database_tasks.rb', line 442

def schema_file_type(format = ActiveRecord.schema_format)
  case format
  when :ruby
    "schema.rb"
  when :sql
    "structure.sql"
  end
end

#schema_up_to_date?(configuration, format = ActiveRecord.schema_format, file = nil) ⇒ Boolean

Returns:

  • (Boolean) 


387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/active_record/tasks/database_tasks.rb', line 387

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.exist?(file)

  ActiveRecord::Base.establish_connection(db_config)

  return false unless ActiveRecord::InternalMetadata.enabled?
  return false unless ActiveRecord::InternalMetadata.table_exists?

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

#setup_initial_database_yaml ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/active_record/tasks/database_tasks.rb', line 140

def setup_initial_database_yaml
  return {} unless defined?(Rails)

  begin
    Rails.application.config.load_database_yaml
  rescue
    unless ActiveRecord.suppress_multiple_database_warning
      $stderr.puts "Rails couldn't infer whether you are using multiple databases from your database.yml and can't generate the tasks for the non-primary databases. If you'd like to use this feature, please simplify your ERB."
    end

    {}
  end
end

#structure_dump(configuration, *arguments) ⇒ Object 



351
352
353
354
355
356
 
# File 'lib/active_record/tasks/database_tasks.rb', line 351

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

: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'],
  postgres: '--no-tablespaces'
}



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

mattr_accessor :structure_dump_flags, instance_accessor: false

#structure_load(configuration, *arguments) ⇒ Object 



358
359
360
361
362
363
 
# File 'lib/active_record/tasks/database_tasks.rb', line 358

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

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



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

mattr_accessor :structure_load_flags, instance_accessor: false

#target_version ⇒ Object 



313
314
315
 
# File 'lib/active_record/tasks/database_tasks.rb', line 313

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

#truncate_all(environment = env) ⇒ Object 



248
249
250
251
252
 
# File 'lib/active_record/tasks/database_tasks.rb', line 248

def truncate_all(environment = env)
  configs_for(env_name: environment).each do |db_config|
    truncate_tables(db_config)
  end
end