database_tasks.rb 6.9 KB
Newer Older
1 2
module ActiveRecord
  module Tasks # :nodoc:
3
    class DatabaseAlreadyExists < StandardError; end # :nodoc:
4
    class DatabaseNotSupported < StandardError; end # :nodoc:
5

6 7 8 9 10 11
    # <tt>ActiveRecord::Tasks::DatabaseTasks</tt> 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
12 13 14 15
    # 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).
16 17
    #
    #
18
    # The possible config values are:
19
    #
20 21 22 23 24 25
    #   * +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.
26
    #   * +root+: a path to the root of the application.
27
    #
28
    # Example usage of +DatabaseTasks+ outside Rails could look as such:
29
    #
30 31 32 33
    #   include ActiveRecord::Tasks
    #   DatabaseTasks.database_configuration = YAML.load(File.read('my_database_config.yml'))
    #   DatabaseTasks.db_dir = 'db'
    #   # other settings...
34
    #
35
    #   DatabaseTasks.create_current('production')
36
    module DatabaseTasks
37
      extend self
P
Pat Allan 已提交
38

39
      attr_writer :current_config
40
      attr_accessor :database_configuration, :migrations_paths, :seed_loader, :db_dir,
41
                    :fixtures_path, :env, :root
42

43
      LOCAL_HOSTS    = ['127.0.0.1', 'localhost']
44

45 46 47 48 49
      def register_task(pattern, task)
        @tasks ||= {}
        @tasks[pattern] = task
      end

K
kennyj 已提交
50 51 52
      register_task(/mysql/,        ActiveRecord::Tasks::MySQLDatabaseTasks)
      register_task(/postgresql/,   ActiveRecord::Tasks::PostgreSQLDatabaseTasks)
      register_task(/sqlite/,       ActiveRecord::Tasks::SQLiteDatabaseTasks)
K
kennyj 已提交
53

54
      def current_config(options = {})
55
        options.reverse_merge! :env => env
56 57 58
        if options.has_key?(:config)
          @current_config = options[:config]
        else
59
          @current_config ||= ActiveRecord::Base.configurations[options[:env]]
60 61 62
        end
      end

63
      def create(*arguments)
64 65
        configuration = arguments.first
        class_for_adapter(configuration['adapter']).new(*arguments).create
66 67
      rescue DatabaseAlreadyExists
        $stderr.puts "#{configuration['database']} already exists"
68 69 70 71
      rescue Exception => error
        $stderr.puts error, *(error.backtrace)
        $stderr.puts "Couldn't create database for #{configuration.inspect}"
      end
P
Pat Allan 已提交
72

73
      def create_all
74 75
        each_local_configuration { |configuration| create configuration }
      end
P
Pat Allan 已提交
76

77
      def create_current(environment = env)
78 79 80
        each_current_configuration(environment) { |configuration|
          create configuration
        }
81
        ActiveRecord::Base.establish_connection(environment.to_sym)
82
      end
P
Pat Allan 已提交
83

84
      def drop(*arguments)
85 86 87 88 89 90
        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
P
Pat Allan 已提交
91

92
      def drop_all
93 94
        each_local_configuration { |configuration| drop configuration }
      end
P
Pat Allan 已提交
95

96
      def drop_current(environment = env)
97 98 99 100
        each_current_configuration(environment) { |configuration|
          drop configuration
        }
      end
P
Pat Allan 已提交
101

102
      def charset_current(environment = env)
S
Simon Jefford 已提交
103 104 105 106 107 108 109 110
        charset ActiveRecord::Base.configurations[environment]
      end

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

111
      def collation_current(environment = env)
112 113 114 115 116 117 118 119
        collation ActiveRecord::Base.configurations[environment]
      end

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

120
      def purge(configuration)
121 122
        class_for_adapter(configuration['adapter']).new(configuration).purge
      end
P
Pat Allan 已提交
123

K
kennyj 已提交
124 125 126 127 128 129
      def structure_dump(*arguments)
        configuration = arguments.first
        filename = arguments.delete_at 1
        class_for_adapter(configuration['adapter']).new(*arguments).structure_dump(filename)
      end

K
kennyj 已提交
130 131 132 133 134 135
      def structure_load(*arguments)
        configuration = arguments.first
        filename = arguments.delete_at 1
        class_for_adapter(configuration['adapter']).new(*arguments).structure_load(filename)
      end

136
      def check_schema_file(filename)
A
Arun Agrawal 已提交
137
        unless File.exist?(filename)
138 139 140 141 142 143
          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

144 145 146 147 148 149 150 151 152 153
      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

154
      private
P
Pat Allan 已提交
155

156
      def class_for_adapter(adapter)
157
        key = @tasks.keys.detect { |pattern| adapter[pattern] }
158 159 160
        unless key
          raise DatabaseNotSupported, "Rake tasks not supported by '#{adapter}' adapter"
        end
161
        @tasks[key]
162
      end
P
Pat Allan 已提交
163

164
      def each_current_configuration(environment)
165
        environments = [environment]
166
        environments << 'test' if environment == 'development'
P
Pat Allan 已提交
167

168 169 170 171 172 173
        configurations = ActiveRecord::Base.configurations.values_at(*environments)
        configurations.compact.each do |configuration|
          yield configuration unless configuration['database'].blank?
        end
      end

174
      def each_local_configuration
175 176
        ActiveRecord::Base.configurations.each_value do |configuration|
          next unless configuration['database']
P
Pat Allan 已提交
177

178 179 180 181 182 183
          if local_database?(configuration)
            yield configuration
          else
            $stderr.puts "This task only modifies local databases. #{configuration['database']} is on a remote host."
          end
        end
P
Pat Allan 已提交
184 185
      end

186
      def local_database?(configuration)
187
        configuration['host'].blank? || LOCAL_HOSTS.include?(configuration['host'])
188 189
      end
    end
P
Pat Allan 已提交
190
  end
191
end