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

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

dbt platform

Quickstart

Beginner

Menu

Введение

В этом руководстве по быстрому старту вы узнаете, как использовать dbt вместе с Starburst Galaxy. Руководство покажет вам, как:

• Загрузить данные в бакет Amazon S3. В этом руководстве AWS используется в качестве облачного провайдера исключительно в демонстрационных целях. Starburst Galaxy также поддерживает другие источники данных, такие как Google Cloud, Microsoft Azure и другие.
• Подключить Starburst Galaxy к бакету Amazon S3.
• Создавать таблицы с помощью Starburst Galaxy.
• Подключить dbt к Starburst Galaxy.
• Взять пример запроса и превратить его в модель в вашем dbt‑проекте. Модель в dbt — это оператор select.
• Добавить тесты к моделям.
• Документировать модели.
• Запланировать выполнение задания.
• Подключаться к нескольким источникам данных в дополнение к вашему бакету S3.

Видео для вас

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

Также вы можете посмотреть видео на YouTube Build Better Data Pipelines with dbt and Starburst, подготовленное компанией Starburst Data, Inc.

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

• У вас есть multi-tenant‑развертывание в dbt. Подробнее см. Tenancy.
• У вас есть учетная запись Starburst Galaxy. Если нет, вы можете начать с бесплатного пробного периода. Дополнительные сведения по первоначальной настройке см. в руководстве по началу работы в документации Starburst Galaxy.
• У вас есть учетная запись AWS с правами на загрузку данных в бакет S3.
• Для аутентификации Amazon S3 вам потребуется либо AWS access key и AWS secret key с доступом к бакету, либо кросс‑аккаунтная IAM‑роль с доступом к бакету. Подробнее см. документацию Starburst Galaxy:
  • Инструкции по AWS access key и secret key
  • Cross account IAM role

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

• Курсы dbt Learn
• CI‑задание dbt
• Уведомления о заданиях
• Свежесть источников
• Обзор SQL для Starburst Galaxy

Загрузка данных в бакет Amazon S3

Используя Starburst Galaxy, вы можете создавать таблицы и трансформировать их с помощью dbt. Начните с загрузки данных Jaffle Shop (предоставлены dbt Labs) в ваш бакет Amazon S3. Jaffle Shop — это вымышленное кафе, продающее еду и напитки в нескольких городах США.

1. Скачайте следующие CSV‑файлы на локальный компьютер:

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

2. Загрузите эти файлы в S3. Подробности см. в разделе Upload objects документации Amazon S3.

   При загрузке файлов необходимо создать следующую структуру папок и поместить соответствующий файл в каждую папку:

   <bucket/blob>
       dbt-quickstart (folder)
           jaffle-shop-customers (folder)
               jaffle_shop_customers.csv (file)
           jaffle-shop-orders (folder)
               jaffle_shop_orders.csv (file)
           stripe-payments (folder)
               stripe-payments.csv (file)

Подключение Starburst Galaxy к бакету Amazon S3

Если ваш экземпляр Starburst Galaxy еще не подключен к бакету S3, вам нужно создать кластер, настроить каталог, позволяющий Starburst Galaxy подключаться к S3, добавить каталог в кластер и настроить права доступа.

Помимо Amazon S3, Starburst Galaxy поддерживает множество других источников данных. Подробнее см. в разделе Catalogs overview документации Starburst Galaxy.

1. Создайте кластер. Нажмите Clusters на левой боковой панели интерфейса Starburst Galaxy, затем нажмите Create cluster в основной части страницы.

2. В модальном окне Create a new cluster укажите только следующие параметры (остальные можно оставить по умолчанию):

   • Cluster name — введите имя кластера.
   • Cloud provider region — выберите регион AWS.

   Нажмите Create cluster.

3. Создайте каталог. Нажмите Catalogs на левой боковой панели, затем Create catalog.

4. На странице Create a data source выберите плитку Amazon S3.

5. В разделе Name and description страницы Amazon S3 заполните поля.

6. В разделе Authentication to S3 выберите механизм аутентификации AWS (S3), который вы используете.

7. В разделе Metastore configuration задайте следующие параметры:

   • Default S3 bucket name — имя бакета S3, к которому вы хотите получить доступ.
   • Default directory name — имя папки в бакете S3, где находятся данные Jaffle Shop (та же папка, что и в разделе Load data to an Amazon S3 bucket).
   • Allow creating external tables — включите.
   • Allow writing to external tables — включите.

   Страница Amazon S3 должна выглядеть примерно так же, за исключением раздела Authentication to S3, который зависит от вашей конфигурации:

   Настройки подключения Amazon S3 в Starburst Galaxy

8. Нажмите Test connection, чтобы проверить доступ Starburst Galaxy к вашему бакету S3.

9. Если тест прошел успешно, нажмите Connect catalog.

   Успешная проверка подключения

10. На странице Set permissions нажмите Skip — при необходимости вы сможете добавить права позже.

11. На странице Add to cluster выберите кластер из выпадающего списка и нажмите Add to cluster.

12. Добавьте привилегию location для вашего бакета S3 к роли в Starburst Galaxy. В левой боковой панели нажмите Access control > Roles and privileges, затем в таблице Roles выберите роль accountadmin.

    Если вы используете существующий кластер и не имеете доступа к роли accountadmin, выберите роль, к которой у вас есть доступ.

    Подробнее о контроле доступа см. в разделе Access control документации Starburst Galaxy.

13. На странице Roles откройте вкладку Privileges и нажмите Add privilege.

14. На странице Add privilege задайте:

    • What would you like to modify privileges for? — выберите Location.
    • Enter a storage location provide — укажите путь к вашему бакету S3 и папке с данными Jaffle Shop. Обязательно добавьте /* в конце.
    • Create SQL — включите.

    Нажмите Add privileges.

    Добавление привилегии для роли accountadmin

Создание таблиц в Starburst Galaxy

Чтобы выполнять запросы к данным Jaffle Shop через Starburst Galaxy, необходимо создать таблицы на основе данных, которые вы загрузили в бакет S3. Это можно сделать (как и выполнить любой SQL‑запрос) из редактора запросов.

1. В левой боковой панели нажмите Query > Query editor.

2. Настройте редактор запросов для работы с вашим бакетом S3. В правом верхнем углу выберите кластер в первом сером поле и каталог — во втором:

   Выбор кластера и каталога в редакторе запросов

3. Скопируйте и вставьте следующие запросы в редактор и выполните каждый по отдельности (Run).

   Замените YOUR_S3_BUCKET_NAME на имя вашего бакета S3. Эти запросы создают схему jaffle_shop и таблицы jaffle_shop_customers, jaffle_shop_orders и stripe_payments:

   CREATE SCHEMA jaffle_shop WITH (location='s3://YOUR_S3_BUCKET_NAME/dbt-quickstart/');
   
   CREATE TABLE jaffle_shop.jaffle_shop_customers (
       id VARCHAR,
       first_name VARCHAR,
       last_name VARCHAR
   )
   
   WITH (
       external_location = 's3://YOUR_S3_BUCKET_NAME/dbt-quickstart/jaffle-shop-customers/',
       format = 'csv',
       type = 'hive',
       skip_header_line_count=1
   
   );
   
   CREATE TABLE jaffle_shop.jaffle_shop_orders (
   
       id VARCHAR,
       user_id VARCHAR,
       order_date VARCHAR,
       status VARCHAR
   
   )
   
   WITH (
       external_location = 's3://YOUR_S3_BUCKET_NAME/dbt-quickstart/jaffle-shop-orders/',
       format = 'csv',
       type = 'hive',
       skip_header_line_count=1
   );
   
   CREATE TABLE jaffle_shop.stripe_payments (
   
       id VARCHAR,
       order_id VARCHAR,
       paymentmethod VARCHAR,
       status VARCHAR,
       amount VARCHAR,
       created VARCHAR
   )
   
   WITH (
   
       external_location = 's3://YOUR_S3_BUCKET_NAME/dbt-quickstart/stripe-payments/',
       format = 'csv',
       type = 'hive',
       skip_header_line_count=1
   
   );

4. После выполнения запросов в левой боковой панели редактора вы увидите следующую иерархию:

   Иерархия данных в редакторе запросов

5. Проверьте, что таблицы были успешно созданы, выполнив запросы:

   select * from jaffle_shop.jaffle_shop_customers;
   select * from jaffle_shop.jaffle_shop_orders;
   select * from jaffle_shop.stripe_payments;

Подключение dbt к Starburst Galaxy

1. Убедитесь, что вы вошли в Starburst Galaxy.

2. Если вы еще этого не сделали, установите роль учетной записи accountadmin. Нажмите на адрес электронной почты в правом верхнем углу, выберите Switch role и укажите accountadmin.

   Если эта роль недоступна, выберите роль, которую вы использовали при добавлении привилегии location в разделе Connect Starburst Galaxy to the Amazon S3 bucket.

3. В левой боковой панели нажмите Clusters.

4. Найдите ваш кластер в таблице View clusters и нажмите Connection info. В выпадающем списке Select client выберите dbt. Оставьте модальное окно Connection information открытым — эти данные понадобятся в dbt.

5. В другой вкладке браузера войдите в dbt.

6. Создайте новый проект в dbt. Нажмите на имя учетной записи в левом меню, выберите Account settings и нажмите + New Project.

7. Введите имя проекта и нажмите Continue.

8. Выберите Starburst в качестве подключения и нажмите Next.

9. Укажите Settings:

   • Host — значение Host из окна Connection information в Starburst Galaxy.
   • Port — 443 (значение по умолчанию).

10. Укажите Development Credentials:

    • User — значение User из окна Connection information. Обязательно используйте всю строку целиком, включая роль учетной записи после /.
    • Password — пароль для входа в Starburst Galaxy.
    • Database — каталог Starburst, в который будут сохраняться данные. Для справки: в dbt и Starburst Galaxy термины database и catalog используются как синонимы.
    • Остальные параметры оставьте без изменений.

11. Нажмите Test Connection, чтобы проверить доступ dbt к кластеру Starburst Galaxy.

12. Если тест успешен, нажмите Next. Если нет — проверьте настройки и учетные данные.

Настройка репозитория, управляемого 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. Первый запуск может занять несколько минут.
2. Над деревом файлов слева нажмите Initialize dbt project.
3. Сделайте первый коммит: нажмите Commit and sync, используйте сообщение initial commit и нажмите Commit.
4. Теперь вы можете выполнять запросы и запускать dbt run. Попробуйте:
   • Нажмите + Create new file, добавьте запрос и сохраните файл:

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

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

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

• Создать новую ветку (рекомендуется).
• Редактировать в защищенной основной ветке.

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

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

with customers as (

    select
        id as customer_id,
        first_name,
        last_name

    from dbt_quickstart.jaffle_shop.jaffle_shop_customers
),

orders as (

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

    from dbt_quickstart.jaffle_shop.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 on customers.customer_id = customer_orders.customer_id
)
select * from final

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

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

FAQs

Как посмотреть 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. Создайте файл models/stg_customers.sql с SQL из CTE customers.

2. Создайте файл models/stg_orders.sql с SQL из CTE orders.

   models/stg_customers.sql

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

   select
       id as order_id,
       user_id as customer_id,
       order_date,
       status
   
   from dbt_quickstart.jaffle_shop.jaffle_shop_orders

3. Отредактируйте 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 on customers.customer_id = customer_orders.customer_id
   
   )
   
   select * from final
   

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

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

FAQs

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

Чтобы запустить одну модель, используйте флаг --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) для всех неудачных запусков. Затем отлаживайте эти запуски так же, как вы отлаживаете любые запуски в среде разработки.

Подключение к нескольким источникам данных

Этот быстрый старт посвящен использованию dbt для запуска моделей поверх data lake (S3) с помощью Starburst Galaxy в качестве движка запросов. В реальных сценариях данные обычно распределены по нескольким источникам и хранятся в разных форматах. С помощью Starburst Galaxy, Starburst Enterprise и Trino вы можете запускать модели над любыми данными, независимо от места их хранения.

Если вы хотите попробовать это, обратитесь к документации Starburst Galaxy, добавьте дополнительные источники данных и загрузите данные Jaffle Shop в выбранный источник. Затем расширьте свои модели, чтобы они обращались как к новому источнику данных, так и к источнику, созданному в рамках этого быстрого старта.

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

Создать GitHub Issue