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 



98
99
100
101
102
103
104
105
 
# File 'lib/active_record/tasks/database_tasks.rb', line 98

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

Returns the value of attribute database_configuration.



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

def database_configuration
  @database_configuration
end

#db_dir ⇒ Object 



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

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

#env ⇒ Object 



90
91
92
 
# File 'lib/active_record/tasks/database_tasks.rb', line 90

def env
  @env ||= Rails.env
end

#fixtures_path ⇒ Object 



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

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 



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

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

#root ⇒ Object 



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

def root
  @root ||= Rails.root
end

#seed_loader ⇒ Object 



94
95
96
 
# File 'lib/active_record/tasks/database_tasks.rb', line 94

def seed_loader
  @seed_loader ||= Rails.application
end

Instance Method Details

#charset(*arguments) ⇒ Object 



175
176
177
178
 
# File 'lib/active_record/tasks/database_tasks.rb', line 175

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

#charset_current(environment = env) ⇒ Object 



171
172
173
 
# File 'lib/active_record/tasks/database_tasks.rb', line 171

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

#check_protected_environments! ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/active_record/tasks/database_tasks.rb', line 45

def check_protected_environments!
  unless ENV['DISABLE_DATABASE_ENVIRONMENT_CHECK']
    current = ActiveRecord::Migrator.current_environment
    stored  = ActiveRecord::Migrator.last_stored_environment

    if ActiveRecord::Migrator.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 



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

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)
    Kernel.abort message
  end
end

#collation(*arguments) ⇒ Object 



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

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

#collation_current(environment = env) ⇒ Object 



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

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

#create(*arguments) ⇒ Object 



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

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



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

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

#create_current(environment = env) ⇒ Object 



127
128
129
130
131
132
 
# File 'lib/active_record/tasks/database_tasks.rb', line 127

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

#drop(*arguments) ⇒ Object 



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

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



146
147
148
 
# File 'lib/active_record/tasks/database_tasks.rb', line 146

def drop_all
  each_local_configuration { |configuration| drop configuration }
end

#drop_current(environment = env) ⇒ Object 



150
151
152
153
154
 
# File 'lib/active_record/tasks/database_tasks.rb', line 150

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

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

:nodoc:



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/active_record/tasks/database_tasks.rb', line 218

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

  case format
  when :ruby
    check_schema_file(file)
    ActiveRecord::Base.establish_connection(configuration)
    load(file)
  when :sql
    check_schema_file(file)
    structure_load(configuration, file)
  else
    raise ArgumentError, "unknown format #{format.inspect}"
  end
  ActiveRecord::InternalMetadata.create_table
  ActiveRecord::InternalMetadata[:environment] = ActiveRecord::Migrator.current_environment
end

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



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

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

#load_schema_for(*args) ⇒ Object 



236
237
238
239
240
241
242
 
# File 'lib/active_record/tasks/database_tasks.rb', line 236

def load_schema_for(*args)
  ActiveSupport::Deprecation.warn(<<-MSG.squish)
    This method was renamed to `#load_schema` and will be removed in the future.
    Use `#load_schema` instead.
  MSG
  load_schema(*args)
end

#load_seed ⇒ Object 



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

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 



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

def migrate
  raise "Empty VERSION provided" if ENV["VERSION"] && ENV["VERSION"].empty?

  verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
  version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
  scope   = ENV['SCOPE']
  verbose_was, Migration.verbose = Migration.verbose, verbose
  Migrator.migrate(migrations_paths, version) do |migration|
    scope.blank? || scope == migration.scope
  end
  ActiveRecord::Base.clear_cache!
ensure
  Migration.verbose = verbose_was
end

#purge(configuration) ⇒ Object 



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

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

#purge_all ⇒ Object 



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

def purge_all
  each_local_configuration { |configuration|
    purge configuration
  }
end

#purge_current(environment = env) ⇒ Object 



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

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 



61
62
63
64
 
# File 'lib/active_record/tasks/database_tasks.rb', line 61

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

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



244
245
246
247
248
249
250
251
 
# File 'lib/active_record/tasks/database_tasks.rb', line 244

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 



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

def structure_dump(*arguments)
  configuration = arguments.first
  filename = arguments.delete_at 1
  class_for_adapter(configuration['adapter']).new(*arguments).structure_dump(filename)
end

#structure_load(*arguments) ⇒ Object 



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

def structure_load(*arguments)
  configuration = arguments.first
  filename = arguments.delete_at 1
  class_for_adapter(configuration['adapter']).new(*arguments).structure_load(filename)
end