Перейти к основному содержимому

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

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

Пример​

macros/properties.yml
macros:
- name: cents_to_dollars
description: Макрос для преобразования центов в доллары
arguments:
- name: column_name
type: column
description: Имя столбца, который вы хотите преобразовать
- name: precision
type: integer
description: Количество десятичных знаков. По умолчанию 2.
подсказка

Начиная с dbt v1.10, вы можете включить проверку аргументов, определённых в документации макросов, с помощью флага изменения поведения validate_macro_args. При включении этого флага dbt будет:

  • Определять аргументы на основе определения макроса и включать их в файл manifest.json, если аргументы не задокументированы.
  • Выдавать предупреждение, если имена аргументов в документации не совпадают с определением макроса.
  • Выдавать предупреждение, если поля type не соответствуют поддерживаемым форматам.

Узнайте больше о валидации аргументов макросов.

Документирование пользовательской материализации​

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

materialization_{materialization_name}_{adapter}

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

macros/properties.yml
macros:
- name: materialization_my_materialization_name_default
description: Пользовательская материализация для вставки записей в таблицу только для добавления и отслеживания времени их добавления.
- name: materialization_my_materialization_name_xyz
description: Пользовательская материализация для вставки записей в таблицу только для добавления и отслеживания времени их добавления.

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

0
Loading