# О переменной config

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

Например, код в материализации `incremental`, такой как этот:

```text
{% materialization incremental, default -%}
  {%- set unique_key = config.get('unique_key') -%}
  ...
```

отвечает за обработку кода модели, который выглядит так:

```text
{{
  config(
    materialized='incremental',
    unique_key='id'
  )
}}
```

Просмотрите [Конфигурации моделей](https://docs.getdbt.tech/reference/model-configs.md) для примеров и дополнительной информации о допустимых аргументах.

## config.get

**Аргументы**:

* `name`: Имя конфигурационной переменной (обязательно)
* `default`: Значение по умолчанию, которое будет использоваться, если эта конфигурация не предоставлена (необязательно)

Функция `config.get` используется для получения конфигураций для модели от конечного пользователя. Конфигурации, определенные таким образом, являются необязательными, и может быть предоставлено значение по умолчанию.

Существует 3 случая:

1. Конфигурационная переменная существует, она не `None`
2. Конфигурационная переменная существует, она `None`
3. Конфигурационная переменная не существует

Доступ к пользовательским конфигурациям в meta

Поведение `config.get()` различается в зависимости от того, как вы обращаетесь к конфигурациям внутри `meta`:

* **Доступ к конкретному ключу внутри `meta`**: `config.get('my_key')` не возвращает значения из `config.meta`. Если ключ существует только в `meta`, `config.get()` возвращает значение по умолчанию и выводит предупреждение. Это относится как к dbt v1, так и к dbt v2.
* **Доступ к словарю `meta`**: `config.get('meta', default={})` возвращает весь словарь `meta` в dbt v2, но не работает в dbt v1.

Чтобы обращаться к пользовательским конфигурациям внутри `meta` одинаковым образом в обоих движках, используйте [`config.meta_get()`](#configmeta_get).

Пример использования:

```sql
{% materialization incremental, default -%}
  -- Пример без значения по умолчанию. unique_key будет None, если пользователь не предоставит эту конфигурацию
  {%- set unique_key = config.get('unique_key') -%}

  -- Пример с альтернативным значением. Используйте альтернативу 'id', если конфигурация 'unique_key' предоставлена, но она None
  {%- set unique_key = config.get('unique_key') or 'id' -%}

  -- Пример со значением по умолчанию. По умолчанию 'id', если конфигурация 'unique_key' не существует
  {%- set unique_key = config.get('unique_key', default='id') -%}

  -- For custom configs under `meta`, use config.meta_get()
  {% set my_custom_config = config.meta_get('custom_config_key') %}
  ...
```

## config.require

**Аргументы**:

* `name`: Имя конфигурационной переменной (обязательно)

Функция `config.require` используется для получения конфигураций для модели от конечного пользователя. Конфигурации, определенные с использованием этой функции, являются обязательными, и их отсутствие приведет к ошибке компиляции.

Доступ к пользовательским конфигурациям в `meta`

`config.require()` не возвращает значения из `config.meta`. Если ключ существует только в `meta`, `config.require()` вызывает ошибку и выводит предупреждение. Чтобы получить обязательные пользовательские конфигурации, сохранённые в `meta`, используйте [`config.meta_require()`](#configmeta_require).

Пример использования:

```sql
{% materialization incremental, default -%}
  {%- set unique_key = config.require('unique_key') -%}
  ...
```

## config.meta\_get

Эта функциональность доступна в dbt версии 1.10 и выше.

**Аргументы**:

* `name`: имя переменной конфигурации, которую нужно получить из `meta` (обязательно)
* `default`: значение по умолчанию, которое будет использовано, если эта конфигурация не задана (опционально)

Функция `config.meta_get` извлекает пользовательские конфигурации, сохранённые в словаре `meta`. В отличие от `config.get()`, эта функция проверяет **только** `config.meta` и не приводит к появлению предупреждений о депрекейте.

Используйте эту функцию, когда обращаетесь к пользовательским конфигурациям, которые вы определили в `meta` в конфигурации модели или ресурса — по сути, это эквивалент вызова `config.get('meta').get()`.

`config.meta_get` пока не поддерживается в моделях Python. В них используйте `dbt.config.get("meta").get("<key>")` для чтения пользовательских настроек `meta`. Вызов `dbt.config.get_meta("<key>")` — псевдоним `dbt.config.get("meta").get("<key>")`.

Пример использования:

```sql
{% materialization custom_materialization, default -%}
  -- Retrieve a custom config from meta, returns None if not found
  {%- set custom_setting = config.meta_get('custom_setting') -%}

  -- Retrieve with a default value
  {%- set custom_setting = config.meta_get('custom_setting', default='default_value') -%}
  ...
```

Пример конфигурации модели:

```yaml
models:
  - name: my_model
    config:
      meta:
        custom_setting: "my_value"
```

## config.meta\_require

Эта функциональность доступна в dbt версии 1.10 и выше.

**Аргументы**:

* `name`: имя переменной конфигурации, которую нужно получить из `meta` (обязательно)

Функция `config.meta_require` извлекает пользовательские конфигурации, сохранённые в словаре `meta`. В отличие от `config.require()`, эта функция проверяет **только** `config.meta` и не приводит к предупреждениям о депрекейте. Если конфигурация не найдена, dbt выбрасывает ошибку компиляции.

Используйте эту функцию, когда необходимо гарантировать наличие пользовательской конфигурации в `meta`.

Обратите внимание, что `config.meta_require` пока не поддерживается в Python-моделях.

Пример использования:

```sql
{% materialization custom_materialization, default -%}
  -- Require a custom config from meta, throws error if not found
  {%- set required_setting = config.meta_require('required_setting') -%}
  ...
```

Пример конфигурации модели:

```yaml
models:
  - name: my_model
    config:
      meta:
        required_setting: "my_value"
```
