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

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

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

Пример​

macros/schema.yml
version: 2

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

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

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

Подробнее см. в разделе о валидации аргументов макросов.

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

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

materialization_{materialization_name}_{adapter}

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

macros/properties.yml
version: 2

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

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

0
Loading