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

#current_config(options = {}) ⇒ Object 



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

def current_config(options = {})
  options.reverse_merge! env: env
  options[:spec] ||= "primary"
  if options.has_key?(:config)
    @current_config = options[:config]
  else
    @current_config ||= ActiveRecord::Base.configurations.configs_for(env_name: options[:env], spec_name: options[:spec]).config
  end
end

#database_configuration ⇒ Object

Returns the value of attribute database_configuration.



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

def database_configuration
  @database_configuration
end

#db_dir ⇒ Object 



82
83
84
 
# File '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 '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 '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 '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 'lib/active_record/tasks/database_tasks.rb', line 98

def root
  @root ||= Rails.root
end

#seed_loader ⇒ Object 



110
111
112
 
# File '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 



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

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(*arguments) ⇒ Object 



276
277
278
279
 
# File 'lib/active_record/tasks/database_tasks.rb', line 276

def charset(*arguments)
  configuration = arguments.first
  class_for_adapter(configuration["adapter"]).new(*arguments).charset
end

#charset_current(environment = env, specification_name = spec) ⇒ Object 



272
273
274
 
# File 'lib/active_record/tasks/database_tasks.rb', line 272

def charset_current(environment = env, specification_name = spec)
  charset ActiveRecord::Base.configurations.configs_for(env_name: environment, spec_name: specification_name).config
end

#check_protected_environments! ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File '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 



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

def check_schema_file(filename)
  unless File.exist?(filename)
    message = +%{#{filename} doesn't exist yet. Run `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 



262
263
264
265
266
 
# File 'lib/active_record/tasks/database_tasks.rb', line 262

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(*arguments) ⇒ Object 



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

def collation(*arguments)
  configuration = arguments.first
  class_for_adapter(configuration["adapter"]).new(*arguments).collation
end

#collation_current(environment = env, specification_name = spec) ⇒ Object 



281
282
283
 
# File 'lib/active_record/tasks/database_tasks.rb', line 281

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

#create(*arguments) ⇒ Object 



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

def create(*arguments)
  configuration = arguments.first
  class_for_adapter(configuration["adapter"]).new(*arguments).create
  $stdout.puts "Created database '#{configuration['database']}'" if verbose?
rescue DatabaseAlreadyExists
  $stderr.puts "Database '#{configuration['database']}' already exists" if verbose?
rescue Exception => error
  $stderr.puts error
  $stderr.puts "Couldn't create '#{configuration['database']}' database. Please check your configuration."
  raise
end

#create_all ⇒ Object 



136
137
138
139
140
141
142
 
# File 'lib/active_record/tasks/database_tasks.rb', line 136

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

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



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

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

#drop(*arguments) ⇒ Object 



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

def drop(*arguments)
  configuration = arguments.first
  class_for_adapter(configuration["adapter"]).new(*arguments).drop
  $stdout.puts "Dropped database '#{configuration['database']}'" if verbose?
rescue ActiveRecord::NoDatabaseError
  $stderr.puts "Database '#{configuration['database']}' does not exist"
rescue Exception => error
  $stderr.puts error
  $stderr.puts "Couldn't drop database '#{configuration['database']}'"
  raise
end

#drop_all ⇒ Object 



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

def drop_all
  each_local_configuration { |configuration| drop configuration }
end

#drop_current(environment = env) ⇒ Object 



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

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

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



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

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(configuration, format = ActiveRecord::Base.schema_format, spec_name = "primary") ⇒ Object

:nodoc:



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

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



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

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 



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

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(configuration, format = ActiveRecord::Base.schema_format, file = nil, environment = env, spec_name = "primary") ⇒ Object

:nodoc:



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/active_record/tasks/database_tasks.rb', line 319

def load_schema(configuration, format = ActiveRecord::Base.schema_format, file = nil, environment = env, spec_name = "primary") # :nodoc:
  file ||= dump_filename(spec_name, format)

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

  case format
  when :ruby
    load(file)
  when :sql
    structure_load(configuration, file)
  else
    raise ArgumentError, "unknown format #{format.inspect}"
  end
  ActiveRecord::InternalMetadata.create_table
  ActiveRecord::InternalMetadata[:environment] = environment
  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 



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

def load_schema_current(format = ActiveRecord::Base.schema_format, file = nil, environment = env)
  each_current_configuration(environment) { |configuration, spec_name, env|
    load_schema(configuration, format, file, env, spec_name)
  }
  ActiveRecord::Base.establish_connection(environment.to_sym)
end

#load_seed ⇒ Object 



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

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 



232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/active_record/tasks/database_tasks.rb', line 232

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 



247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/active_record/tasks/database_tasks.rb', line 247

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_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 



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

def purge(configuration)
  class_for_adapter(configuration["adapter"]).new(configuration).purge
end

#purge_all ⇒ Object 



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

def purge_all
  each_local_configuration { |configuration|
    purge configuration
  }
end

#purge_current(environment = env) ⇒ Object 



300
301
302
303
304
305
 
# File 'lib/active_record/tasks/database_tasks.rb', line 300

def purge_current(environment = env)
  each_current_configuration(environment) { |configuration|
    purge configuration
  }
  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 = 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(configuration, format = ActiveRecord::Base.schema_format, file = nil, environment = env, spec_name = "primary") ⇒ Object

:nodoc:



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

def reconstruct_from_schema(configuration, format = ActiveRecord::Base.schema_format, file = nil, environment = env, spec_name = "primary") # :nodoc:
  file ||= dump_filename(spec_name, format)

  check_schema_file(file)

  ActiveRecord::Base.establish_connection(configuration)

  if schema_up_to_date?(configuration, format, file, environment, spec_name)
    truncate_tables(configuration)
  else
    purge(configuration)
    load_schema(configuration, format, file, environment, spec_name)
  end
rescue ActiveRecord::NoDatabaseError
  create(configuration)
  load_schema(configuration, format, file, environment, spec_name)
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_file(format = ActiveRecord::Base.schema_format) ⇒ Object 



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

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 



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

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 = env, spec_name = "primary") ⇒ Boolean

Returns:

  • (Boolean) 


341
342
343
344
345
346
347
348
349
 
# File 'lib/active_record/tasks/database_tasks.rb', line 341

def schema_up_to_date?(configuration, format = ActiveRecord::Base.schema_format, file = nil, environment = env, spec_name = "primary")
  file ||= dump_filename(spec_name, format)

  return true unless File.exist?(file)

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

#setup_initial_database_yaml ⇒ Object 



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

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 'lib/active_record/tasks/database_tasks.rb', line 106

def spec
  @spec ||= "primary"
end

#structure_dump(*arguments) ⇒ Object 



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

def structure_dump(*arguments)
  configuration = arguments.first
  filename = arguments.delete_at 1
  class_for_adapter(configuration["adapter"]).new(*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



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

mattr_accessor :structure_dump_flags, instance_accessor: false

#structure_load(*arguments) ⇒ Object 



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

def structure_load(*arguments)
  configuration = arguments.first
  filename = arguments.delete_at 1
  class_for_adapter(configuration["adapter"]).new(*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



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

mattr_accessor :structure_load_flags, instance_accessor: false

#target_version ⇒ Object 



268
269
270
 
# File 'lib/active_record/tasks/database_tasks.rb', line 268

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

#truncate_all(environment = env) ⇒ Object 



226
227
228
229
230
 
# File 'lib/active_record/tasks/database_tasks.rb', line 226

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