RSpec
Ruby on Rails
Rubyconfigs_for
- 1.0.0
- 1.1.6
- 1.2.6
- 2.0.3
- 2.1.0
- 2.2.1
- 2.3.8
- 3.0.0
- 3.0.9
- 3.1.0
- 3.2.1
- 3.2.8
- 3.2.13
- 4.0.2
- 4.1.8
- 4.2.1
- 4.2.7
- 4.2.9
- 5.0.0.1
- 5.1.7
- 5.2.3
- 6.0.0 (0)
- 6.1.3.1 (11)
- 6.1.7.7 (0)
- 7.0.0 (38)
- 7.1.3.2 (-3)
- 7.1.3.4 (0)
- What's this?
-
new
-
register_db_config_handler
-
[]
(<= v6.1.7.7)
-
blank?
-
build_configs
-
build_configuration_sentence
-
build_db_config_from_hash
-
build_db_config_from_raw_co...
-
build_db_config_from_string
-
configs_for
-
default_env
-
default_hash
(<= v6.1.7.7)
-
each
(<= v6.0.0)
-
empty?
-
environment_url_config
-
environment_value_for
-
env_with_configs
-
find_db_config
-
first
(<= v6.0.0)
-
merge_db_environment_variables
-
method_missing
(<= v6.0.0)
-
primary?
-
resolve
-
resolve_symbol_connection
-
throw_getter_deprecation
(<= v6.0.0)
-
throw_setter_deprecation
(<= v6.0.0)
-
to_h
(<= v6.1.7.7)
-
walk_configs
= private
= protected
configs_for(env_name: nil, name: nil, config_key: nil, include_hidden: false)
public
Collects the configs for the environment and optionally the specification name passed in. To include replica configurations pass include_hidden: true.
If a 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
-
env_name: The environment name. Defaults to nil which will collect configs for all environments.
-
name: The db config name (i.e. primary, animals, etc.). Defaults to nil. If no env_name is specified the config for the default env and the passed name will be returned.
-
config_key: Selects configs that contain a particular key in the configuration hash. Useful for selecting configs that use a custom db config handler or finding configs with hashes that contain a particular key.
-
include_hidden: Determines whether to include replicas and configurations hidden by database_tasks: false in the returned list. Most of the time we’re only iterating over the primary connections (i.e. migrations don’t need to run for the write and read connection). Defaults to false.
