Config.Reader
API для чтения файлов конфигурации, определённых с помощью Config.
В качестве поставщика
Config.Reader также может использоваться в качестве Config.Provider. Поставщик конфигурации используется во время релизов для настройки того, как настраиваются приложения. При использовании в качестве поставщика он ожидает единственный аргумент: путь к конфигурации (как указано в Config.Provider.config_path/0) для файла, который будет прочитан и загружен во время загрузки системы.
Например, если вы ожидаете, что целевая система будет иметь файл конфигурации в абсолютном пути, вы можете добавить это в часть def project вашего mix.exs:
releases: [
demo: [
config_providers: [
{Config.Reader, "/etc/config.exs"}
]
]
]
Или если вы хотите прочитать пользовательский путь внутри релиза:
config_providers: [{Config.Reader, {:system, "RELEASE_ROOT", "/config.exs"}}]
Вы также можете передать список ключевых слов с опциями, где :path является обязательным ключом:
config_providers: [
{Config.Reader,
path: "/etc/config.exs",
env: :prod,
imports: :disabled}
]
Помните, что Mix по умолчанию загружает config/runtime.exs. Для получения дополнительных примеров и сценариев см. модуль Config.Providers.
Обзор
Функции
- eval!(file, contents, opts \\ [])
Вычисляет конфигурацию
contentsдля заданногоfile.- merge(config1, config2)
Объединяет две конфигурации.
- read!(file, opts \\ [])
Читает файл конфигурации.
- read_imports!(file, opts \\ [])
Читает указанный файл конфигурации и возвращает конфигурацию вместе с её импортами.
Функции
eval!(file, contents, opts \\ [])Source
@spec eval!(Path.t(), binary(), keyword()) :: keyword()
Вычисляет конфигурацию contents для заданного file.
Принимает те же опции, что и read!/2.
merge(config1, config2)Source
@spec merge(keyword(), keyword()) :: keyword()
Объединяет две конфигурации.
Конфигурации объединяются вместе, при этом значения во втором случае имеют больший приоритет, чем в первом, в случае конфликтов. Если оба значения установлены в списки ключевых слов, они глубоко объединяются.
Примеры
iex> Config.Reader.merge([app: [k: :v1]], [app: [k: :v2]]) [app: [k: :v2]] iex> Config.Reader.merge([app: [k: [v1: 1, v2: 2]]], [app: [k: [v2: :a, v3: :b]]]) [app: [k: [v1: 1, v2: :a, v3: :b]]] iex> Config.Reader.merge([app1: []], [app2: []]) [app1: [], app2: []]
read!(file, opts \\ [])Source
@spec read!( Path.t(), keyword() ) :: keyword()
Читает файл конфигурации.
Опции
:imports- список уже импортированных путей или:disabledдля отключения импортов:env- среда, в которой выполняется файл конфигурации. См.Config.config_env/0для примера использования:target- целевая среда, в которой выполняется файл конфигурации. См.Config.config_target/0для примера использования
read_imports!(file, opts \\ [])Source
@spec read_imports!(
Path.t(),
keyword()
) :: {keyword(), [Path.t()]} Читает указанный файл конфигурации и возвращает конфигурацию вместе с её импортами.
Принимает те же опции, что и read!/2. Хотя обратите внимание, что опция :imports не может быть отключена в read_imports!/2.
© 2012 Plataformatec
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/elixir/1.13.4/Config.Reader.html
