Быстрый старт для dbt и Databricks

Назад к гайдам

Platform

Quickstart

Databricks

Beginner

Menu

Введение

В этом кратком руководстве вы узнаете, как использовать dbt вместе с Databricks. В нём показано, как:

• Создать рабочее пространство Databricks.
• Загрузить пример данных в ваш аккаунт Databricks.
• Подключить dbt к Databricks.
• Взять пример запроса и превратить его в модель в вашем проекте dbt. Модель в dbt — это select-запрос.
• Добавить тесты к вашим моделям.
• Задокументировать ваши модели.
• Запланировать выполнение задания.

Видео для вас

Вы можете бесплатно ознакомиться с Основами dbt, если вас интересует обучение с видео.

Предварительные требования

• У вас есть аккаунт dbt.
• У вас есть аккаунт у облачного провайдера (например, AWS, GCP или Azure), а также права на создание S3 bucket в рамках этого аккаунта. В демонстрационных целях в этом руководстве в качестве облачного провайдера используется AWS.

Связанные материалы

• Узнайте больше с курсами dbt Learn
• CI задания
• Развертывание заданий
• Уведомления о заданиях
• Актуальность источников

Создание рабочего пространства Databricks

1. Используйте ваш существующий аккаунт или зарегистрируйтесь для получения аккаунта Databricks. Заполните форму с вашей пользовательской информацией и нажмите Continue.

   Регистрация в Databricks

2. На следующем экране выберите вашего облачного провайдера. В этом руководстве используется AWS в качестве облачного провайдера, но если вы используете Azure или GCP, выберите вашу платформу. Процесс настройки будет аналогичным. Не выбирайте опцию Get started with Community Edition, так как она не предоставит необходимую вычислительную мощность для этого руководства.

   Выбор облачного провайдера

3. Проверьте вашу электронную почту и завершите процесс верификации.

4. После завершения процесса верификации вы попадете на первый экран настройки. Databricks по умолчанию выбирает план Premium, и вы можете изменить пробный период на Enterprise на этой странице.

   Выбор плана Databricks

5. Теперь пришло время создать ваше первое рабочее пространство. Рабочее пространство Databricks — это среда для доступа ко всем вашим ресурсам Databricks. Рабочее пространство организует такие объекты, как блокноты, SQL-склады, кластеры и многое другое, в одном месте. Укажите имя вашего рабочего пространства, выберите соответствующий регион AWS и нажмите Start Quickstart. Возможно, вы увидите флажок I have data in S3 that I want to query with Databricks. Вам не нужно отмечать его для этого руководства.

   Создание ресурсов AWS

6. Нажав на Start Quickstart, вы будете перенаправлены на AWS и вам будет предложено войти в систему, если вы еще этого не сделали. После входа в систему вы должны увидеть страницу, похожую на эту.

   Создание ресурсов AWS

подсказка

Если вы получаете ошибку сессии и не перенаправляетесь на эту страницу, вы можете вернуться в интерфейс Databricks и создать рабочее пространство из интерфейса. Все, что вам нужно сделать, это нажать create workspaces, выбрать quickstart, заполнить форму и нажать Start Quickstart.

7. Нет необходимости изменять какие-либо из предварительно заполненных полей в Параметрах. Просто добавьте ваш пароль Databricks в разделе Databricks Account Credentials. Отметьте Подтверждение и нажмите Create stack.

   Параметры
   Возможности

8. Вернитесь на вкладку Databricks. Вы должны увидеть, что ваше рабочее пространство готово к использованию.

   Рабочее пространство Databricks

9. Теперь давайте перейдем в рабочее пространство. Нажмите Open и войдите в рабочее пространство, используя те же данные для входа, что и для входа в аккаунт.

Загрузка данных

1. Скачайте эти CSV-файлы (пример данных Jaffle Shop), которые вам понадобятся для этого руководства:

   • jaffle_shop_customers.csv
   • jaffle_shop_orders.csv
   • stripe_payments.csv

2. Сначала нам нужен SQL-склад. Найдите выпадающее меню и переключитесь в пространство SQL.

   Пространство SQL

3. Сейчас мы будем настраивать SQL-склад. Выберите SQL Warehouses в консоли слева. Вы увидите, что существует склад SQL по умолчанию.

4. Нажмите Start на Starter Warehouse. Это займет несколько минут, чтобы запустить необходимые ресурсы.

5. Как только SQL-склад будет запущен, нажмите New, а затем File upload в выпадающем меню.

   Новая загрузка файла с использованием Databricks SQL

6. Давайте сначала загрузим данные Jaffle Shop Customers. Перетащите файл jaffle_shop_customers.csv в интерфейс.

   Загрузчик таблиц Databricks

7. Обновите атрибуты таблицы вверху:

   • data_catalog = hive_metastore
   • database = default
   • table = jaffle_shop_customers
   • Убедитесь, что типы данных столбцов корректны. Вы можете сделать это, наведя курсор на значок типа данных рядом с именем столбца.
     • ID = bigint
     • FIRST_NAME = string
     • LAST_NAME = string
   Загрузка клиентов jaffle shop

8. Нажмите Create внизу, когда закончите.

9. Теперь давайте сделаем то же самое для Jaffle Shop Orders и Stripe Payments.

Загрузка заказов jaffle shop

Загрузка платежей Stripe

10. После этого убедитесь, что вы можете выполнять запросы к учебным данным. Перейдите в SQL Editor через меню слева. Это приведет вас к редактору запросов.

11. Убедитесь, что вы можете выполнить select * из каждой из таблиц с помощью следующих фрагментов кода.

    select * from default.jaffle_shop_customers
    select * from default.jaffle_shop_orders
    select * from default.stripe_payments
    Проверка запроса

12. Чтобы гарантировать, что любые пользователи, которые могут работать над вашим проектом dbt, имеют доступ к вашему объекту, выполните эту команду.

    grant all privileges on schema default to users;

Подключение dbt к Databricks

Существует два способа подключить dbt к Databricks. Первый вариант — Partner Connect, который предоставляет упрощённый процесс настройки и позволяет создать учётную запись dbt прямо из вашей новой пробной учётной записи Databricks. Второй вариант — создать учётную запись dbt отдельно и самостоятельно настроить подключение к Databricks (ручное подключение).

Если вы хотите начать работу как можно быстрее, dbt Labs рекомендует использовать Partner Connect. Если же вы хотите с самого начала настроить конфигурацию под свои требования и лучше разобраться в процессе настройки dbt, dbt Labs рекомендует подключаться вручную.

Настройка интеграции через Partner Connect

примечание

Partner Connect предназначен для пробных партнёрских аккаунтов. Если у вашей организации уже есть аккаунт dbt, подключение нужно выполнить вручную. Инструкции см. в разделе Connect to dbt manually документации Databricks.

Чтобы подключить dbt к Databricks с помощью Partner Connect, выполните следующие действия:

1. В боковой панели вашего аккаунта Databricks нажмите Partner Connect.

2. Нажмите на плитку dbt.

3. Выберите каталог из выпадающего списка, а затем нажмите Next. Выпадающий список отображает каталоги, к которым у вас есть доступ на чтение и запись. Если ваше рабочее пространство не <UC>-enabled, используется устаревший Hive metastore (hive_metastore).

4. Если в вашем рабочем пространстве есть SQL-склады, выберите SQL-склад из выпадающего списка. Если ваш SQL-склад остановлен, нажмите Start.

5. Если в вашем рабочем пространстве нет SQL-складов:

   1. Нажмите Create warehouse. В вашем браузере откроется новая вкладка, на которой отображается страница New SQL Warehouse в интерфейсе Databricks SQL.
   2. Следуйте шагам в Создание SQL-склада в документации Databricks.
   3. Вернитесь на вкладку Partner Connect в вашем браузере и закройте плитку dbt.
   4. Снова откройте плитку dbt.
   5. Выберите SQL-склад, который вы только что создали, из выпадающего списка.

6. Выберите схему из выпадающего списка, а затем нажмите Add. Выпадающий список отображает схемы, к которым у вас есть доступ на чтение и запись. Вы можете повторить этот шаг, чтобы добавить несколько схем.

   Partner Connect создает следующие ресурсы в вашем рабочем пространстве:

   • Сервисный принципал Databricks с именем DBT_CLOUD_USER.
   • Личный токен доступа Databricks, связанный с сервисным принципалом DBT_CLOUD_USER.

   Partner Connect также предоставляет следующие привилегии сервисному принципалу DBT_CLOUD_USER:

   • (Unity Catalog) USE CATALOG: Необходим для взаимодействия с объектами в выбранном каталоге.
   • (Unity Catalog) USE SCHEMA: Необходим для взаимодействия с объектами в выбранной схеме.
   • (Unity Catalog) CREATE SCHEMA: Предоставляет возможность создавать схемы в выбранном каталоге.
   • (Hive metastore) USAGE: Необходим для предоставления привилегий SELECT и READ_METADATA для выбранных вами схем.
   • SELECT: Предоставляет возможность читать выбранные вами схемы.
   • (Hive metastore) READ_METADATA: Предоставляет возможность читать метаданные для выбранных вами схем.
   • CAN_USE: Предоставляет разрешения на использование выбранного вами SQL-склада.

7. Нажмите Next.

Поле Email отображает адрес электронной почты вашей учетной записи Databricks. dbt Labs использует этот адрес электронной почты, чтобы предложить вам создать пробную учетную запись dbt.

9. Нажмите Connect to dbt.

   В вашем веб-браузере откроется новая вкладка, на которой отображается веб-сайт getdbt.com.

10. Выполните инструкции на экране на сайте getdbt.com, чтобы создать пробную учетную запись dbt.

Настройка репозитория под управлением dbt

При разработке в dbt вы можете использовать Git для управления версиями вашего кода.

Чтобы подключиться к репозиторию, вы можете либо настроить размещённый в dbt managed repository, либо напрямую подключиться к поддерживаемому git‑провайдеру. Managed repositories — это отличный способ попробовать dbt без необходимости создавать новый репозиторий. В долгосрочной перспективе лучше подключиться к поддерживаемому git‑провайдеру, чтобы использовать такие возможности, как автоматизация и непрерывная интеграция.

Чтобы настроить управляемый репозиторий:

1. В разделе "Настроить репозиторий" выберите Управляемый.
2. Введите имя для вашего репозитория, например, bbaggins-dbt-quickstart.
3. Нажмите Создать. Создание и импорт вашего репозитория займет несколько секунд.
4. Как только вы увидите сообщение "Репозиторий успешно импортирован", нажмите Продолжить.

Инициализация вашего проекта dbt и начало разработки

Теперь, когда у вас настроен репозиторий, вы можете инициализировать проект и начать разработку в dbt:

1. Нажмите Start developing in the Studio IDE. При первом запуске это может занять несколько минут: в это время устанавливается соединение с git, клонируется репозиторий и проверяется подключение к хранилищу данных.
2. Над деревом файлов слева нажмите Initialize dbt project. В результате будет создана структура папок с примерами моделей.
3. Сделайте первый коммит, нажав Commit and sync. Используйте сообщение коммита initial commit и нажмите Commit. Это создаст первый коммит в вашем управляемом репозитории и позволит открыть ветку, в которой вы сможете добавлять новый dbt-код.
4. Теперь вы можете напрямую выполнять запросы к данным в вашем хранилище и запускать dbt run. Вы можете попробовать это прямо сейчас:
   • Нажмите + Create new file, добавьте этот запрос в новый файл и нажмите Save as, чтобы сохранить новый файл:

     select * from default.jaffle_shop_customers
   • В командной строке внизу введите dbt run и нажмите Enter. Вы должны увидеть сообщение dbt run succeeded.

Создание вашей первой модели

У вас есть два варианта работы с файлами в Studio IDE:

• Создать новую ветку (рекомендуется) — Создайте новую ветку, чтобы вносить изменения и коммитить их. Перейдите в раздел Version Control на левой боковой панели и нажмите Create branch.
• Редактировать в защищённой основной ветке — Если вы предпочитаете редактировать, форматировать или линтить файлы и выполнять команды dbt напрямую в вашей основной git-ветке. Studio IDE не позволяет делать коммиты в защищённую ветку, поэтому вам будет предложено закоммитить изменения в новую ветку.

Назовите новую ветку add-customers-model.

1. Нажмите на ... рядом с директорией models, затем выберите Create file.
2. Назовите файл customers.sql, затем нажмите Create.
3. Скопируйте следующий запрос в файл и нажмите Save.

with customers as (

    select
        id as customer_id,
        first_name,
        last_name

    from jaffle_shop_customers

),

orders as (

    select
        id as order_id,
        user_id as customer_id,
        order_date,
        status

    from jaffle_shop_orders

),

customer_orders as (

    select
        customer_id,

        min(order_date) as first_order_date,
        max(order_date) as most_recent_order_date,
        count(order_id) as number_of_orders

    from orders

    group by 1

),

final as (

    select
        customers.customer_id,
        customers.first_name,
        customers.last_name,
        customer_orders.first_order_date,
        customer_orders.most_recent_order_date,
        coalesce(customer_orders.number_of_orders, 0) as number_of_orders

    from customers

    left join customer_orders using (customer_id)

)

select * from final

4. Введите dbt run в командной строке внизу экрана. Вы должны получить успешное выполнение и увидеть три модели.

Позже вы сможете подключить ваши инструменты бизнес-аналитики (BI) к этим представлениям и таблицам, чтобы они читали только очищенные данные, а не сырые данные в вашем инструменте BI.

Часто задаваемые вопросы

Как посмотреть SQL, который выполняет dbt?

Чтобы посмотреть SQL, который выполняет dbt, вы можете заглянуть в:

• dbt:
  • В выводе выполнения нажмите на имя модели, а затем выберите "Details"
• dbt Core:
  • Директория target/compiled/ для скомпилированных операторов select
  • Директория target/run/ для скомпилированных операторов create
  • Файл logs/dbt.log для подробного логирования

Как dbt выбирает, в какой схеме строить мои модели?

По умолчанию dbt собирает модели в вашей целевой схеме. Чтобы изменить целевую схему:

• Если вы разрабатываете в dbt, эти настройки задаются для каждого пользователя при первом использовании среды разработки.
• Если вы разрабатываете с помощью dbt Core, это параметр schema: в вашем файле profiles.yml.

Если вы хотите распределить ваши модели по нескольким схемам, ознакомьтесь с документацией по использованию пользовательских схем.

Примечание: в BigQuery dataset используется как синоним schema.

Нужно ли создавать целевую схему перед запуском dbt?

Нет! dbt проверит, существует ли схема, когда она запускается. Если схема не существует, dbt создаст её для вас.

Если я перезапущу dbt, будет ли простой, пока модели перестраиваются?

Нет! SQL, который dbt генерирует за кулисами, гарантирует, что любые связи заменяются атомарно (т.е. ваши бизнес-пользователи не испытают никакого простоя).

Реализация этого процесса варьируется в зависимости от каждого хранилища данных, проверьте логи, чтобы увидеть, какой SQL выполняет dbt.

Что произойдет, если в моем SQL-запросе ошибка или я получу ошибку базы данных?

Если в вашем SQL есть ошибка, dbt вернет ошибку, которую возвращает ваша база данных.

$ dbt run --select customers
Running with dbt=1.9.0
Found 3 models, 9 tests, 0 snapshots, 0 analyses, 133 macros, 0 operations, 0 seed files, 0 sources

14:04:12 | Concurrency: 1 threads (target='dev')
14:04:12 |
14:04:12 | 1 of 1 START view model dbt_alice.customers.......................... [RUN]
14:04:13 | 1 of 1 ERROR creating view model dbt_alice.customers................. [ERROR in 0.81s]
14:04:13 |
14:04:13 | Finished running 1 view model in 1.68s.

Completed with 1 error and 0 warnings:

Database Error in model customers (models/customers.sql)
  Syntax error: Expected ")" but got identifier `your-info-12345` at [13:15]
  compiled SQL at target/run/jaffle_shop/customers.sql

Done. PASS=0 WARN=0 ERROR=1 SKIP=0 TOTAL=1

Любые модели, зависящие от этой модели, также будут пропущены. Используйте сообщение об ошибке и скомпилированный SQL для отладки любых ошибок.

Изменение способа материализации вашей модели

Одной из самых мощных функций dbt является возможность изменять способ материализации модели в вашем хранилище данных, просто изменяя значение конфигурации. Вы можете переключаться между таблицами и представлениями, изменяя ключевое слово, вместо того чтобы писать язык определения данных (DDL) для выполнения этого за кулисами.

По умолчанию все создается как представление. Вы можете переопределить это на уровне директории, чтобы все в этой директории материализовалось по-другому.

1. Отредактируйте ваш файл dbt_project.yml.

   • Обновите имя вашего проекта на:

     dbt_project.yml

     name: 'jaffle_shop'

   • Настройте jaffle_shop так, чтобы всё внутри него материализовалось как таблица; и настройте example так, чтобы всё внутри него материализовалось как представление (view). Обновите конфигурацию models в YAML-файле проекта следующим образом:

     dbt_project.yml

     models:
       jaffle_shop:
         +materialized: table
         example:
           +materialized: view

   • Нажмите Сохранить.

2. Введите команду dbt run. Ваша модель customers теперь должна быть построена как таблица!

   к сведению

   Для этого dbt сначала должен был выполнить оператор drop view (или API вызов на BigQuery), затем оператор create table as.

3. Отредактируйте models/customers.sql, чтобы переопределить dbt_project.yml только для модели customers, добавив следующий фрагмент в начало, и нажмите Сохранить:

   models/customers.sql

   {{
     config(
       materialized='view'
     )
   }}
   
   with customers as (
   
       select
           id as customer_id
           ...
   
   )
   

4. Введите команду dbt run. Ваша модель customers теперь должна быть построена как представление.

   • Пользователям BigQuery необходимо выполнить dbt run --full-refresh вместо dbt run, чтобы полностью применить изменения материализации.

5. Введите команду dbt run --full-refresh, чтобы изменения вступили в силу в вашем хранилище данных.

Часто задаваемые вопросы

Какие материализации доступны в dbt?

dbt поставляется с пятью материализациями: view, table, incremental, ephemeral и materialized_view. Ознакомьтесь с документацией по материализациям для получения дополнительной информации о каждом из этих вариантов.

Вы также можете создать свои собственные пользовательские материализации, если это необходимо, однако это является продвинутой функцией dbt.

Какую материализацию использовать для моей модели?

Начните с представлений (views), а затем измените модели на таблицы, когда это потребуется по причинам производительности (например, когда последующие запросы замедлились).

Ознакомьтесь с документацией по материализациям для получения советов о том, когда использовать каждую materialization.

Какие существуют конфигурации моделей?

Вы также можете настроить:

• теги для поддержки легкой категоризации и выбора графа
• пользовательские схемы для разделения ваших моделей по нескольким схемам
• алиасы, если имя вашего view/table должно отличаться от имени файла
• Фрагменты SQL, которые выполняются в начале или в конце модели, известные как хуки
• Конфигурации, специфичные для хранилища, для повышения производительности (например, ключи sort и dist на Redshift, partitions на BigQuery)

Ознакомьтесь с документацией по конфигурациям моделей, чтобы узнать больше.

Удаление примерных моделей

Теперь вы можете удалить файлы, которые dbt создал при инициализации проекта:

1. Удалите директорию models/example/.

2. Удалите ключ example: из вашего файла dbt_project.yml, а также любые конфигурации, которые перечислены под ним.

   dbt_project.yml

   # до
   models:
     jaffle_shop:
       +materialized: table
       example:
         +materialized: view
   dbt_project.yml

   # после
   models:
     jaffle_shop:
       +materialized: table

3. Сохраните изменения.

Часто задаваемые вопросы

Как удалить удаленные модели из моего хранилища данных?

Если вы удаляете модель из вашего dbt проекта, dbt не удаляет автоматически связь из вашей схемы. Это означает, что в схемах, которые создает dbt, могут остаться лишние объекты, что может запутать других пользователей.

(Это также может произойти, когда вы переключаете модель с view или table на эфемерную)

Когда вы удаляете модели из вашего dbt проекта, вам следует вручную удалить связанные связи из вашей схемы.

Я получил сообщение об ошибке "неиспользуемые конфигурации модели", что это значит?

Возможно, вы забыли вложить ваши конфигурации под именем вашего проекта, или вы пытаетесь применить конфигурации к директории, которая не существует.

Ознакомьтесь с этой статьей, чтобы понять больше.

Создание моделей на основе других моделей

Как лучшая практика в SQL, следует разделять логику, которая очищает ваши данные, от логики, которая трансформирует ваши данные. Вы уже начали делать это в существующем запросе, используя общие табличные выражения (CTE).

Теперь вы можете поэкспериментировать, разделив логику на отдельные модели и используя функцию ref для построения моделей на основе других моделей:

Граф, который мы хотим для нашего проекта dbt

1. Создайте новый SQL-файл, models/stg_customers.sql, с SQL из CTE customers в нашем исходном запросе.

2. Создайте второй новый SQL-файл, models/stg_orders.sql, с SQL из CTE orders в нашем исходном запросе.

   models/stg_customers.sql

   select
       id as customer_id,
       first_name,
       last_name
   
   from jaffle_shop_customers
   models/stg_orders.sql

   select
       id as order_id,
       user_id as customer_id,
       order_date,
       status
   
   from jaffle_shop_orders

3. Отредактируйте SQL в вашем файле models/customers.sql следующим образом:

   models/customers.sql

   with customers as (
   
       select * from {{ ref('stg_customers') }}
   
   ),
   
   orders as (
   
       select * from {{ ref('stg_orders') }}
   
   ),
   
   customer_orders as (
   
       select
           customer_id,
   
           min(order_date) as first_order_date,
           max(order_date) as most_recent_order_date,
           count(order_id) as number_of_orders
   
       from orders
   
       group by 1
   
   ),
   
   final as (
   
       select
           customers.customer_id,
           customers.first_name,
           customers.last_name,
           customer_orders.first_order_date,
           customer_orders.most_recent_order_date,
           coalesce(customer_orders.number_of_orders, 0) as number_of_orders
   
       from customers
   
       left join customer_orders using (customer_id)
   
   )
   
   select * from final
   

4. Выполните dbt run.

   На этот раз, когда вы выполнили dbt run, были созданы отдельные представления/таблицы для stg_customers, stg_orders и customers. dbt определил порядок выполнения этих моделей. Поскольку customers зависит от stg_customers и stg_orders, dbt строит customers последним. Вам не нужно явно определять эти зависимости.

Часто задаваемые вопросы

Как запустить одну модель за раз?

Чтобы запустить одну модель, используйте флаг --select (или флаг -s), указав имя модели:

$ dbt run --select customers

Ознакомьтесь с документацией по синтаксису выбора моделей для получения информации о других операторах и примерах.

Должны ли имена ресурсов, используемых в ref, быть уникальными?

В рамках одного проекта: да! Чтобы построить зависимости между ресурсами (такими как модели, семена и снимки), вам нужно использовать функцию ref и передать в нее имя ресурса в качестве аргумента. dbt использует это имя ресурса для уникального разрешения ref на конкретный ресурс. В результате, эти имена ресурсов должны быть уникальными, даже если они находятся в разных папках.

Ресурс в одном проекте может иметь то же имя, что и ресурс в другом проекте (установленном как зависимость). dbt использует имя проекта для уникальной идентификации каждого ресурса. Мы называем это "пространством имен". Если вы используете ref для ресурса с дублированным именем, он будет разрешен в ресурс в том же пространстве имен (пакет или проект) или вызовет ошибку из-за неоднозначной ссылки. Используйте двухаргументный ref для устранения неоднозначности ссылок, указав пространство имен.

Эти ресурсы все равно должны размещаться в разных местах в хранилище данных. Прочтите документацию по пользовательским псевдонимам и пользовательским схемам для получения подробной информации о том, как этого добиться.

Как я создаю больше моделей, как мне организовать мой проект? Как мне назвать мои модели?

Нет единственного лучшего способа структурировать проект! Каждая организация уникальна.

Если вы только начинаете, ознакомьтесь с тем, как мы (dbt Labs) структурируем наши dbt проекты.

Добавьте тесты к вашим моделям

Добавление data tests в проект помогает убедиться, что ваши модели работают корректно.

Чтобы добавить data tests в проект:

1. Создайте новый YAML-файл в директории models, назвав его models/schema.yml.

2. Добавьте в файл следующее содержимое:

   models/schema.yml

   version: 2
   
   models:
     - name: customers
       columns:
         - name: customer_id
           data_tests:
             - unique
             - not_null
   
     - name: stg_customers
       columns:
         - name: customer_id
           data_tests:
             - unique
             - not_null
   
     - name: stg_orders
       columns:
         - name: order_id
           data_tests:
             - unique
             - not_null
         - name: status
           data_tests:
             - accepted_values:
                 arguments: # available in v1.10.5 and higher. Older versions can set the <argument_name> as the top-level property.
                   values: ['placed', 'shipped', 'completed', 'return_pending', 'returned']
         - name: customer_id
           data_tests:
             - not_null
             - relationships:
                 arguments:
                   to: ref('stg_customers')
                   field: customer_id
   

3. Запустите dbt test и убедитесь, что все ваши тесты прошли успешно.

Когда вы запускаете dbt test, dbt проходит по вашим YAML-файлам и создает запрос для каждого теста. Каждый запрос вернет количество записей, которые не прошли тест. Если это число равно 0, то тест считается успешным.

Часто задаваемые вопросы

Какие тесты доступны для использования в dbt? Могу ли я добавить свои собственные тесты?

«Из коробки» dbt поставляется со следующими тестами данных:

• unique
• not_null
• accepted_values
• relationships (т.е. ссылочная целостность)

Вы также можете написать свои собственные пользовательские тесты схемы данных.

Некоторые дополнительные пользовательские schema tests были выложены в open source в пакете dbt-utils. Ознакомьтесь с документацией по packages, чтобы узнать, как сделать эти тесты доступными в вашем проекте.

Обратите внимание, что на данный момент документировать data tests нельзя, однако мы рекомендуем посмотреть это обсуждение dbt Core, где сообщество dbt делится идеями и предложениями.

Как протестировать одну модель за раз?

Запуск тестов для одной модели очень похож на запуск самой модели: используйте флаг --select (или флаг -s), за которым следует имя модели:

dbt test --select customers

Ознакомьтесь с документацией по синтаксису выбора моделей для полного синтаксиса, и примерами выбора тестов в частности.

Один из моих тестов не прошел, как я могу его отладить?

Чтобы отладить неудачный тест, найдите SQL, который выполнил dbt, следующим образом:

• dbt:

  • В выводе результатов теста нажмите на упавший тест, а затем выберите "Details".

• dbt Core:

  • Откройте путь к файлу, который указан в сообщении об ошибке.
  • Перейдите в директорию target/compiled/schema_tests, где находятся все скомпилированные запросы тестов.

Скопируйте SQL в редактор запросов (в dbt вы можете вставить его в новый Statement) и выполните запрос, чтобы найти записи, которые не прошли тест.

Должен ли мой файл с тестами называться `schema.yml`?

Нет! Вы можете назвать этот файл как угодно (включая whatever_you_want.yml), при условии, что:

• Файл находится в вашем каталоге models/¹
• Файл имеет расширение .yml

Посмотрите документацию для получения дополнительной информации.

¹Если вы объявляете свойства для seeds, snapshots или macros, вы также можете разместить этот файл в соответствующем каталоге — seeds/, snapshots/ и macros/ соответственно.

Почему файлы YAML для моделей и источников всегда начинаются с `version: 2`?

Когда‑то структура этих файлов .yml была совсем другой (привет всем, кто пользовался dbt в те времена!). Добавление version: 2 позволило нам сделать эту структуру более расширяемой.

Начиная с dbt Core v1.5, ключ верхнего уровня version: является необязательным во всех ресурсных YAML‑файлах. Если он указан, поддерживается только version: 2.

Также, начиная с версии 1.5, и config-version: 2, и ключ верхнего уровня version: в файле dbt_project.yml являются необязательными.

В настоящее время ресурсные YAML‑файлы не требуют наличия этой настройки. Если она указана, мы поддерживаем только version: 2. Хотя мы не ожидаем в ближайшее время обновлять YAML‑файлы до version: 3, наличие этой конфигурации упростит для нас внедрение новых структур в будущем.

What data tests should I add to my project?

Мы рекомендуем, чтобы у каждой модели был data test на primary key, то есть на колонку, которая является unique и not_null.

Мы также рекомендуем тестировать любые предположения о ваших исходных данных. Например, если вы считаете, что ваши платежи могут быть только одним из трех методов оплаты, вы должны регулярно проверять это предположение — новый метод оплаты может привести к логическим ошибкам в вашем SQL.

В продвинутых проектах dbt мы рекомендуем использовать sources и запускать эти тесты целостности данных источника против источников, а не моделей.

Когда следует запускать data tests?

Вам следует запускать data tests каждый раз, когда вы пишете новый код (чтобы убедиться, что изменения в SQL не сломали существующие модели), а также каждый раз, когда вы запускаете трансформации в production (чтобы убедиться, что ваши предположения о исходных данных по‑прежнему верны).

Документируйте ваши модели

Добавление документации в ваш проект позволяет подробно описывать ваши модели и делиться этой информацией с вашей командой. Здесь мы добавим базовую документацию в наш проект.

1. Обновите ваш файл models/schema.yml, чтобы включить в него некоторые описания, как показано ниже.

   models/schema.yml

   version: 2
   
   models:
     - name: customers
       description: Одна запись на каждого клиента
       columns:
         - name: customer_id
           description: Первичный ключ
           data_tests:
             - unique
             - not_null
         - name: first_order_date
           description: NULL, если клиент еще не сделал заказ.
   
     - name: stg_customers
       description: Эта модель очищает данные о клиентах
       columns:
         - name: customer_id
           description: Первичный ключ
           data_tests:
             - unique
             - not_null
   
     - name: stg_orders
       description: Эта модель очищает данные о заказах
       columns:
         - name: order_id
           description: Первичный ключ
           data_tests:
             - unique
             - not_null
         - name: status
           data_tests:
             - accepted_values:
                 arguments: # available in v1.10.5 and higher. Older versions can set the <argument_name> as the top-level property.
                   values: ['placed', 'shipped', 'completed', 'return_pending', 'returned']
         - name: customer_id
           data_tests:
             - not_null
             - relationships:
                 arguments:
                   to: ref('stg_customers')
                   field: customer_id

2. Запустите dbt docs generate, чтобы сгенерировать документацию для вашего проекта. dbt анализирует ваш проект и ваш склад данных, чтобы создать JSON файл с подробной документацией о вашем проекте.

3. Нажмите на значок книги в интерфейсе Develop, чтобы открыть документацию в новой вкладке.

Часто задаваемые вопросы

Как писать развернутые объяснения в описаниях?

Если вам нужно больше одного предложения, чтобы объяснить модель, вы можете:

1. Разделить ваше описание на несколько строк, используя >. Внутренние разрывы строк будут удалены, и можно использовать Markdown. Этот метод рекомендуется для простых, одноабзацных описаний:

  version: 2

  models:
  - name: customers
    description: >
      Lorem ipsum **dolor** sit amet, consectetur adipisicing elit, sed do eiusmod
      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
      quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
      consequat.

2. Разделить ваше описание на несколько строк, используя |. Внутренние разрывы строк сохраняются, и можно использовать Markdown. Этот метод рекомендуется для более сложных описаний:

  version: 2

  models:
  - name: customers
    description: |
      ### Lorem ipsum

      * dolor sit amet, consectetur adipisicing elit, sed do eiusmod
      * tempor incididunt ut labore et dolore magna aliqua.

3. Использовать блок docs, чтобы написать описание в отдельном Markdown файле.

Как получить доступ к документации в dbt Catalog?

Если вы используете dbt для развертывания вашего проекта и у вас есть тариф Starter, Enterprise или Enterprise+, вы можете использовать Catalog для просмотра ресурсов вашего проекта (таких как модели, тесты и метрики), а также их линейности данных, чтобы лучше понять его текущее состояние в продакшене.

Получить доступ к Catalog в dbt можно, нажав ссылку Explore в навигации. Вы можете предоставить доступ к документации вашего проекта до 5 пользователям с правами только для чтения.

Пользователи тарифного плана dbt Developer и dbt Core могут использовать dbt Docs, который генерирует базовую документацию, однако он не предоставляет такую же скорость работы, объем метаданных и уровень видимости, как Catalog.

Зафиксируйте изменения

Теперь, когда вы построили модель customers, нужно закоммитить внесённые в проект изменения, чтобы в репозитории оказался ваш актуальный код.

Если вы редактировали прямо в защищённой основной ветке:

1. Нажмите кнопку Commit and sync git. Это действие подготовит ваши изменения к коммиту.
2. Появится модальное окно Commit to a new branch.
3. В модальном окне задайте имя новой ветки add-customers-model. Эта ветка будет создана от вашей основной ветки вместе с новыми изменениями.
4. Добавьте сообщение коммита, например «Add customers model, tests, docs», и закоммитьте изменения.
5. Нажмите Merge this branch to main, чтобы добавить эти изменения в ветку main вашего репозитория.

Если вы создали новую ветку до редактирования:

1. Поскольку вы уже ответвились от защищённой основной ветки, слева перейдите в Version Control.
2. Нажмите Commit and sync, чтобы добавить сообщение.
3. Добавьте сообщение коммита, например «Add customers model, tests, docs».
4. Нажмите Merge this branch to main, чтобы добавить эти изменения в ветку main вашего репозитория.

Разверните dbt

Используйте Scheduler в dbt, чтобы уверенно разворачивать продакшен‑джобы и добавлять наблюдаемость в ваши процессы. В следующих шагах вы научитесь создавать deployment environment и запускать job.

Создайте окружение развертывания (deployment environment)

1. В главном меню перейдите в Orchestration > Environments.
2. Нажмите Create environment.
3. В поле Name введите имя окружения развертывания. Например, «Production».
4. В поле dbt Version выберите последнюю версию из выпадающего списка.
5. В разделе Deployment connection укажите имя датасета, который вы хотите использовать как target, например «Analytics». Это позволит dbt собирать объекты и работать с этим датасетом. В некоторых хранилищах данных целевой датасет может называться «schema».
6. Нажмите Save.

Создайте и запустите job

Jobs — это набор команд dbt, которые вы хотите запускать по расписанию. Например, dbt build.

По мере того как бизнес jaffle_shop получает больше клиентов, а эти клиенты создают больше заказов, в исходных данных будет появляться больше записей. Поскольку вы материализовали модель customers как таблицу, вам нужно периодически пересобирать её, чтобы данные оставались актуальными. Это обновление будет происходить при запуске job.

1. После создания окружения развертывания вы должны попасть на страницу нового окружения. Если нет — в главном меню выберите Orchestration, затем нажмите Jobs.
2. Нажмите Create job > Deploy job.
3. Укажите имя job (например, «Production run») и выберите окружение, которое вы только что создали.
4. Прокрутите вниз до раздела Execution settings.
5. В разделе Commands добавьте эту команду как часть job, если её нет:
   • dbt build
6. Выберите опцию Generate docs on run, чтобы автоматически генерировать обновлённую документацию проекта при каждом запуске job.
7. Для этого упражнения не задавайте расписание запуска проекта — хотя проекты в вашей организации должны выполняться регулярно, нет необходимости запускать этот примерный проект по расписанию. Планирование job иногда называют развёртыванием проекта.
8. Нажмите Save, затем Run now, чтобы запустить job.
9. Откройте запуск и следите за прогрессом в Run summary.
10. Когда запуск завершится, нажмите View Documentation, чтобы посмотреть документацию проекта.

Поздравляем 🎉! Вы только что развернули свой первый dbt‑проект!

FAQs

Что произойдет, если один из моих запусков завершится неудачей?

Если вы используете dbt, мы рекомендуем настроить уведомления по электронной почте и в Slack (Account Settings > Notifications) для всех неудачных запусков. Затем отлаживайте эти запуски так же, как вы отлаживаете любые запуски в среде разработки.

Нашли ошибку?

Создать GitHub Issue