Установка CLI платформы dbt
dbt platform поддерживает разработку с помощью интерфейса командной строки (CLI), предоставляя участникам команды больше гибкости и возможностей для совместной работы. dbt platform CLI позволяет выполнять команды dbt в среде разработки dbt platform из локальной командной строки.
dbt platform CLI — это инструмент dbt platform, доступный пользователям на любом тарифном плане. Он предназначен исключительно для работы с dbt platform и может конфликтовать с локальными установками CLI dbt v1 или dbt v2. Подробнее см. в разделе FAQs.
Команды dbt выполняются в инфраструктуре платформы, что обеспечивает следующие преимущества:
- Безопасное хранение учетных данных в dbt platform
- Автоматическое использование артефактов сборки из производственной среды вашего проекта
- Более быстрые сборки с меньшими затратами
- Поддержка dbt Mesh (межпроектные ссылки
ref)
Схема взаимодействия CLI платформы dbt с инфраструктурой dbt для выполнения команд dbt из локальной командной строки.Предварительные требования
dbt platform CLI доступен во всех регионах развертывания как для мультитенантных, так и для однотенантных учетных записей.
- Если вы установили CLI dbt v1 в виртуальной среде, деактивируйте ее или создайте псевдоним для CLI платформы, прежде чем выполнять команды CLI платформы.
- Если вы установили dbt локально, создайте псевдоним для CLI платформы, прежде чем выполнять команды CLI платформы.
Подробнее об управлении несколькими инструментами dbt platform CLI и создании псевдонима см. в разделе FAQs.
См. руководство Гибридная разработка с dbt platform и dbt v2, чтобы синхронизировать учетные данные, переменные окружения и версии dbt v2 между локальным CLI и dbt platform.
Установка CLI платформы dbt
Вы можете установить dbt platform CLI через командную строку одним из следующих способов:
- macOS (brew)
- Windows (нативный исполняемый файл)
- Linux (нативный исполняемый файл)
Перед началом убедитесь, что Homebrew установлен и доступен в вашем редакторе кода или терминале командной строки. Если в вашей операционной системе возникают конфликты путей, см. раздел FAQs.
- Убедитесь, что dbt еще не установлен, выполнив следующую команду:
which dbt
Если выводится dbt not found, это подтверждает, что он не установлен.
pip uninstall dbt, чтобы удалить dbt v1Если вы установили dbt v1 глобально каким-либо другим способом, удалите его, прежде чем продолжить:
pip uninstall dbt
-
Установите dbt platform CLI с помощью Homebrew:
- Сначала удалите из Homebrew tap
dbt-labs— отдельный репозиторий пакетов. Это предотвратит установку пакетов из этого репозитория через Homebrew:brew untap dbt-labs/dbt - Затем добавьте и установите dbt platform CLI как пакет:
Если у вас подключено несколько tap-репозиториев, используйте
brew tap dbt-labs/dbt-cli
brew install dbtbrew install dbt-labs/dbt-cli/dbt.
- Сначала удалите из Homebrew tap
-
Проверьте установку, выполнив
dbt --helpв командной строке. Если вы видите следующий вывод, установка выполнена правильно:The dbt CLI - an ELT tool for running SQL transformations and data models in dbt...Если вы не видите этот вывод, убедитесь, что вы деактивировали pyenv или venv и что у вас нет глобально установленной версии dbt.
- Обратите внимание: при запуске среды больше не нужно выполнять команду
dbt deps. Раньше этот шаг требовался для инициализации. Однако при любых изменениях в файлеpackages.ymlпо-прежнему необходимо выполнятьdbt deps.
- Обратите внимание: при запуске среды больше не нужно выполнять команду
-
Клонируйте репозиторий на локальный компьютер с помощью
git clone. Например, чтобы клонировать репозиторий GitHub по HTTPS, выполнитеgit clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY. -
После клонирования репозитория настройте dbt platform CLI для своего проекта dbt. Это позволит выполнять команды dbt, например
dbt environment showдля просмотра конфигурации dbt илиdbt compileдля компиляции проекта и проверки моделей и тестов. Вы также сможете добавлять, редактировать и синхронизировать файлы с репозиторием.
Если в вашей операционной системе возникают конфликты путей, см. раздел FAQs.
-
Загрузите последнюю версию для Windows, соответствующую вашей платформе, с GitHub.
-
Извлеките исполняемый файл
dbt.exeв ту же папку, где находится ваш проект dbt.
Опытные пользователи могут настроить несколько проектов для работы с одним и тем же dbt platform CLI следующим образом:
- Поместите исполняемый файл (
.exe) в папку "Program Files" - Добавьте его в переменную окружения PATH в Windows
- Сохраните его там, где необходимо
Обратите внимание: если вы используете VS Code, его необходимо перезапустить, чтобы изменения переменных окружения вступили в силу.
-
Проверьте установку, выполнив
./dbt --helpв командной строке. Если вы видите следующий вывод, установка выполнена правильно:The dbt CLI - an ELT tool for running SQL transformations and data models in dbt...Если вы не видите этот вывод, убедитесь, что вы деактивировали pyenv или venv и что у вас нет глобально установленной версии dbt.
- Обратите внимание: при запуске среды больше не нужно выполнять команду
dbt deps. Раньше этот шаг требовался для инициализации. Однако при любых изменениях в файлеpackages.ymlпо-прежнему необходимо выполнятьdbt deps.
- Обратите внимание: при запуске среды больше не нужно выполнять команду
-
Клонируйте репозиторий на локальный компьютер с помощью
git clone. Например, чтобы клонировать репозиторий GitHub по HTTPS, выполнитеgit clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY. -
После клонирования репозитория настройте dbt platform CLI для своего проекта dbt. Это позволит выполнять команды dbt, например
dbt environment showдля просмотра конфигурации dbt илиdbt compileдля компиляции проекта и проверки моделей и тестов. Вы также сможете добавлять, редактировать и синхронизировать файлы с репозиторием.
Если в вашей операционной системе возникают конфликты путей, см. раздел FAQs.
-
Загрузите последнюю версию для Linux, соответствующую вашей платформе, с GitHub. (Выберите файл в соответствии с архитектурой процессора)
-
Извлеките бинарный файл
dbt-cliв ту же папку, где находится ваш проект dbt.
tar -xf dbt_0.29.9_linux_amd64.tar.gz
./dbt --version
Опытные пользователи могут настроить несколько проектов для работы с одним и тем же исполняемым файлом dbt platform CLI, добавив его в переменную окружения PATH в файле профиля командной оболочки.
-
Проверьте установку, выполнив
./dbt --helpв командной строке. Если вы видите следующий вывод, установка выполнена правильно:The dbt CLI - an ELT tool for running SQL transformations and data models in dbt...Если вы не видите этот вывод, убедитесь, что вы деактивировали pyenv или venv и что у вас нет глобально установленной версии dbt.
- Обратите внимание: при запуске среды больше не нужно выполнять команду
dbt deps. Раньше этот шаг требовался для инициализации. Однако при любых изменениях в файлеpackages.ymlпо-прежнему необходимо выполнятьdbt deps.
- Обратите внимание: при запуске среды больше не нужно выполнять команду
-
Клонируйте репозиторий на локальный компьютер с помощью
git clone. Например, чтобы клонировать репозиторий GitHub по HTTPS, выполнитеgit clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY. -
После клонирования репозитория настройте dbt platform CLI для своего проекта dbt. Это позволит выполнять команды dbt, например
dbt environment showдля просмотра конфигурации dbt илиdbt compileдля компиляции проекта и проверки моделей и тестов. Вы также сможете добавлять, редактировать и синхронизировать файлы с репозиторием.
Обновление CLI платформы dbt
Ниже приведены инструкции по обновлению dbt platform CLI до последней версии в зависимости от вашей операционной системы.
- macOS (brew)
- Windows (исполняемый файл)
- Linux (исполняемый файл)
Чтобы обновить dbt platform CLI, выполните brew update, а затем brew upgrade dbt.
Для обновления следуйте инструкциям по установке для Windows и замените существующий исполняемый файл dbt.exe новым.
Для обновления следуйте инструкциям по установке для Linux и замените существующий исполняемый файл dbt новым.
Особенности использования
dbt platform CLI в настоящее время не поддерживает относительные пути в файле packages.yml. Вместо этого используйте Studio IDE, который поддерживает относительные пути в этом случае.
Ниже приведён пример конфигурации локального пакета в файле packages.yml, которая не будет работать с dbt platform CLI:
# repository_root/my_dbt_project_in_a_subdirectory/packages.yml
packages:
- local: ../shared_macros
В этом примере ../shared_macros — это относительный путь, который указывает dbt:
..— перейти на один уровень вверх (вrepository_root);/shared_macros— найти папкуshared_macrosв корневом каталоге.
Чтобы обойти это ограничение, используйте Studio IDE, который полностью поддерживает относительные пути в packages.yml.