module ActiveRecord::Tasks::DatabaseTasks
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 in 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.read('my_database_config.yml')) DatabaseTasks.db_dir = 'db' # other settings... DatabaseTasks.create_current('production')
Constants
- LOCAL_HOSTS
Attributes
current_config[W]
database_configuration[RW]
db_dir[W]
env[W]
fixtures_path[W]
migrations_paths[W]
root[W]
seed_loader[W]
Public Instance Methods
charset(*arguments)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 129 def charset(*arguments) configuration = arguments.first class_for_adapter(configuration['adapter']).new(*arguments).charset end
charset_current(environment = env)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 125 def charset_current(environment = env) charset ActiveRecord::Base.configurations[environment] end
check_schema_file(filename)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 174 def check_schema_file(filename) unless File.exist?(filename) message = %Q{#{filename} doesn't exist yet. Run `rake db:migrate` to create it, then try again.} message << %Q{ 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)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 138 def collation(*arguments) configuration = arguments.first class_for_adapter(configuration['adapter']).new(*arguments).collation end
collation_current(environment = env)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 134 def collation_current(environment = env) collation ActiveRecord::Base.configurations[environment] end
create(*arguments)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 86 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_all()
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 96 def create_all each_local_configuration { |configuration| create configuration } end
create_current(environment = env)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 100 def create_current(environment = env) each_current_configuration(environment) { |configuration| create configuration } ActiveRecord::Base.establish_connection(environment.to_sym) end
current_config(options = {})
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 77 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
db_dir()
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 53 def db_dir @db_dir ||= Rails.application.config.paths["db"].first end
drop(*arguments)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 107 def drop(*arguments) configuration = arguments.first class_for_adapter(configuration['adapter']).new(*arguments).drop rescue Exception => error $stderr.puts error, *(error.backtrace) $stderr.puts "Couldn't drop #{configuration['database']}" end
drop_all()
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 115 def drop_all each_local_configuration { |configuration| drop configuration } end
drop_current(environment = env)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 119 def drop_current(environment = env) each_current_configuration(environment) { |configuration| drop configuration } end
env()
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 69 def env @env ||= Rails.env end
fixtures_path()
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 61 def fixtures_path @fixtures_path ||= File.join(root, 'test', 'fixtures') end
load_schema(format = ActiveRecord::Base.schema_format, file = nil)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 159 def load_schema(format = ActiveRecord::Base.schema_format, file = nil) case format when :ruby file ||= File.join(db_dir, "schema.rb") check_schema_file(file) load(file) when :sql file ||= File.join(db_dir, "structure.sql") check_schema_file(file) structure_load(current_config, file) else raise ArgumentError, "unknown format #{format.inspect}" end end
load_seed()
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 182 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
migrations_paths()
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 57 def migrations_paths @migrations_paths ||= Rails.application.paths['db/migrate'].to_a end
purge(configuration)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 143 def purge(configuration) class_for_adapter(configuration['adapter']).new(configuration).purge end
register_task(pattern, task)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 44 def register_task(pattern, task) @tasks ||= {} @tasks[pattern] = task end
root()
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 65 def root @root ||= Rails.root end
seed_loader()
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 73 def seed_loader @seed_loader ||= Rails.application end
structure_dump(*arguments)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 147 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)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 153 def structure_load(*arguments) configuration = arguments.first filename = arguments.delete_at 1 class_for_adapter(configuration['adapter']).new(*arguments).structure_load(filename) end
Private Instance Methods
class_for_adapter(adapter)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 194 def class_for_adapter(adapter) key = @tasks.keys.detect { |pattern| adapter[pattern] } unless key raise DatabaseNotSupported, "Rake tasks not supported by '#{adapter}' adapter" end @tasks[key] end
each_current_configuration(environment) { |configuration| ... }
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 202 def each_current_configuration(environment) environments = [environment] # add test environment only if no RAILS_ENV was specified. environments << 'test' if environment == 'development' && ENV['RAILS_ENV'].nil? configurations = ActiveRecord::Base.configurations.values_at(*environments) configurations.compact.each do |configuration| yield configuration unless configuration['database'].blank? end end
each_local_configuration() { |configuration| ... }
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 213 def each_local_configuration ActiveRecord::Base.configurations.each_value do |configuration| next unless configuration['database'] if local_database?(configuration) yield configuration else $stderr.puts "This task only modifies local databases. #{configuration['database']} is on a remote host." end end end
local_database?(configuration)
click to toggle source
# File lib/active_record/tasks/database_tasks.rb, line 225 def local_database?(configuration) configuration['host'].blank? || LOCAL_HOSTS.include?(configuration['host']) end