activerecord/lib/active_record/database_configurations/hash_config.rb


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

# frozen_string_literal: true

module ActiveRecord
  class DatabaseConfigurations
    # A HashConfig object is created for each database configuration entry that
    # is created from a hash.
    #
    # A hash config:
    #
    #   { "development" => { "database" => "db_name" } }
    #
    # Becomes:
    #
    #   #<ActiveRecord::DatabaseConfigurations::HashConfig:0x00007fd1acbded10
    #     @env_name="development", @spec_name="primary", @config={"database"=>"db_name"}>
    #
    # Options are:
    #
    # <tt>:env_name</tt> - The Rails environment, ie "development"
    # <tt>:spec_name</tt> - The specification name. In a standard two-tier
    # database configuration this will default to "primary". In a multiple
    # database three-tier database configuration this corresponds to the name
    # used in the second tier, for example "primary_readonly".
    # <tt>:config</tt> - The config hash. This is the hash that contains the
    # database adapter, name, and other important information for database
    # connections.
    class HashConfig < DatabaseConfig
      attr_reader :config

      def initialize(env_name, spec_name, config)
        super(env_name, spec_name)
        @config = config
      end

      # Determines whether a database configuration is for a replica / readonly
      # connection. If the `replica` key is present in the config, `replica?` will
      # return +true+.
      def replica?
        config["replica"]
      end

      # The migrations paths for a database configuration. If the
      # `migrations_paths` key is present in the config, `migrations_paths`
      # will return its value.
      def migrations_paths
        config["migrations_paths"]
      end
    end
  end
end