Просмотр документации
dbt предоставляет интуитивно понятные и масштабируемые инструменты для просмотра документации dbt. Подробная документация крайне важна для разработчиков и других заинтересованных сторон, чтобы сформировать общее понимание контекста вашего dbt‑проекта.
Вы можете просматривать документацию двумя взаимодополняющими способами — в зависимости от ваших задач:
| Loading table... |
Навигация по документации
В следующих разделах описано, как перемещаться по документации в Catalog и dbt Docs.
Каталог StarterEnterpriseEnterprise +
Catalog предлагает динамичный и интерактивный способ исследования моделей, источников и lineage. Чтобы открыть Catalog, выберите пункт Explore в меню навигации dbt.
Пример страницы с деталями ресурса в Catalog и его lineage.
Навигация по Catalog для изучения ресурсов и lineage проекта.Catalog предоставляет пользователям широкий набор возможностей для упрощения навигации по data‑проекту и его понимания, включая:
- Интерактивную визуализацию lineage DAG проекта для понимания связей между ресурсами.
- Поиск ресурсов с расширенными фильтрами для быстрого и эффективного нахождения нужных объектов.
- Инсайты о производительности моделей — доступ к метаданным запусков в dbt для глубокого анализа производительности и качества моделей.
- Рекомендации по проекту с предложениями по улучшению покрытия тестами и документации.
- Data health signals для мониторинга состояния и производительности каждого ресурса.
- Историю запросов к моделям, позволяющую отслеживать использование данных и лучше понимать их потребление.
- Downstream exposures — автоматическое отображение релевантных моделей данных из инструментов вроде Tableau для повышения прозрачности.
Для получения дополнительной информации о том, как исследовать lineage, навигировать по ресурсам, просматривать историю запросов моделей и data health signals, доступность функций и многое другое — см. Discover data with Catalog.
Документация dbt Docs
dbt Docs предоставляет ценные инсайты по проектам на планах dbt Core или dbt Developer. Интерфейс позволяет перейти к документации конкретных моделей. Это может выглядеть примерно так:
Автоматически сгенерированная документация для модели dbtЗдесь вы видите представление структуры проекта, markdown‑описание модели и список всех колонок модели с документацией.
На странице dbt Docs нажмите зелёную кнопку в правом нижнем углу страницы, чтобы развернуть «мини‑карту» вашего DAG. В этой панели отображаются непосредственные родители и потомки модели, которую вы изучаете.
Открытие мини‑карты DAGВ этом примере модель fct_subscription_transactions имеет только одного прямого родителя. Нажав кнопку Expand в правом верхнем углу окна, можно развернуть граф по горизонтали и увидеть полный lineage модели. Этот lineage можно фильтровать с помощью флагов --select и --exclude, которые соответствуют семантике model selection syntax. Кроме того, вы можете щёлкнуть правой кнопкой мыши для взаимодействия с DAG, перехода к документации или обмена ссылками на визуализацию графа с коллегами.
Полный lineage для модели dbtРазвёртывание сайта документации
Легко разворачивайте документацию в Catalog или dbt Docs, чтобы сделать её доступной для ваших команд.
Команда dbt docs serve предназначена только для локального или dev‑хостинга сайта документации. Пожалуйста, используйте один из методов, перечисленных в следующем разделе (или аналогичный), чтобы обеспечить безопасный хостинг документации.
Каталог StarterEnterpriseEnterprise +
Catalog автоматически обновляет документацию после каждого production или staging job run, используя сгенерированные метаданные. Это означает, что документация всегда отражает актуальное состояние проекта и не требует ручного деплоя. Подробнее о том, как Catalog использует метаданные для автоматического обновления документации, см. Generate metadata.
Чтобы узнать, как развернуть сайт документации, см. Build and view your docs with dbt.
Документация dbt Docs
dbt Docs изначально спроектирован так, чтобы его было легко размещать в вебе. Сайт является «статическим», то есть вам не нужны «динамические» серверы для его обслуживания. Вы можете разместить документацию несколькими способами:
- Разместить на Amazon S3 (при необходимости — с ограничениями доступа по IP)
- Опубликовать с помощью Netlify
- Использовать собственный веб‑сервер, например Apache или Nginx
- Если вы используете план dbt Developer, см. Build and view your docs with dbt, чтобы узнать, как развернуть сайт документации.
Если вы хотите использовать Catalog для полноценного опыта работы с документацией dbt, зарегистрируйтесь для бесплатного trial dbt или свяжитесь с нами.
