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 Rake tasks 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


108
109
110
111
112
113
114
115
# File 'lib/active_record/tasks/database_tasks.rb', line 108

def current_config(options = {})
  options.reverse_merge! env: env
  if options.has_key?(:config)
    @current_config = options[:config]
  else
    @current_config ||= ActiveRecord::Base.configurations[options[:env]]
  end
end

#database_configurationObject

Returns the value of attribute database_configuration


51
52
53
# File 'lib/active_record/tasks/database_tasks.rb', line 51

def database_configuration
  @database_configuration
end

#db_dirObject


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

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

#envObject


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

def env
  @env ||= Rails.env
end

#fixtures_pathObject


88
89
90
91
92
93
94
# File 'lib/active_record/tasks/database_tasks.rb', line 88

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


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

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

#rootObject


96
97
98
# File 'lib/active_record/tasks/database_tasks.rb', line 96

def root
  @root ||= Rails.root
end

#seed_loaderObject


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

def seed_loader
  @seed_loader ||= Rails.application
end

Instance Method Details

#charset(*arguments) ⇒ Object


194
195
196
197
# File 'lib/active_record/tasks/database_tasks.rb', line 194

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

#charset_current(environment = env) ⇒ Object


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

def charset_current(environment = env)
  charset ActiveRecord::Base.configurations[environment]
end

#check_protected_environments!Object


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

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


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

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.}.dup
    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


180
181
182
183
184
# File 'lib/active_record/tasks/database_tasks.rb', line 180

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


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

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

#collation_current(environment = env) ⇒ Object


199
200
201
# File 'lib/active_record/tasks/database_tasks.rb', line 199

def collation_current(environment = env)
  collation ActiveRecord::Base.configurations[environment]
end

#create(*arguments) ⇒ Object


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

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

#create_allObject


129
130
131
132
133
134
135
# File 'lib/active_record/tasks/database_tasks.rb', line 129

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


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

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

#drop(*arguments) ⇒ Object


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

def drop(*arguments)
  configuration = arguments.first
  class_for_adapter(configuration["adapter"]).new(*arguments).drop
  $stdout.puts "Dropped database '#{configuration['database']}'"
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_allObject


156
157
158
# File 'lib/active_record/tasks/database_tasks.rb', line 156

def drop_all
  each_local_configuration { |configuration| drop configuration }
end

#drop_current(environment = env) ⇒ Object


160
161
162
163
164
# File 'lib/active_record/tasks/database_tasks.rb', line 160

def drop_current(environment = env)
  each_current_configuration(environment) { |configuration|
    drop configuration
  }
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")

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

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

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

:nodoc:


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

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

  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
end

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


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

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

#load_seedObject


279
280
281
282
283
284
285
286
287
# File 'lib/active_record/tasks/database_tasks.rb', line 279

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


166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'lib/active_record/tasks/database_tasks.rb', line 166

def migrate
  check_target_version

  verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] != "false" : true
  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

#purge(configuration) ⇒ Object


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

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

#purge_allObject


212
213
214
215
216
# File 'lib/active_record/tasks/database_tasks.rb', line 212

def purge_all
  each_local_configuration { |configuration|
    purge configuration
  }
end

#purge_current(environment = env) ⇒ Object


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

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

#register_task(pattern, task) ⇒ Object


71
72
73
74
# File 'lib/active_record/tasks/database_tasks.rb', line 71

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

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


255
256
257
258
259
260
261
262
# File 'lib/active_record/tasks/database_tasks.rb', line 255

def schema_file(format = ActiveRecord::Base.schema_format)
  case format
  when :ruby
    File.join(db_dir, "schema.rb")
  when :sql
    File.join(db_dir, "structure.sql")
  end
end

#structure_dump(*arguments) ⇒ Object


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

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_flagsObject

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


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

mattr_accessor :structure_dump_flags, instance_accessor: false

#structure_load(*arguments) ⇒ Object


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

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_flagsObject

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


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

mattr_accessor :structure_load_flags, instance_accessor: false

#target_versionObject


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

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