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

Redshift

dbt Cloud

Quickstart

Beginner

Menu

Введение

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

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

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

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

• У вас есть аккаунт dbt Cloud.
• У вас есть аккаунт AWS с правами на выполнение шаблона CloudFormation для создания соответствующих ролей и кластера Redshift.

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

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

Создание кластера Redshift

1. Войдите в свой аккаунт AWS как корневой пользователь или пользователь IAM в зависимости от вашего уровня доступа.
2. Используйте шаблон CloudFormation для быстрого создания кластера Redshift. Шаблон CloudFormation — это файл конфигурации, который автоматически создает необходимые ресурсы в AWS. Запустите стек CloudFormation и вы можете обратиться к JSON файлу create-dbtworkshop-infr для получения более подробной информации о шаблоне.

подсказка

Чтобы избежать проблем с подключением к dbt Cloud, убедитесь, что вы разрешили входящий трафик на порт 5439 с IP-адресов dbt Cloud в настройках групп безопасности Redshift и списках контроля доступа к сети (NACLs).

3. Нажимайте Next на каждой странице, пока не дойдете до флажка Select acknowledgement. Выберите I acknowledge that AWS CloudFormation might create IAM resources with custom names и нажмите Create Stack. Вы должны попасть на страницу стека со статусом CREATE_IN_PROGRESS.

   Cloud Formation в процессе

4. Когда статус стека изменится на CREATE_COMPLETE, нажмите вкладку Outputs вверху, чтобы просмотреть информацию, которую вы будете использовать в остальной части этого руководства. Сохраните эти учетные данные, оставив эту вкладку открытой.

5. Введите Redshift в строке поиска вверху и нажмите Amazon Redshift.

   Нажмите на Redshift

6. Убедитесь, что ваш новый кластер Redshift указан в Cluster overview. Выберите ваш новый кластер. Имя кластера должно начинаться с dbtredshiftcluster-. Затем нажмите Query Data. Вы можете выбрать классический редактор запросов или v2. Для целей этого руководства мы будем использовать версию v2.

Доступный кластер Redshift

7. Возможно, вам будет предложено настроить аккаунт. Для этой песочницы мы рекомендуем выбрать "Configure account".

8. Выберите ваш кластер из списка. В всплывающем окне Connect to заполните учетные данные из вывода стека:

   • Authentication — Используйте по умолчанию, что является Database user name and password (ПРИМЕЧАНИЕ: аутентификация IAM не поддерживается в dbt Cloud).
   • Database — dbtworkshop
   • User name — dbtadmin
   • Password — Используйте автоматически сгенерированный RSadminpassword из вывода стека и сохраните его для дальнейшего использования.

Редактор запросов Redshift v2

Подключение к кластеру Redshift

9. Нажмите Create connection.

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

Теперь мы загрузим наши примерные данные в S3 bucket, который создал наш шаблон CloudFormation. S3 buckets — это простой и недорогой способ хранения данных вне Redshift.

1. Данные, используемые в этом курсе, хранятся в виде CSV в публичном S3 bucket. Вы можете использовать следующие URL для загрузки этих файлов. Скачайте их на свой компьютер для использования в следующих шагах.

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

2. Теперь мы будем использовать S3 bucket, который вы создали с помощью CloudFormation, и загрузим файлы. Перейдите в строку поиска вверху, введите S3 и нажмите на S3. В bucket уже будут примерные данные, вы можете их игнорировать или использовать для других исследований моделирования. Bucket будет иметь префикс dbt-data-lake.

Перейти в S3

3. Нажмите на name of the bucket S3 bucket. Если у вас несколько S3 bucket, это будет bucket, который был указан под "Workshopbucket" на странице Outputs.

Перейти в ваш S3 Bucket

4. Нажмите Upload. Перетащите три файла в интерфейс и нажмите кнопку Upload.

Загрузите ваши CSV

5. Запомните имя S3 bucket для дальнейшего использования. Оно должно выглядеть так: s3://dbt-data-lake-xxxx. Вам понадобится это для следующего раздела.

6. Теперь вернемся к редактору запросов Redshift. Найдите Redshift в строке поиска, выберите ваш кластер и выберите Query data.

7. В вашем редакторе запросов выполните следующий запрос, чтобы создать схемы, в которые мы будем помещать ваши необработанные данные. Вы можете выделить оператор и затем нажать Run, чтобы выполнить их по отдельности. Если вы используете классический редактор запросов, возможно, вам придется вводить их по отдельности в интерфейс. Вы должны увидеть эти схемы, перечисленные под dbtworkshop.

   create schema if not exists jaffle_shop;
   create schema if not exists stripe;

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

   create table jaffle_shop.customers(
       id integer,
       first_name varchar(50),
       last_name varchar(50)
   );
   
   create table jaffle_shop.orders(
       id integer,
       user_id integer,
       order_date date,
       status varchar(50)
   );
   
   create table stripe.payment(
       id integer,
       orderid integer,
       paymentmethod varchar(50),
       status varchar(50),
       amount integer,
       created date
   );

9. Теперь нам нужно скопировать данные из S3. Это позволяет вам выполнять запросы в этом руководстве для демонстрационных целей; это не пример того, как вы бы делали это для реального проекта. Убедитесь, что вы обновили местоположение S3, роль iam и регион. Вы можете найти S3 и роль iam в ваших выводах из стека CloudFormation. Найдите стек, введя CloudFormation в строке поиска, затем нажмите Stacks в плитке CloudFormation.

   copy jaffle_shop.customers( id, first_name, last_name)
   from 's3://dbt-data-lake-xxxx/jaffle_shop_customers.csv'
   iam_role 'arn:aws:iam::XXXXXXXXXX:role/RoleName'
   region 'us-east-1'
   delimiter ','
   ignoreheader 1
   acceptinvchars;
      
   copy jaffle_shop.orders(id, user_id, order_date, status)
   from 's3://dbt-data-lake-xxxx/jaffle_shop_orders.csv'
   iam_role 'arn:aws:iam::XXXXXXXXXX:role/RoleName'
   region 'us-east-1'
   delimiter ','
   ignoreheader 1
   acceptinvchars;
   
   copy stripe.payment(id, orderid, paymentmethod, status, amount, created)
   from 's3://dbt-data-lake-xxxx/stripe_payments.csv'
   iam_role 'arn:aws:iam::XXXXXXXXXX:role/RoleName'
   region 'us-east-1'
   delimiter ','
   ignoreheader 1
   Acceptinvchars;

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

   select * from jaffle_shop.customers;
   select * from jaffle_shop.orders;
   select * from stripe.payment;

Подключение dbt Cloud к Redshift

1. Создайте новый проект в dbt Cloud. Перейдите в Account settings (нажав на имя вашего аккаунта в левом боковом меню) и нажмите + New Project.

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

3. Для хранилища данных нажмите Redshift, затем Next, чтобы настроить ваше подключение.

4. Введите настройки Redshift. Обратитесь к вашим учетным данным, которые вы сохранили из шаблона CloudFormation.

   • Hostname — Ваш полный хостнейм.
   • Port — 5439
   • Database — dbtworkshop.
   dbt Cloud - Настройки кластера Redshift
   подсказка

   Чтобы избежать проблем с подключением к dbt Cloud, убедитесь, что вы разрешили входящий трафик на порт 5439 с IP-адресов dbt Cloud в настройках групп безопасности Redshift и списках контроля доступа к сети (NACLs).

5. Установите ваши учетные данные для разработки. Эти учетные данные будут использоваться dbt Cloud для подключения к Redshift. Эти учетные данные (как указано в вашем выводе CloudFormation) будут:

   • Username — dbtadmin
   • Password — Это автоматически сгенерированный пароль, который вы использовали ранее в руководстве
   • Schema — dbt Cloud автоматически генерирует имя схемы для вас. По соглашению, это dbt_<первая буква имени><фамилия>. Это схема, подключенная непосредственно к вашей среде разработки, и это место, где ваши модели будут строиться при запуске dbt в облачной IDE.
   dbt Cloud - Учетные данные для разработки Redshift

6. Нажмите Test Connection. Это проверяет, что dbt Cloud может получить доступ к вашему кластеру Redshift.

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

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

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

Чтобы подключиться к репозиторию, вы можете либо настроить размещаемый в dbt Cloud управляемый репозиторий, либо напрямую подключиться к поддерживаемому git-провайдеру. Управляемые репозитории — отличный способ попробовать dbt без необходимости создавать новый репозиторий. В долгосрочной перспективе лучше подключиться к поддерживаемому git-провайдеру, чтобы использовать такие функции, как автоматизация и непрерывная интеграция.

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

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

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

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

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

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

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

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

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

Назовите новую ветку 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 Cloud:
  • В выводе выполнения нажмите на имя модели, а затем выберите "Details"
• dbt Core:
  • Директория target/compiled/ для скомпилированных select выражений
  • Директория target/run/ для скомпилированных create выражений
  • Файл logs/dbt.log для подробного логирования.

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

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

• Если вы разрабатываете в dbt Cloud, эти параметры устанавливаются для каждого пользователя при первом использовании среды разработки.
• Если вы разрабатываете с 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=0.15.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 так, чтобы все в нем материализовалось как представление. Обновите блок конфигурации models следующим образом:

     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), а затем измените модели на таблицы, когда это потребуется по причинам производительности (например, когда последующие запросы замедлились).

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

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

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

• теги для поддержки легкой категоризации и выбора графа
• пользовательские схемы для разделения ваших моделей по нескольким схемам
• алиасы, если имя вашего / должно отличаться от имени файла
• Фрагменты 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, могут остаться лишние объекты, что может запутать других пользователей.

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

Когда вы удаляете модели из вашего 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 проекты.

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

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

Чтобы добавить тесты в ваш проект:

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

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

   models/schema.yml

   version: 2
   
   models:
     - name: customers
       columns:
         - name: customer_id
           tests:
             - unique
             - not_null
   
     - name: stg_customers
       columns:
         - name: customer_id
           tests:
             - unique
             - not_null
   
     - name: stg_orders
       columns:
         - name: order_id
           tests:
             - unique
             - not_null
         - name: status
           tests:
             - accepted_values:
                 values: ['placed', 'shipped', 'completed', 'return_pending', 'returned']
         - name: customer_id
           tests:
             - not_null
             - relationships:
                 to: ref('stg_customers')
                 field: customer_id
   

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

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

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

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

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

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

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

Некоторые дополнительные пользовательские тесты схемы были опубликованы с открытым исходным кодом в пакете dbt-utils, ознакомьтесь с документацией по пакетам, чтобы узнать, как сделать эти тесты доступными в вашем проекте.

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

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

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

dbt test --select customers

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

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

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

• dbt Cloud:

  • В выводе теста нажмите на неудачный тест, а затем выберите "Details"

• dbt Core:

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

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

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

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

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

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

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

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

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

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

Какие тесты следует добавить в мой проект?

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

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

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

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

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

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

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

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

   models/schema.yml

   version: 2
   
   models:
     - name: customers
       description: Одна запись на каждого клиента
       columns:
         - name: customer_id
           description: Первичный ключ
           tests:
             - unique
             - not_null
         - name: first_order_date
           description: NULL, если клиент еще не сделал заказ.
   
     - name: stg_customers
       description: Эта модель очищает данные о клиентах
       columns:
         - name: customer_id
           description: Первичный ключ
           tests:
             - unique
             - not_null
   
     - name: stg_orders
       description: Эта модель очищает данные о заказах
       columns:
         - name: order_id
           description: Первичный ключ
           tests:
             - unique
             - not_null
         - name: status
           tests:
             - accepted_values:
                 values: ['placed', 'shipped', 'completed', 'return_pending', 'returned']
         - name: customer_id
           tests:
             - not_null
             - relationships:
                 to: ref('stg_customers')
                 field: customer_id

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

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 Explorer?

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

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

Пользователи плана разработчика dbt Cloud и dbt Core могут использовать dbt Docs, который генерирует базовую документацию, но не предлагает такую же скорость, метаданные или видимость, как dbt Explorer.

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

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

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

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, чтобы добавить эти изменения в основную ветку вашего репозитория.

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

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

Разверните dbt

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

Создайте среду развертывания

1. В верхнем левом углу выберите Deploy, затем нажмите Environments.
2. Нажмите Create Environment.
3. В поле Name напишите название вашей среды развертывания. Например, "Production."
4. В поле dbt Version выберите последнюю версию из выпадающего списка.
5. В разделе Deployment connection введите название набора данных, который вы хотите использовать в качестве целевого, например, "Analytics". Это позволит dbt строить и работать с этим набором данных. Для некоторых хранилищ данных целевой набор данных может называться "схемой".
6. Нажмите Save.

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

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

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

1. После создания вашей среды развертывания вы должны быть перенаправлены на страницу новой среды. Если нет, выберите Deploy в верхнем левом углу, затем нажмите Jobs.
2. Нажмите Create one и укажите имя, например, "Production run", и свяжите с только что созданной средой.
3. Прокрутите вниз до раздела Execution Settings.
4. В разделе Commands добавьте эту команду как часть вашего задания, если вы ее не видите:
   • dbt build
5. Выберите флажок Generate docs on run, чтобы автоматически генерировать обновленную документацию проекта каждый раз, когда выполняется ваше задание.
6. Для этого упражнения не устанавливайте расписание для выполнения вашего проекта — хотя проект вашей организации должен выполняться регулярно, нет необходимости запускать этот пример проекта по расписанию. Планирование задания иногда называют развертыванием проекта.
7. Выберите Save, затем нажмите Run now, чтобы запустить ваше задание.
8. Нажмите на выполнение и наблюдайте за его прогрессом в разделе "Run history."
9. После завершения выполнения нажмите View Documentation, чтобы увидеть документацию вашего проекта.

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

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

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

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