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 


114
115
116
117
118
119
120
121
122
123
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 114

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

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

#database_configuration ⇒ Object

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


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

#env ⇒ Object 


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

def env
  @env ||= Rails.env
end

#fixtures_path ⇒ Object 


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


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

#root ⇒ Object 


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

def root
  @root ||= Rails.root
end

#seed_loader ⇒ Object 


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

def seed_loader
  @seed_loader ||= Rails.application
end

Instance Method Details

#cache_dump_filename(namespace) ⇒ Object 


412
413
414
415
416
417
418
419
420
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 412

def cache_dump_filename(namespace)
  filename = if namespace == "primary"
    "schema_cache.yml"
  else
    "#{namespace}_schema_cache.yml"
  end

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

#charset(configuration, *arguments) ⇒ Object 


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

def charset(configuration, *arguments)
  db_config = resolve_configuration(configuration)
  database_adapter_for(db_config, *arguments).charset
end

#charset_current(env_name = env, spec_name = spec) ⇒ Object 


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

def charset_current(env_name = env, spec_name = spec)
  db_config = ActiveRecord::Base.configurations.configs_for(env_name: env_name, spec_name: spec_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 


429
430
431
432
433
434
435
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 429

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 


254
255
256
257
258
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 254

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

#collation(configuration, *arguments) ⇒ Object 


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

def collation(configuration, *arguments)
  db_config = resolve_configuration(configuration)
  database_adapter_for(db_config, *arguments).collation
end

#collation_current(env_name = env, spec_name = spec) ⇒ Object 


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

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

#create(configuration, *arguments) ⇒ Object 


126
127
128
129
130
131
132
133
134
135
136
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 126

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 


138
139
140
141
142
143
144
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 138

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


185
186
187
188
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 185

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

#drop(configuration, *arguments) ⇒ Object 


190
191
192
193
194
195
196
197
198
199
200
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 190

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 


202
203
204
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 202

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

#drop_current(environment = env) ⇒ Object 


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

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

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


402
403
404
405
406
407
408
409
410
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 402

def dump_filename(namespace, format = ActiveRecord::Base.schema_format)
  filename = if namespace == "primary"
    schema_file_type(format)
  else
    "#{namespace}_#{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:


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

def dump_schema(db_config, format = ActiveRecord::Base.schema_format) # :nodoc:
  require "active_record/schema_dumper"
  filename = dump_filename(db_config.spec_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")


451
452
453
454
455
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 451

def dump_schema_cache(conn, filename)
  conn.schema_cache.clear!
  conn.data_sources.each { |table| conn.schema_cache.add(table) }
  open(filename, "wb") { |f| f.write(YAML.dump(conn.schema_cache)) }
end

#for_each(databases) ⇒ Object 


158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 158

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.spec_name
  end
end

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

:nodoc:


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 310

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


422
423
424
425
426
427
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 422

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


437
438
439
440
441
442
443
444
445
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 437

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


224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 224

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


239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 239

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

#purge(configuration) ⇒ Object 


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

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

#purge_all ⇒ Object 


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

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

#purge_current(environment = env) ⇒ Object 


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

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 


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

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.spec_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:


350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 350

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


389
390
391
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 389

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 


393
394
395
396
397
398
399
400
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 393

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, spec_name = nil) ⇒ Boolean

Returns:

  • (Boolean) 

332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 332

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

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

  spec_name ||= db_config.spec_name

  file ||= dump_filename(spec_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_yaml ⇒ Object 


146
147
148
149
150
151
152
153
154
155
156
 
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 146

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

#spec ⇒ Object 


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

def spec
  @spec ||= "primary"
end

#structure_dump(configuration, *arguments) ⇒ Object 


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

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

: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 


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

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

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


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

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

#truncate_all(environment = env) ⇒ Object 


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

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