Быстрый старт для dbt и Azure Synapse Analytics
Введение
В этом кратком руководстве вы узнаете, как использовать dbt с Azure Synapse Analytics. В нём показано, как:
- Загрузить демонстрационные данные Jaffle Shop (предоставленные dbt Labs) в ваше хранилище Azure Synapse Analytics.
- Подключить dbt к Azure Synapse Analytics.
- Преобразовать пример запроса в модель в вашем проекте dbt. Модель в dbt — это SQL-запрос SELECT.
- Добавить тесты для ваших моделей.
- Добавить документацию к вашим моделям.
- Настроить запуск задания по расписанию.
Предварительные требования
- У вас есть аккаунт dbt Cloud.
- У вас есть аккаунт Azure Synapse Analytics. Для бесплатной пробной версии обратитесь к Synapse Analytics в документации Microsoft.
- Как администратор Microsoft, вы включили аутентификацию с использованием служебного принципала. Вы должны добавить служебный принципал в рабочее пространство Synapse с правами Участника (рекомендуется) или Администратора. Для получения подробной информации обратитесь к Создание служебного принципала с использованием портала Azure в документации Microsoft. dbt Cloud нужны эти учетные данные для подключения к Azure Synapse Analytics.
Предварительные требования
- У вас есть учетная запись dbt.
- У вас есть учетная запись Azure Synapse Analytics. Чтобы воспользоваться бесплатной пробной версией, обратитесь к разделу Synapse Analytics в документации Microsoft.
- Вы, как администратор Microsoft, включили аутентификацию с помощью субъекта-службы (service principal). Необходимо добавить субъект-службу в рабочую область Synapse с набором разрешений Member (рекомендуется) или Admin. Подробные сведения см. в разделе Создание субъекта-службы с помощью портала Azure в документации Microsoft. Эти учетные данные необходимы dbt для подключения к Azure Synapse Analytics.
Загрузка данных в Azure Synapse Analytics
-
Войдите в свой аккаунт Azure portal.
-
На главной странице выберите плитку SQL databases.
-
На странице SQL databases перейдите в рабочее пространство вашей организации или создайте новое; для получения более подробной информации обратитесь к Создание рабочего пространства Synapse в документации Microsoft.
-
В боковой панели рабочего пространства выберите Data. Нажмите на меню с тремя точками на вашей базе данных и выберите New SQL script, чтобы открыть редактор SQL.
-
Скопируйте эти операторы в редактор SQL, чтобы загрузить пример данных Jaffle Shop:
CREATE TABLE dbo.customers
(
[ID] [bigint],
[FIRST_NAME] [varchar](8000),
[LAST_NAME] [varchar](8000)
);
COPY INTO [dbo].[customers]
FROM 'https://dbtlabsynapsedatalake.blob.core.windows.net/dbt-quickstart-public/jaffle_shop_customers.parquet'
WITH (
FILE_TYPE = 'PARQUET'
);
CREATE TABLE dbo.orders
(
[ID] [bigint],
[USER_ID] [bigint],
[ORDER_DATE] [date],
[STATUS] [varchar](8000)
);
COPY INTO [dbo].[orders]
FROM 'https://dbtlabsynapsedatalake.blob.core.windows.net/dbt-quickstart-public/jaffle_shop_orders.parquet'
WITH (
FILE_TYPE = 'PARQUET'
);
CREATE TABLE dbo.payments
(
[ID] [bigint],
[ORDERID] [bigint],
[PAYMENTMETHOD] [varchar](8000),
[STATUS] [varchar](8000),
[AMOUNT] [bigint],
[CREATED] [date]
);
COPY INTO [dbo].[payments]
FROM 'https://dbtlabsynapsedatalake.blob.core.windows.net/dbt-quickstart-public/stripe_payments.parquet'
WITH (
FILE_TYPE = 'PARQUET'
);
Подключение dbt к Azure Synapse Analytics
- Создайте новый проект в dbt. Нажмите на имя своей учетной записи в меню слева, выберите Account settings и нажмите + New Project.
- Введите имя проекта и нажмите Continue.
- Выберите Synapse в качестве подключения и нажмите Next.
- В разделе Configure your environment укажите настройки (Settings) нового проекта:
- Server — Используйте значение Synapse host name субъекта-службы (без строки
, 1433в конце) для тестовой конечной точки Synapse. - Port — 1433 (значение по умолчанию).
- Database — Используйте значение database субъекта-службы для тестовой конечной точки Synapse.
- Server — Используйте значение Synapse host name субъекта-службы (без строки
- Укажите учетные данные пользователя (User credentials) для нового проекта:
- Authentication — Выберите Service Principal в раскрывающемся списке.
- Tenant ID — Используйте значение Directory (tenant) id субъекта-службы.
- Client ID — Используйте значение application (client) ID субъекта-службы.
- Client secret — Используйте значение client secret субъекта-службы (не client secret id).
- Нажмите Test connection. Эта проверка позволяет убедиться, что dbt может получить доступ к вашей учетной записи Azure Synapse Analytics.
- После успешной проверки нажмите Next. Если проверка завершилась неудачно, возможно, потребуется проверить настройки субъекта-службы Microsoft.
Настройка управляемого репозитория dbt
При разработке в dbt вы можете использовать Git для управления версиями кода.
Чтобы подключиться к репозиторию, вы можете настроить управляемый репозиторий, размещённый на стороне dbt, или напрямую подключиться к поддерживаемому Git-провайдеру. Управляемые репозитории — отличный способ попробовать dbt без необходимости создавать новый репозиторий. В долгосрочной перспективе лучше подключиться к поддерживаемому Git-провайдеру, чтобы использовать такие возможности, как автоматизация и непрерывная интеграция.
Чтобы настроить управляемый репозиторий:
- В разделе "Настроить репозиторий" выберите Управляемый.
- Введите имя для вашего репозитория, например,
bbaggins-dbt-quickstart. - Нажмите Создать. Создание и импорт вашего репозитория займет несколько секунд.
- Как только вы увидите сообщение "Репозиторий успешно импортирован", нажмите Продолжить.
Инициализируйте проект dbt и начните разработку
Теперь, когда репозиторий настроен, вы можете инициализировать проект и начать разработку в dbt:
- Нажмите Start developing in the Studio IDE. Первый запуск проекта может занять несколько минут: за это время устанавливается подключение к git, клонируется репозиторий и проверяется подключение к хранилищу данных.
- Над деревом файлов слева нажмите Initialize dbt project. Это создаст структуру папок с примерами моделей.
- Создайте первый коммит, нажав Commit and sync. Укажите сообщение коммита
initial commitи нажмите Commit Changes. Это создаст первый коммит в вашем управляемом репозитории и позволит создать ветку, в которую можно добавлять новый код dbt. - Теперь вы можете напрямую запрашивать данные из хранилища и выполнять
dbt run. Попробуйте сделать это прямо сейчас:- В строке команд внизу введите
dbt runи нажмите Enter. Вы должны увидеть сообщениеdbt run succeeded.
- В строке команд внизу введите
Создайте свою первую модель
Если вы хотите использовать ИИ для создания первой модели, ознакомьтесь с разделом «Создайте модель с помощью dbt Wizard» ниже.
-
В разделе Version Control слева нажмите Create branch. Ветку можно назвать
add-customers-model. Необходимо создать новую ветку, поскольку основная ветка доступна только для чтения. -
Нажмите меню с тремя точками (...) рядом с каталогом
models, затем выберите Create file. -
Назовите файл
customers.sql, затем нажмите Create. -
Скопируйте следующий запрос в файл и нажмите Save.
customers.sqlwith customers as (
select
ID as customer_id,
FIRST_NAME as first_name,
LAST_NAME as last_name
from dbo.customers
),
orders as (
select
ID as order_id,
USER_ID as customer_id,
ORDER_DATE as order_date,
STATUS as status
from dbo.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 customer_id
),
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 -
Введите
dbt runв командной строке внизу экрана. Вы должны получить успешное выполнение и увидеть три модели.
Позже вы сможете подключить свои инструменты бизнес-аналитики (BI), например dbt Charts, к этим представлениям и таблицам, чтобы они считывали только очищенные данные, а не необработанные.
Часто задаваемые вопросы
Создайте модель с помощью ИИ в dbt Wizard
Не хотите писать SQL вручную? dbt Wizard может создать для вас ту же модель прямо в Studio IDE или на главной вкладке, опираясь на фактическую схему и граф зависимостей вашего проекта. Но будьте осторожны: говорят, волшебник умеет .
- Откройте dbt Wizard в Studio IDE.
- Введите запрос: «Создай модель customers, которая объединяет orders и customers и включает дату последнего заказа и общее количество заказов для каждого клиента».
- Проверьте SQL, сгенерированный dbt Wizard, затем примите его, чтобы сохранить модель.
- Введите
dbt run, чтобы построить модель.
В любом случае вы получите одну и ту же работающую модель. Узнайте больше о dbt Wizard на платформе dbt.
Измените способ материализации вашей модели
Одной из самых мощных функций dbt является возможность изменять способ материализации модели в вашем хранилище данных, просто изменяя значение конфигурации. Вы можете переключаться между таблицами и представлениями, изменяя ключевое слово, вместо того чтобы писать язык определения данных (DDL) для выполнения этого за кулисами.
По умолчанию все создается как представление. Вы можете переопределить это на уровне директории, чтобы все в этой директории материализовалось по-другому.
-
Отредактируйте ваш файл
dbt_project.yml.-
Обновите имя вашего проекта на:
dbt_project.ymlname: 'jaffle_shop' -
Настройте
jaffle_shopтак, чтобы всё внутри него материализовалось как таблица; и настройтеexampleтак, чтобы всё внутри него материализовалось как представление (view). Обновите конфигурациюmodelsв YAML-файле проекта следующим образом:dbt_project.ymlmodels:
jaffle_shop:
+materialized: table
example:
+materialized: view -
Нажмите Сохранить.
-
-
Введите команду
dbt run. Ваша модельcustomersтеперь должна быть построена как таблица!к сведениюДля этого dbt сначала должен был выполнить оператор
drop view(или API вызов на BigQuery), затем операторcreate table as. -
Отредактируйте
models/customers.sql, чтобы переопределитьdbt_project.ymlтолько для моделиcustomers, добавив следующий фрагмент в начало, и нажмите Сохранить:models/customers.sql{{
config(
materialized='view'
)
}}
with customers as (
select
id as customer_id
...
) -
Введите команду
dbt run. Ваша модельcustomersтеперь должна быть построена как представление.- Пользователям BigQuery необходимо выполнить
dbt run --full-refreshвместоdbt run, чтобы полностью применить изменения материализации.
- Пользователям BigQuery необходимо выполнить
-
Введите команду
dbt run --full-refresh, чтобы изменения вступили в силу в вашем хранилище данных.
Часто задаваемые вопросы
Удаление примерных моделей
Теперь вы можете удалить файлы, которые dbt создал при инициализации проекта:
-
Удалите директорию
models/example/. -
Удалите ключ
example:из вашего файлаdbt_project.yml, а также любые конфигурации, которые перечислены под ним.dbt_project.yml# до
models:
jaffle_shop:
+materialized: table
example:
+materialized: viewdbt_project.yml# после
models:
jaffle_shop:
+materialized: table -
Сохраните изменения.
Часто задаваемые вопросы
Создание моделей на основе других моделей
Как лучшая практика в SQL, следует разделять логику, которая очищает ваши данные, от логики, которая трансформирует ваши данные. Вы уже начали делать это в существующем запросе, используя общие табличные выражения (CTE).
Теперь вы можете поэкспериментировать, разделив логику на отдельные модели и используя функцию ref для построения моделей на основе других моделей:
-
Создайте новый SQL файл,
models/stg_customers.sql, с SQL из CTEcustomersв нашем оригинальном запросе. -
Создайте второй новый SQL файл,
models/stg_orders.sql, с SQL из CTEordersв нашем оригинальном запросе.models/stg_customers.sqlselect
ID as customer_id,
FIRST_NAME as first_name,
LAST_NAME as last_name
from dbo.customersmodels/stg_orders.sqlselect
ID as order_id,
USER_ID as customer_id,
ORDER_DATE as order_date,
STATUS as status
from dbo.orders -
Измените SQL в вашем файле
models/customers.sqlследующим образом:models/customers.sqlwith 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 customer_id
),
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 -
Выполните
dbt run.На этот раз, когда вы выполнили
dbt run, были созданы отдельные представления/таблицы дляstg_customers,stg_ordersиcustomers. dbt определил порядок выполнения этих моделей. Посколькуcustomersзависит отstg_customersиstg_orders, dbt строитcustomersпоследним. Вам не нужно явно определять эти зависимости.
Часто задаваемые вопросы
Добавьте тесты к вашим моделям
Добавление data tests в проект помогает убедиться, что ваши модели работают корректно.
Чтобы добавить data tests в проект:
-
Создайте новый YAML-файл в директории
models, назвав егоmodels/schema.yml. -
Добавьте в файл следующее содержимое:
models/schema.ymlversion: 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 -
Запустите
dbt testи убедитесь, что все ваши тесты прошли успешно.
Когда вы запускаете dbt test, dbt проходит по вашим YAML-файлам и создает запрос для каждого теста. Каждый запрос вернет количество записей, которые не прошли тест. Если это число равно 0, то тест считается успешным.
Часто задаваемые вопросы
Документируйте ваши модели
Добавление документации в ваш проект позволяет подробно описывать ваши модели и делиться этой информацией с вашей командой. Здесь мы добавим базовую документацию в наш проект.
Обновите файл 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
- View in Catalog
- View in Studio IDE
Catalog предоставляет мощные инструменты для работы с вашими проектами dbt, в том числе с документацией:
- Выполните одну из следующих команд:
dbt docs generate, если вы используете dbt v1dbt build, если вы используете dbt v2
- Нажмите Catalog в меню навигации, чтобы открыть Catalog.
- По умолчанию Catalog отображает среду Production. Если в вашей учетной записи есть дополнительные среды (например, Staging), вы можете выбрать их в раскрывающемся списке сред.
- Выберите свой проект в дереве файлов.
- Используйте строку поиска или просмотрите список ресурсов, чтобы найти модель
customers. - Нажмите на модель, чтобы просмотреть сведения о ней, включая добавленные вами описания.
Catalog отображает описание вашей модели, документацию столбцов, тесты данных и граф зависимостей. Вы также можете видеть, для каких столбцов отсутствует документация, и отслеживать покрытие тестами во всем проекте.
Вы можете просматривать документацию непосредственно в IDE, если используете v1 Latest или другую версию dbt v1. Обратите внимание: это устаревший режим просмотра, который не обеспечивает такой же уровень интерактивности, как Catalog.
- В IDE выполните
dbt docs generate. - На панели навигации нажмите значок View docs, расположенный справа от имени ветки.
- В разделе Projects выберите имя своего проекта и разверните папки.
- Нажмите models > marts > customers.
Часто задаваемые вопросы
Зафиксируйте изменения
Теперь, когда вы построили модель customers, нужно закоммитить внесённые в проект изменения, чтобы в репозитории оказался ваш актуальный код.
Если вы вносили изменения непосредственно в защищённую основную ветку:
- Нажмите кнопку Commit and sync git. Это действие подготовит ваши изменения к коммиту.
- Появится модальное окно с заголовком Commit to a new branch.
- В модальном окне задайте новой ветке имя
add-customers-model. Будет создана ветка от вашей основной ветки с внесёнными изменениями. - Добавьте сообщение коммита, например «Добавлена модель customers, тесты и документация», и создайте коммит с вашими изменениями.
- Нажмите Merge this branch to main, чтобы добавить эти изменения в ветку main вашего репозитория.
Если вы создали новую ветку до редактирования:
- Поскольку вы уже ответвились от защищённой основной ветки, слева перейдите в Version Control.
- Нажмите Commit and sync, чтобы добавить сообщение.
- Добавьте сообщение коммита, например «Добавить модель customers, тесты и документацию».
- Нажмите Merge this branch to main, чтобы добавить эти изменения в ветку main вашего репозитория.
Разверните dbt
Используйте планировщик dbt, чтобы уверенно запускать задания в продакшене и обеспечивать наблюдаемость ваших процессов. Далее вы узнаете, как создать среду развертывания и запустить задание.
Создайте окружение развертывания (deployment environment)
- В главном меню перейдите в Orchestration > Environments.
- Нажмите Create environment.
- В поле Name введите имя среды развертывания. Например, "Production".
- В поле dbt version по умолчанию выбрана последняя доступная версия. Мы рекомендуем использовать последнюю версию dbt для всех новых проектов.
- В разделе Deployment connection введите имя набора данных, который вы хотите использовать в качестве целевого, например "Analytics". Это позволит dbt создавать объекты в этом наборе данных и работать с ним. В некоторых хранилищах данных целевой набор данных может называться «схемой».
- Нажмите Save.
Создайте и запустите job
Jobs — это набор команд dbt, которые вы хотите запускать по расписанию. Например, dbt build.
По мере того как бизнес jaffle_shop получает больше клиентов, а эти клиенты создают больше заказов, в исходных данных будет появляться больше записей. Поскольку вы материализовали модель customers как таблицу, вам нужно периодически пересобирать её, чтобы данные оставались актуальными. Это обновление будет происходить при запуске job.
- После создания окружения развертывания вы должны попасть на страницу нового окружения. Если нет — в главном меню выберите Orchestration, затем нажмите Jobs.
- Нажмите Create job > Deploy job.
- Укажите имя job (например, «Production run») и выберите окружение, которое вы только что создали.
- Прокрутите вниз до раздела Execution settings.
- В разделе Commands добавьте эту команду как часть job, если её нет:
dbt build
- (Версии dbt: v2.0 и новее) Добавлять шаг создания документации не нужно. При каждом запуске задания метаданные вашего проекта в Catalog обновляются автоматически.
- В этом упражнении не задавайте расписание запуска проекта — хотя проект вашей организации должен запускаться регулярно, для этого примера запуск по расписанию не нужен. Настройку запуска задания по расписанию иногда называют развёртыванием проекта.
- Нажмите Save, затем нажмите Run now, чтобы запустить задание.
- Нажмите на запуск и следите за его ходом в разделе Run summary.
- После завершения запуска (Версии dbt: v2.0 и новее) нажмите Catalog на панели навигации, чтобы изучить свой проект.
Поздравляем 🎉! Вы только что развернули свой первый dbt‑проект!
Часто задаваемые вопросы
Теперь, когда ваш проект настроен и работает, подключите к нему свой ИИ-инструмент (например, Claude или ChatGPT) через dbt MCP server, чтобы задавать вопросы о моделях на естественном языке. Описания, тесты и семантические модели помогут сделать его ответы ещё лучше.





