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

macros/\<filename>.yml

```yml


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

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

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

Для **макросов** вы можете добавить секцию `arguments` в [свойства макроса](https://docs.getdbt.tech/reference/macro-properties.md). Это помогает документировать макрос и понимать, какие входные параметры он ожидает.

## type

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

Тип данных аргумента. Если параметр [`validate_macro_args`](https://docs.getdbt.tech/reference/global-configs/behavior-flags/validate_macro_args.md) установлен в `true`, dbt проверяет, что имена аргументов макроса в документации совпадают с именами в определении макроса, а их типы входят в число [поддерживаемых типов](#supported-types). Если параметр установлен в `false`, `type` используется только для документации, и на указываемые значения не накладывается никаких ограничений.

подсказка

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

* Определять аргументы на основе определения макроса и включать их в файл [manifest.json](https://docs.getdbt.tech/reference/artifacts/manifest-json.md), если аргументы не задокументированы.
* Выдавать предупреждение, если имена аргументов в документации не совпадают с определением макроса.
* Выдавать предупреждение, если поля `type` не соответствуют [поддерживаемым форматам](https://docs.getdbt.tech/reference/resource-properties/arguments.md#supported-types).

Узнайте больше о [валидации аргументов макросов](https://docs.getdbt.tech/reference/global-configs/behavior-flags/validate_macro_args.md).

macros/\<filename>.yml

```yml

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

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

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

При использовании флага [`validate_macro_args`](https://docs.getdbt.tech/reference/global-configs/behavior-flags/validate_macro_args.md) 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`](https://docs.getdbt.tech/reference/dbt-classes.md#relation)
* [`column`](https://docs.getdbt.tech/reference/dbt-classes.md#column)

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

## Примеры

macros/cents\_to\_dollars.sql

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

macros/cents\_to\_dollars.yml

```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."
```

## Связанная документация

* [Свойства макросов](https://docs.getdbt.tech/reference/macro-properties.md)
* [arguments (для функций)](https://docs.getdbt.tech/reference/resource-properties/function-arguments.md)
