Опции командной строки
Для единообразия флаги интерфейса командной строки (CLI) следует указывать сразу после префикса dbt и его подкоманд. Это относится и к «глобальным» флагам (поддерживаемым всеми командами). Полный список глобальных параметров CLI для dbt v1 или dbt v2 (в зависимости от выбранной версии документации) приведён в разделе Доступные флаги. Если флаги CLI заданы, они имеют приоритет над переменными окружения и флагами проекта.
Например, вместо использования:
dbt --no-populate-cache run
Вы должны использовать:
dbt run --no-populate-cache
Исторически, передача флагов (таких как "глобальные флаги") перед подкомандой является устаревшей функциональностью, которую dbt Labs может удалить в любое время. Мы не поддерживаем использование одного и того же флага до и после подкоманды.
Использование булевых и небулевых флагов
Вы можете составлять свои команды с булевыми флагами для включения или отключения или с небулевыми флагами, которые используют конкретные значения, такие как строки.
- Небулевые конфигурации
- Булевые конфигурации
Используйте эту структуру небулевой конфигурации:
- Замените
<SUBCOMMAND>на команду, к которой применяется эта конфигурация. <THIS-CONFIG>на конфигурацию, которую вы включаете или отключаете, и<SETTING>на новое значение для конфигурации.
<SUBCOMMAND> --<THIS-CONFIG>=<SETTING>
Пример
dbt run --printer-width=80
dbt test --indirect-selection=eager
Для включения или отключения булевых конфигураций:
- Используйте
<SUBCOMMAND>, к которой применяется эта конфигурация. - Следуйте за
--<THIS-CONFIG>, чтобы включить, или--no-<THIS-CONFIG>, чтобы отключить. - Замените
<THIS-CONFIG>на конфигурацию, которую вы включаете или отключаете.
dbt <SUBCOMMAND> --<THIS-CONFIG>
dbt <SUBCOMMAND> --no-<THIS-CONFIG>
Пример
dbt run --version-check
dbt run --no-version-check
Приоритет конфигурации
Существует несколько способов настройки флагов в зависимости от сценария использования:
- Параметры CLI: Определяют поведение для конкретного вызова. Поддерживаются для всех команд dbt.
- Переменные окружения: Определяют различное поведение в разных средах выполнения (разработка, промышленная эксплуатация или непрерывная интеграция) или для разных пользователей в среде разработки (на основе личных предпочтений).
- Флаги
flagsна уровне проекта вdbt_project.yml: Определяют значения по умолчанию, хранящиеся в системе контроля версий, для всех, кто запускает этот проект. Также позволяют включать или отключать изменения поведения, чтобы управлять переходом с устаревшей функциональности. - Пользовательские настройки (
~/.dbt/user_settings.yml): Определяют личные предпочтения, которые применяются ко всем проектам на вашем компьютере. Записываются автоматически командойdbt login.
Наиболее конкретная настройка имеет приоритет. Наивысший приоритет имеют параметры CLI, затем идут переменные окружения, далее — dbt_project.yml и, наконец, user_settings.yml. Если флаг не задан ни в одном из этих мест, используется значение по умолчанию, определённое в dbt.
# dbt_project.yml
flags:
# значение по умолчанию для запуска этого проекта — везде, всегда, для всех
fail_fast: true
# установите для этой переменной окружения значение 'True' (синтаксис bash)
export DBT_ENGINE_FAIL_FAST=1
dbt run
dbt run --fail-fast # установить True для этого конкретного запуска
dbt run --no-fail-fast # установить False
Есть две категории исключений:
- Флаги, задающие пути к файлам: Флаги для путей к файлам, используемых во время выполнения (например,
--log-pathили--state), нельзя задавать вdbt_project.yml. Чтобы переопределить значения по умолчанию, передайте параметры CLI или задайте переменные окружения ((Версии dbt: v1.11 и новее)DBT_ENGINE_LOG_PATHиDBT_ENGINE_STATE). Флаги, указывающие dbt, где искать ресурсы проекта (например,model-paths), задаются вdbt_project.yml, но в виде ключей верхнего уровня, вне словаряflags; эти настройки должны быть полностью статичными и никогда не меняться в зависимости от команды или среды выполнения. - Флаги включения изменений поведения: Флаги, включающие или отключающие изменения поведения, можно задавать только в
dbt_project.yml. Предполагается, что они задаются в системе контроля версий и изменяются через запросы на слияние (pull/merge request). Их значения не должны оставаться различными для разных запусков, сред или пользователей в течение неопределённо долгого времени.