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 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 Quails
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 Quails
(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 (likeQuails.env
). -
database_configuration
: configuration of your databases (as inconfig/database.yml
). -
db_dir
: yourdb
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 theload_seed
method. -
root
: a path to the root of the application.
Example usage of DatabaseTasks
outside Quails
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')
Constants
- LOCAL_HOSTS
Attributes
Public Class Methods
Extra flags passed to database CLI tool (mysqldump/pg_dump) when calling db:structure:dump
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 41 mattr_accessor :structure_dump_flags, instance_accessor: false
Extra flags passed to database CLI tool when calling db:structure:load
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 46 mattr_accessor :structure_load_flags, instance_accessor: false
Public Instance Methods
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 185 def charset(*arguments) configuration = arguments.first class_for_adapter(configuration["adapter"]).new(*arguments).charset end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 181 def charset_current(environment = env) charset ActiveRecord::Base.configurations[environment] end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 55 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
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 262 def check_schema_file(filename) unless File.exist?(filename) message = %{#{filename} doesn't exist yet. Run `quails db:migrate` to create it, then try again.}.dup message << %{ If you do not intend to use a database, you should instead alter #{Quails.root}/config/application.rb to limit the frameworks that will be loaded.} if defined?(::Quails.root) Kernel.abort message end end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 194 def collation(*arguments) configuration = arguments.first class_for_adapter(configuration["adapter"]).new(*arguments).collation end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 190 def collation_current(environment = env) collation ActiveRecord::Base.configurations[environment] end
# File activerecord/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
# File activerecord/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
# File activerecord/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
# File activerecord/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
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 80 def db_dir @db_dir ||= Quails.application.config.paths["db"].first end
# File activerecord/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
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 156 def drop_all each_local_configuration { |configuration| drop configuration } end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 160 def drop_current(environment = env) each_current_configuration(environment) { |configuration| drop configuration } end
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")
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 284 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
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 100 def env @env ||= Quails.env end
# File activerecord/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
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 255 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
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 270 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
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 166 def migrate raise "Empty VERSION provided" if ENV["VERSION"] && ENV["VERSION"].empty? verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] != "false" : 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
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 84 def migrations_paths @migrations_paths ||= Quails.application.paths["db/migrate"].to_a end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 199 def purge(configuration) class_for_adapter(configuration["adapter"]).new(configuration).purge end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 203 def purge_all each_local_configuration { |configuration| purge configuration } end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 209 def purge_current(environment = env) each_current_configuration(environment) { |configuration| purge configuration } ActiveRecord::Base.establish_connection(environment.to_sym) end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 71 def register_task(pattern, task) @tasks ||= {} @tasks[pattern] = task end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 96 def root @root ||= Quails.root end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 246 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
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 104 def seed_loader @seed_loader ||= Quails.application end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 216 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
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 222 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
Private Instance Methods
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 292 def class_for_adapter(adapter) _key, task = @tasks.each_pair.detect { |pattern, _task| adapter[pattern] } unless task raise DatabaseNotSupported, "Rake tasks not supported by '#{adapter}' adapter" end task.is_a?(String) ? task.constantize : task end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 300 def each_current_configuration(environment) environments = [environment] environments << "test" if environment == "development" configurations = ActiveRecord::Base.configurations.values_at(*environments) configurations.compact.each do |configuration| yield configuration unless configuration["database"].blank? end end
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 310 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
# File activerecord/lib/active_record/tasks/database_tasks.rb, line 322 def local_database?(configuration) configuration["host"].blank? || LOCAL_HOSTS.include?(configuration["host"]) end