# Как мы оформляем наши dbt модели

## Поля и названия моделей

* 👥 Модели должны быть во множественном числе, например, `customers`, `orders`, `products`.

* 🔑 Каждая модель должна иметь первичный ключ.

* 🔑 Первичный ключ модели должен называться `<object>_id`, например, `account_id`. Это упрощает понимание того, какой `id` используется в последующих объединенных моделях.

* Используйте подчеркивания для именования dbt моделей; избегайте точек.

  * ✅ `models_without_dots`
  * ❌ `models.with.dots`

* Большинство платформ данных используют точки для разделения `database.schema.object`, поэтому использование символов подчеркивания вместо точек снижает необходимость в [заключении идентификаторов в кавычки](https://docs.getdbt.tech/reference/resource-properties/quoting.md), а также риск возникновения проблем в некоторых частях dbt. Подробнее см. в [этом обсуждении на GitHub](https://github.com/dbt-labs/dbt/issues/3246).

* 🔑 Ключи должны иметь строковый тип данных.

* 🔑 Последовательность — залог успеха! По возможности используйте одинаковые имена полей во всех моделях. Например, ключ для таблицы `customers` должен называться `customer_id`, а не `user_id` или 'id'.

* ❌ Не используйте сокращения или псевдонимы. Отдавайте предпочтение читаемости, а не краткости. Например, не используйте `cust` вместо `customer` или `o` вместо `orders`.

* ❌ Не используйте зарезервированные слова в качестве имен столбцов.

* ➕ Имена логических столбцов должны начинаться с префикса `is_` или `has_`.

* 🕰️ Столбцы с временными метками должны называться `<event>_at` (например, `created_at`), а их значения должны быть в UTC. Если используется другой часовой пояс, его следует указать с помощью суффикса (`created_at_pt`).

* 📆 Столбцы с датами должны называться `<event>_date`. Например, `created_date.`

* 🔙 В именах столбцов с датами и временем событий следует использовать формы прошедшего времени — `created`, `updated` или `deleted`.

* 💱 Поля с ценами и выручкой должны содержать денежные суммы в десятичном представлении (`19.99` для $19.99; многие базы данных приложений хранят цены как целые числа в центах). Если используется не десятичное представление денежных сумм, укажите это с помощью суффикса (`price_in_cents`).

* 🐍 Имена схем, таблиц и столбцов должны быть в формате `snake_case`.

* 🏦 Используйте имена, основанные на *бизнес-терминологии*, а не на терминологии источника. Например, если в исходной базе данных используется `user_id`, но в бизнесе этот идентификатор называют `customer_id`, используйте в модели `customer_id`.

* 🔢 Для единообразия версии моделей следует обозначать суффиксами `_v1`, `_v2` и т. д. (`customers_v1` и `customers_v2`).

* 🗄️ Соблюдайте единый порядок типов данных и рассмотрите возможность группировки и обозначения столбцов по типам, как в примере ниже. Это сведет к минимуму ошибки при соединении таблиц, упростит чтение модели, а также поможет пользователям данных на последующих этапах обработки понимать типы данных и быстро находить в моделях нужные столбцы. Мы предпочитаем следующий порядок: идентификаторы, строки, числа, логические значения, даты и временные метки.

## Пример модели

```sql
with

source as (

    select * from {{ source('ecom', 'raw_orders') }}

),

renamed as (

    select

        ----------  ids
        id as order_id,
        store_id as location_id,
        customer as customer_id,

        ---------- strings
        status as order_status,

        ---------- numerics
        (order_total / 100.0)::float as order_total,
        (tax_paid / 100.0)::float as tax_paid,

        ---------- booleans
        is_fulfilled,

        ---------- dates
        date(order_date) as ordered_date,

        ---------- timestamps
        ordered_at

    from source

)

select * from renamed
```
