mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
Fix document formatting of Database configuration classes [ci skip]
* Show options as list. * Fix incorrect quoting.
This commit is contained in:
parent
d2f9b8e800
commit
382a9563a3
3 changed files with 35 additions and 35 deletions
|
@ -17,19 +17,19 @@ module ActiveRecord
|
|||
end
|
||||
|
||||
# Collects the configs for the environment and optionally the specification
|
||||
# name passed in. To include replica configurations pass `include_replicas: true`.
|
||||
# name passed in. To include replica configurations pass <tt>include_replicas: true</tt>.
|
||||
#
|
||||
# If a spec name is provided a single DatabaseConfig object will be
|
||||
# returned, otherwise an array of DatabaseConfig objects will be
|
||||
# returned that corresponds with the environment and type requested.
|
||||
#
|
||||
# Options:
|
||||
# ==== Options
|
||||
#
|
||||
# <tt>env_name:</tt> The environment name. Defaults to +nil+ which will collect
|
||||
# * <tt>env_name:</tt> The environment name. Defaults to +nil+ which will collect
|
||||
# configs for all environments.
|
||||
# <tt>spec_name:</tt> The specification name (i.e. primary, animals, etc.). Defaults
|
||||
# * <tt>spec_name:</tt> The specification name (i.e. primary, animals, etc.). Defaults
|
||||
# to +nil+.
|
||||
# <tt>include_replicas:</tt> Determines whether to include replicas in
|
||||
# * <tt>include_replicas:</tt> Determines whether to include replicas in
|
||||
# the returned list. Most of the time we're only iterating over the write
|
||||
# connection (i.e. migrations don't need to run for the write and read connection).
|
||||
# Defaults to +false+.
|
||||
|
@ -53,7 +53,7 @@ module ActiveRecord
|
|||
|
||||
# Returns the config hash that corresponds with the environment
|
||||
#
|
||||
# If the application has multiple databases `default_hash` will
|
||||
# If the application has multiple databases +default_hash+ will
|
||||
# return the first config hash for the environment.
|
||||
#
|
||||
# { database: "my_db", adapter: "mysql2" }
|
||||
|
@ -65,7 +65,7 @@ module ActiveRecord
|
|||
|
||||
# Returns a single DatabaseConfig object based on the requested environment.
|
||||
#
|
||||
# If the application has multiple databases `find_db_config` will return
|
||||
# If the application has multiple databases +find_db_config+ will return
|
||||
# the first DatabaseConfig for the environment.
|
||||
def find_db_config(env)
|
||||
configurations.find do |db_config|
|
||||
|
|
|
@ -14,14 +14,14 @@ module ActiveRecord
|
|||
# #<ActiveRecord::DatabaseConfigurations::HashConfig:0x00007fd1acbded10
|
||||
# @env_name="development", @spec_name="primary", @config={"database"=>"db_name"}>
|
||||
#
|
||||
# Options are:
|
||||
# ==== Options
|
||||
#
|
||||
# <tt>:env_name</tt> - The Rails environment, i.e. "development"
|
||||
# <tt>:spec_name</tt> - The specification name. In a standard two-tier
|
||||
# * <tt>:env_name</tt> - The Rails environment, i.e. "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
|
||||
# * <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
|
||||
|
@ -33,14 +33,14 @@ module ActiveRecord
|
|||
end
|
||||
|
||||
# Determines whether a database configuration is for a replica / readonly
|
||||
# connection. If the `replica` key is present in the config, `replica?` will
|
||||
# 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`
|
||||
# +migrations_paths+ key is present in the config, +migrations_paths+
|
||||
# will return its value.
|
||||
def migrations_paths
|
||||
config["migrations_paths"]
|
||||
|
|
|
@ -17,15 +17,15 @@ module ActiveRecord
|
|||
# @config={"adapter"=>"postgresql", "database"=>"foo", "host"=>"localhost"},
|
||||
# @url="postgres://localhost/foo">
|
||||
#
|
||||
# Options are:
|
||||
# ==== Options
|
||||
#
|
||||
# <tt>:env_name</tt> - The Rails environment, ie "development"
|
||||
# <tt>:spec_name</tt> - The specification name. In a standard two-tier
|
||||
# * <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>:url</tt> - The database URL.
|
||||
# <tt>:config</tt> - The config hash. This is the hash that contains the
|
||||
# * <tt>:url</tt> - The database URL.
|
||||
# * <tt>:config</tt> - The config hash. This is the hash that contains the
|
||||
# database adapter, name, and other important information for database
|
||||
# connections.
|
||||
class UrlConfig < DatabaseConfig
|
||||
|
@ -42,14 +42,14 @@ module ActiveRecord
|
|||
end
|
||||
|
||||
# Determines whether a database configuration is for a replica / readonly
|
||||
# connection. If the `replica` key is present in the config, `replica?` will
|
||||
# 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`
|
||||
# +migrations_paths+ key is present in the config, +migrations_paths+
|
||||
# will return its value.
|
||||
def migrations_paths
|
||||
config["migrations_paths"]
|
||||
|
|
Loading…
Reference in a new issue