connection_handling.rb 4.1 KB
Newer Older
1 2
module ActiveRecord
  module ConnectionHandling
3
    RAILS_ENV   = -> { (Rails.env if defined?(Rails.env)) || ENV["RAILS_ENV"] || ENV["RACK_ENV"] }
4 5
    DEFAULT_ENV = -> { RAILS_ENV.call || "default_env" }

6 7 8 9 10
    # Establishes the connection to the database. Accepts a hash as input where
    # the <tt>:adapter</tt> key must be specified with the name of a database adapter (in lower-case)
    # example for regular databases (MySQL, Postgresql, etc):
    #
    #   ActiveRecord::Base.establish_connection(
A
AvnerCohen 已提交
11 12 13 14 15
    #     adapter:  "mysql",
    #     host:     "localhost",
    #     username: "myuser",
    #     password: "mypass",
    #     database: "somedatabase"
16 17 18 19 20
    #   )
    #
    # Example for SQLite database:
    #
    #   ActiveRecord::Base.establish_connection(
J
Julian Simioni 已提交
21
    #     adapter:  "sqlite3",
22
    #     database: "path/to/dbfile"
23 24 25 26 27
    #   )
    #
    # Also accepts keys as strings (for parsing from YAML for example):
    #
    #   ActiveRecord::Base.establish_connection(
J
Julian Simioni 已提交
28
    #     "adapter"  => "sqlite3",
29
    #     "database" => "path/to/dbfile"
30 31 32 33 34 35 36 37
    #   )
    #
    # Or a URL:
    #
    #   ActiveRecord::Base.establish_connection(
    #     "postgres://myuser:mypass@localhost/somedatabase"
    #   )
    #
38 39 40 41 42 43 44
    # In case <tt>ActiveRecord::Base.configurations</tt> is set (Rails
    # automatically loads the contents of config/database.yml into it),
    # a symbol can also be given as argument, representing a key in the
    # configuration hash:
    #
    #   ActiveRecord::Base.establish_connection(:production)
    #
45 46
    # The exceptions AdapterNotSpecified, AdapterNotFound and ArgumentError
    # may be returned on an error.
47 48 49 50
    def establish_connection(spec = nil)
      spec     ||= DEFAULT_ENV.call.to_sym
      resolver =   ConnectionAdapters::ConnectionSpecification::Resolver.new configurations
      spec     =   resolver.spec(spec)
51 52 53 54 55 56

      unless respond_to?(spec.adapter_method)
        raise AdapterNotFound, "database configuration specifies nonexistent #{spec.config[:adapter]} adapter"
      end

      remove_connection
57
      connection_handler.establish_connection self, spec
58 59
    end

60
    class MergeAndResolveDefaultUrlConfig # :nodoc:
61
      def initialize(raw_configurations)
62
        @raw_config = raw_configurations.dup
63
        @env = DEFAULT_ENV.call.to_s
64 65 66 67 68 69 70 71 72 73
      end

      # Returns fully resolved connection hashes.
      # Merges connection information from `ENV['DATABASE_URL']` if available.
      def resolve
        ConnectionAdapters::ConnectionSpecification::Resolver.new(config).resolve_all
      end

      private
        def config
74
          @raw_config.dup.tap do |cfg|
M
Matthew Draper 已提交
75
            if url = ENV['DATABASE_URL']
M
Matthew Draper 已提交
76 77
              cfg[@env] ||= {}
              cfg[@env]["url"] ||= url
78
            end
79 80 81 82
          end
        end
    end

83 84 85 86 87 88 89 90
    # Returns the connection currently associated with the class. This can
    # also be used to "borrow" the connection to do database work unrelated
    # to any of the specific Active Records.
    def connection
      retrieve_connection
    end

    def connection_id
91
      ActiveRecord::RuntimeRegistry.connection_id
92 93 94
    end

    def connection_id=(connection_id)
95
      ActiveRecord::RuntimeRegistry.connection_id = connection_id
96 97 98 99 100
    end

    # Returns the configuration of the associated connection as a hash:
    #
    #  ActiveRecord::Base.connection_config
A
AvnerCohen 已提交
101
    #  # => {pool: 5, timeout: 5000, database: "db/development.sqlite3", adapter: "sqlite3"}
102 103 104 105 106 107 108 109 110 111 112 113 114 115
    #
    # Please use only for reading.
    def connection_config
      connection_pool.spec.config
    end

    def connection_pool
      connection_handler.retrieve_connection_pool(self) or raise ConnectionNotEstablished
    end

    def retrieve_connection
      connection_handler.retrieve_connection(self)
    end

116
    # Returns +true+ if Active Record is connected.
117 118 119 120 121 122 123 124
    def connected?
      connection_handler.connected?(self)
    end

    def remove_connection(klass = self)
      connection_handler.remove_connection(klass)
    end

J
Jon Leighton 已提交
125 126 127 128
    def clear_cache! # :nodoc:
      connection.schema_cache.clear!
    end

129
    delegate :clear_active_connections!, :clear_reloadable_connections!,
130
      :clear_all_connections!, :to => :connection_handler
131 132
  end
end