Module: ActiveRecord::Tasks::DatabaseTasks

Extended by:
DatabaseTasks
Included in:
DatabaseTasks
Defined in:
activerecord/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

#current_config(options = {}) ⇒ Object


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

def current_config(options = {})
  if options.has_key?(:config)
    @current_config = options[:config]
  else
    env_name = options[:env] || env
    name = options[:spec] || "primary"

    @current_config ||= ActiveRecord::Base.configurations.configs_for(env_name: env_name, name: name)&.configuration_hash
  end
end

#database_configurationObject

Returns the value of attribute database_configuration


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

def database_configuration
  @database_configuration
end

#db_dirObject


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

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

#envObject


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

def env
  @env ||= Rails.env
end

#fixtures_pathObject


90
91
92
93
94
95
96
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 90

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


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

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

#rootObject


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

def root
  @root ||= Rails.root
end

#seed_loaderObject


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

def seed_loader
  @seed_loader ||= Rails.application
end

Instance Method Details

#cache_dump_filename(name, schema_cache_path: nil) ⇒ Object


417
418
419
420
421
422
423
424
425
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 417

def cache_dump_filename(name, schema_cache_path: nil)
  filename = if name == "primary"
    "schema_cache.yml"
  else
    "#{name}_schema_cache.yml"
  end

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

#charset(configuration, *arguments) ⇒ Object


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

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


269
270
271
272
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 269

def charset_current(env_name = env, db_name = name)
  db_config = ActiveRecord::Base.configurations.configs_for(env_name: env_name, name: db_name)
  charset(db_config)
end

#check_protected_environments!Object


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 57

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


434
435
436
437
438
439
440
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 434

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


259
260
261
262
263
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 259

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


460
461
462
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 460

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

#collation(configuration, *arguments) ⇒ Object


284
285
286
287
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 284

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


279
280
281
282
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 279

def collation_current(env_name = env, db_name = name)
  db_config = ActiveRecord::Base.configurations.configs_for(env_name: env_name, name: db_name)
  collation(db_config)
end

#create(configuration, *arguments) ⇒ Object


131
132
133
134
135
136
137
138
139
140
141
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 131

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


143
144
145
146
147
148
149
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 143

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


190
191
192
193
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 190

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

#drop(configuration, *arguments) ⇒ Object


195
196
197
198
199
200
201
202
203
204
205
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 195

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


207
208
209
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 207

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

#drop_current(environment = env) ⇒ Object


211
212
213
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 211

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

#dump_filename(name, format = ActiveRecord::Base.schema_format) ⇒ Object


407
408
409
410
411
412
413
414
415
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 407

def dump_filename(name, format = ActiveRecord::Base.schema_format)
  filename = if name == "primary"
    schema_file_type(format)
  else
    "#{name}_#{schema_file_type(format)}"
  end

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

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

:nodoc:


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

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

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

456
457
458
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 456

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

#for_each(databases) ⇒ Object


163
164
165
166
167
168
169
170
171
172
173
174
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 163

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|
    yield db_config.name
  end
end

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

:nodoc:


315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 315

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


427
428
429
430
431
432
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 427

def load_schema_current(format = ActiveRecord::Base.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_seedObject


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

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

#migrateObject


229
230
231
232
233
234
235
236
237
238
239
240
241
242
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 229

def migrate
  check_target_version

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

  Base.connection.migration_context.migrate(target_version) do |migration|
    scope.blank? || scope == migration.scope
  end

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

#migrate_statusObject


244
245
246
247
248
249
250
251
252
253
254
255
256
257
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 244

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

#nameObject


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

def name
  @name ||= "primary"
end

#purge(configuration) ⇒ Object


289
290
291
292
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 289

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

#purge_allObject


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

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

#purge_current(environment = env) ⇒ Object


298
299
300
301
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 298

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


176
177
178
179
180
181
182
183
184
185
186
187
188
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 176

def raise_for_multi_db(environment = env, command:)
  db_configs = ActiveRecord::Base.configurations.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::Base.schema_format, file = nil) ⇒ Object

:nodoc:


355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 355

def reconstruct_from_schema(db_config, format = ActiveRecord::Base.schema_format, file = nil) # :nodoc:
  file ||= dump_filename(db_config.name, 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


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

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

#schema_file(format = ActiveRecord::Base.schema_format) ⇒ Object


394
395
396
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 394

def schema_file(format = ActiveRecord::Base.schema_format)
  File.join(db_dir, schema_file_type(format))
end

#schema_file_type(format = ActiveRecord::Base.schema_format) ⇒ Object


398
399
400
401
402
403
404
405
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 398

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

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

Returns:

  • (Boolean)

337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 337

def schema_up_to_date?(configuration, format = ActiveRecord::Base.schema_format, file = nil, environment = nil, name = nil)
  db_config = resolve_configuration(configuration)

  if environment || name
    ActiveSupport::Deprecation.warn("`environment` and `name` will be removed as parameters in 6.2.0, you may now pass an ActiveRecord::DatabaseConfigurations::DatabaseConfig as `configuration` instead.")
  end

  name ||= db_config.name

  file ||= dump_filename(name, format)

  return true unless File.exist?(file)

  ActiveRecord::Base.establish_connection(db_config)
  return false unless ActiveRecord::InternalMetadata.table_exists?
  ActiveRecord::InternalMetadata[:schema_sha1] == schema_sha1(file)
end

#setup_initial_database_yamlObject


151
152
153
154
155
156
157
158
159
160
161
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 151

def setup_initial_database_yaml
  return {} unless defined?(Rails)

  begin
    Rails.application.config.load_database_yaml
  rescue
    $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

#specObject


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

def spec
  @spec ||= "primary"
end

#structure_dump(configuration, *arguments) ⇒ Object


303
304
305
306
307
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 303

def structure_dump(configuration, *arguments)
  db_config = resolve_configuration(configuration)
  filename = arguments.delete_at(0)
  database_adapter_for(db_config, *arguments).structure_dump(filename, structure_dump_flags)
end

#structure_dump_flagsObject

:singleton-method: Extra flags passed to database CLI tool (mysqldump/pg_dump) when calling db:structure:dump


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

mattr_accessor :structure_dump_flags, instance_accessor: false

#structure_load(configuration, *arguments) ⇒ Object


309
310
311
312
313
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 309

def structure_load(configuration, *arguments)
  db_config = resolve_configuration(configuration)
  filename = arguments.delete_at(0)
  database_adapter_for(db_config, *arguments).structure_load(filename, structure_load_flags)
end

#structure_load_flagsObject

:singleton-method: Extra flags passed to database CLI tool when calling db:structure:load


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

mattr_accessor :structure_load_flags, instance_accessor: false

#target_versionObject


265
266
267
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 265

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

#truncate_all(environment = env) ⇒ Object


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

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