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


82
83
84
85
86
87
88
89
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 82

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


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

def database_configuration
  @database_configuration
end

#db_dirObject


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

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

#envObject


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

def env
  @env ||= Rails.env
end

#fixtures_pathObject


62
63
64
65
66
67
68
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 62

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


58
59
60
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 58

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

#rootObject


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

def root
  @root ||= Rails.root
end

#seed_loaderObject


78
79
80
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 78

def seed_loader
  @seed_loader ||= Rails.application
end

Instance Method Details

#charset(*arguments) ⇒ Object


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

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

#charset_current(environment = env) ⇒ Object


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

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

#check_schema_file(filename) ⇒ Object


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

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


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

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

#collation_current(environment = env) ⇒ Object


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

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

#create(*arguments) ⇒ Object


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

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

#create_allObject


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

def create_all
  each_local_configuration { |configuration| create configuration }
end

#create_current(environment = env) ⇒ Object


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

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

#drop(*arguments) ⇒ Object


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

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

#drop_allObject


122
123
124
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 122

def drop_all
  each_local_configuration { |configuration| drop configuration }
end

#drop_current(environment = env) ⇒ Object


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

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

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


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

def load_schema(format = ActiveRecord::Base.schema_format, file = nil)
  ActiveSupport::Deprecation.warn(<<-MSG.squish)
    This method will act on a specific connection in the future.
    To act on the current connection, use `load_schema_current` instead.
  MSG

  load_schema_current(format, file)
end

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


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

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

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


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

def load_schema_current_if_exists(format = ActiveRecord::Base.schema_format, file = nil, environment = env)
  if File.exist?(file || schema_file(format))
    load_schema_current(format, file, environment)
  end
end

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

This method is the successor of load_schema. We should rename it after load_schema went through a deprecation cycle. (Rails > 4.2)


214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 214

def load_schema_for(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
end

#load_seedObject


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

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


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

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


165
166
167
# File 'activerecord/lib/active_record/tasks/database_tasks.rb', line 165

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

#purge_allObject


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

def purge_all
  each_local_configuration { |configuration|
    purge configuration
  }
end

#purge_current(environment = env) ⇒ Object


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

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


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

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

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


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

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


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

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


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

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