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

arguments (для макросов)

macros/<filename>.yml


macros:
- name: <macro name>
arguments:
- name: <arg name>
type: <string>
description: <markdown_string>

Определение​

Свойство arguments определяет параметры, которые принимает ресурс. Для каждого аргумента можно задать name, type и необязательное description.

Для макросов вы можете добавить секцию arguments в свойства макроса. Это помогает документировать макрос и понимать, какие входные параметры он ожидает.

type​

(Версии dbt: v1.10 и новее)

Тип данных аргумента. Если параметр validate_macro_args установлен в true, dbt проверяет, что имена аргументов макроса в документации совпадают с именами в определении макроса, а их типы входят в число поддерживаемых типов. Если параметр установлен в false, type используется только для документации, и на указываемые значения не накладывается никаких ограничений.

подсказка

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

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

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

macros/<filename>.yml

macros:
- name: <macro name>
arguments:
- name: <arg name>
type: <string>

Поддерживаемые типы​

(Версии dbt: v2.0 и новее)

При использовании флага validate_macro_args dbt поддерживает следующие типы аргументов макросов:

  • string или str
  • boolean или bool
  • integer или int
  • float
  • any
  • list[<Type>], например list[string]
  • dict[<Type>, <Type>], например dict[str, list[int]]
  • optional[<Type>], например optional[integer]
  • relation
  • column

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

Примеры​

macros/cents_to_dollars.sql
{% macro cents_to_dollars(column_name, scale=2) %}
({{ column_name }} / 100)::numeric(16, {{ scale }})
{% endmacro %}

macros/cents_to_dollars.yml

macros:
- name: cents_to_dollars
arguments:
- name: column_name
type: column
description: "The name of a column"
- name: scale
type: integer
description: "The number of decimal places to round to. Default is 2."

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

0
Loading