# Перегрузки Полезно знать Доступно начиная с dbt v1.12 или в [канале релизов v1 Latest](https://docs.getdbt.tech/docs/dbt-versions/dbt-release-tracks.md). functions/\.yml ```yml functions: - name: arguments: - name: data_type: returns: data_type: overloads: - defined_in: # обязательное поле, имя файла SQL, Python или JavaScript arguments: # необязательное поле - name: # обязательное поле, если задано arguments data_type: # обязательное поле, если задано arguments; зависит от хранилища данных description: default_value: # необязательное поле, только для Snowflake и Postgres returns: # необязательное поле; если не задано, наследуется от основной функции data_type: # обязательное поле, если задано returns; зависит от хранилища данных description: - defined_in: ... # объявление дополнительных перегрузок ``` ## Определение Свойство `overloads` позволяет определить несколько сигнатур аргументов для одной и той же [пользовательской функции (UDF)](https://docs.getdbt.tech/docs/build/udfs.md). Это позволяет вызывать функцию с одним и тем же именем для разных типов входных данных, не создавая отдельную UDF для каждого варианта. Хранилище данных вызывает нужную версию на основе типов аргументов. Свойство `overloads` поддерживается для SQL UDF в Snowflake и Postgres, а также для Python и JavaScript UDF в Snowflake. Каждая перегрузка ссылается на отдельный файл, содержащий тело функции, и может задавать необязательные свойства `arguments` и `returns`. Все перегрузки объединяются в один узел DAG (основную функцию), поэтому они создаются и выбираются вместе. При повторной попытке dbt пропускает успешно выполненные перегрузки и повторно запускает только те, которые завершились с ошибкой. ## Поведение dbt выполняет все перегрузки независимо от ошибок в отдельных перегрузках, чтобы вы получили полную картину того, какие перегрузки выполнились успешно, а какие завершились с ошибкой. Действуют следующие правила: * Если хотя бы одна перегрузка завершается с ошибкой, dbt помечает узел функции статусом `PARTIAL_SUCCESS` и пропускает зависимые узлы. * [`dbt retry`](https://docs.getdbt.tech/reference/commands/retry.md) пропускает перегрузки, которые уже выполнились успешно, и повторно запускает только те, которые ранее завершились с ошибкой. * [`state:modified`](https://docs.getdbt.tech/reference/node-selection/methods.md#the-state-method) обнаруживает изменения в теле функции, аргументах или типе возвращаемого значения любой перегрузки и помечает узел основной функции как изменённый. ## Свойства Каждый элемент списка `overloads` поддерживает следующие свойства. ### defined\_in Имя файла (без расширения), содержащего тело перегрузки функции. Файл должен существовать в каталоге `functions/`. Например, `defined_in: null_if_empty_numeric` ссылается на `functions/null_if_empty_numeric.sql` для SQL UDF, `functions/null_if_empty_numeric.py` для Python UDF или `functions/null_if_empty_numeric.js` для JavaScript UDF. Каждая перегрузка должна ссылаться на уникальный файл. Файл основной функции и файлы, указанные во всех значениях `defined_in`, должны отличаться друг от друга. dbt выдаёт ошибку разбора, если: * Значение `defined_in` соответствует файлу самой основной функции. * Две перегрузки ссылаются на один и тот же файл. * Указанный файл не существует в каталоге `functions/`. ### arguments Список аргументов перегрузки. Имеет ту же структуру, что и [аргументы функции](https://docs.getdbt.tech/reference/resource-properties/function-arguments.md). ### returns Тип возвращаемого значения перегрузки. Имеет ту же структуру, что и [returns](https://docs.getdbt.tech/reference/resource-properties/returns.md). Если свойство не задано, перегрузка наследует тип возвращаемого значения основной функции. ## Пример ### SQL functions/null\_if\_empty.yml ```yml functions: - name: null_if_empty arguments: - name: val data_type: varchar returns: data_type: varchar overloads: - defined_in: null_if_empty_numeric arguments: - name: val data_type: numeric returns: data_type: numeric ``` Создайте отдельный SQL-файл для тела каждой перегрузки. В этом примере основная функция обрабатывает пустые строки, а перегрузка — числовые значения: functions/null\_if\_empty.sql ```sql # синтаксис для Snowflake CASE WHEN val = '' THEN NULL ELSE val END # синтаксис для Postgres SELECT CASE WHEN val = '' THEN NULL ELSE val END ``` functions/null\_if\_empty\_numeric.sql ```sql # синтаксис для Snowflake CASE WHEN val = 0 THEN NULL ELSE val END # синтаксис для Postgres SELECT CASE WHEN val = 0 THEN NULL ELSE val END ``` ### Python functions/null\_if\_empty.yml ```yml functions: - name: null_if_empty config: runtime_version: "3.11" entry_point: main arguments: - name: val data_type: varchar returns: data_type: varchar overloads: - defined_in: null_if_empty_numeric arguments: - name: val data_type: numeric returns: data_type: numeric ``` Создайте отдельный Python-файл для тела каждой перегрузки. В этом примере основная функция обрабатывает пустые строки, а перегрузка — числовые значения: functions/null\_if\_empty.py ```python def main(val): return None if val == '' else val ``` functions/null\_if\_empty\_numeric.py ```python def main(val): return None if val == 0 else val ``` ### JavaScript functions/null\_if\_empty.yml ```yml functions: - name: null_if_empty arguments: - name: val data_type: varchar returns: data_type: varchar overloads: - defined_in: null_if_empty_numeric arguments: - name: val data_type: numeric returns: data_type: numeric ``` Создайте отдельный JavaScript-файл для тела каждой перегрузки. В этом примере основная функция обрабатывает пустые строки, а перегрузка — числовые значения: functions/null\_if\_empty.js ```javascript if (val === '') return null; return val; ``` functions/null\_if\_empty\_numeric.js ```javascript if (val === 0) return null; return val; ``` ## Связанная документация * [Пользовательские функции](https://docs.getdbt.tech/docs/build/udfs.md) * [Свойства функций](https://docs.getdbt.tech/reference/function-properties.md) * [Аргументы функций](https://docs.getdbt.tech/reference/resource-properties/function-arguments.md) * [returns](https://docs.getdbt.tech/reference/resource-properties/returns.md)