# returns

Полезно знать

Доступно начиная с dbt v1.11 или в [канале релизов v1 Latest](https://docs.getdbt.tech/docs/dbt-versions/dbt-release-tracks.md).

functions/\<filename>.yml

```yml


functions:
  - name: <function name>
    returns:
      data_type: <string> # обязательно; зависит от хранилища данных
      description: <markdown_string> # опционально
```

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

Свойство `returns` определяет результат выполнения пользовательской функции (UDF). Это обязательное свойство для всех функций, которое указывает, какой тип данных функция будет возвращать при выполнении.

## Свойства

### data\_type (обязательно)

Поле `data_type` задаёт тип данных, который возвращает функция. Это обязательное поле, и его значение должно соответствовать типам данных, поддерживаемым вашей конкретной платформой хранения данных.

Типы данных, специфичные для хранилища

Значения `data_type` зависят от хранилища данных. Используйте синтаксис типов данных, который требуется в вашем хранилище:

* **Snowflake**: `STRING`, `NUMBER`, `BOOLEAN`, `TIMESTAMP_NTZ`, `VARIANT` и т. д.
* **BigQuery**: `STRING`, `INT64`, `BOOL`, `TIMESTAMP`, `ARRAY<STRING>`, `STRUCT` и т. д.
* **Redshift**: `VARCHAR`, `INTEGER`, `BOOLEAN`, `TIMESTAMP`, `SUPER` и т. д.
* **Postgres**: `TEXT`, `INTEGER`, `BOOLEAN`, `TIMESTAMP`, `JSONB` и т. д.
* **Starburst/Trino**: `VARCHAR`, `INTEGER`, `DOUBLE`, `BOOLEAN` и другие [типы данных Trino](https://trino.io/docs/current/language/types.html).

Обратитесь к документации вашего хранилища для получения полного списка поддерживаемых типов данных и их синтаксиса.

### описание

Необязательная строка в формате markdown, описывающая, что именно возвращает функция. Полезна для целей документирования.

## Примеры

### Простая скалярная функция

functions/schema.yml

```yml

functions:
  - name: is_valid_email
    description: Validates if a string is a properly formatted email address
    arguments:
      - name: email_string
        data_type: STRING
        description: The email address to validate
    returns:
      data_type: BOOLEAN
      description: Returns true if the string is a valid email format, false otherwise
```

### Функция со сложным типом возвращаемого значения

functions/schema.yml

```yml

functions:
  - name: calculate_metrics
    description: Calculates revenue and profit metrics
    arguments:
      - name: revenue
        data_type: DECIMAL(18,2)
      - name: cost
        data_type: DECIMAL(18,2)
    returns:
      data_type: DECIMAL(18,2)
      description: The calculated profit margin as a percentage
```

### Функция BigQuery с типом возвращаемого значения ARRAY

functions/schema.yml

```yml

functions:
  - name: split_tags
    description: Splits a comma-separated string into an array of tags
    arguments:
      - name: tag_string
        data_type: STRING
    returns:
      data_type: ARRAY<STRING>
      description: An array of individual tag strings
```

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

* [Пользовательские функции](https://docs.getdbt.tech/docs/build/udfs.md)

* [Свойства функций](https://docs.getdbt.tech/reference/function-properties.md)

* [Конфигурации функций](https://docs.getdbt.tech/reference/function-configs.md)

* [arguments](https://docs.getdbt.tech/reference/resource-properties/function-arguments.md)

* [Пользовательские функции (UDF)](https://docs.getdbt.tech/docs/build/udfs.md)

* [Свойства функций](https://docs.getdbt.tech/reference/function-properties.md)

* [Конфигурации функций](https://docs.getdbt.tech/reference/function-configs.md)

* [Аргументы](https://docs.getdbt.tech/reference/resource-properties/function-arguments.md)
