Перейти к основному содержимому

Как мы оформляем наш YAML

Руководство по стилю YAML​

  • 2️⃣ Отступы должны быть в два пробела
  • ➡️ Элементы списка должны иметь отступ
  • 🔠 Элементы списка с одним значением могут быть строкой. Например, 'select': 'other_user', однако лучшей практикой считается передавать аргумент в виде явного списка. Например, 'select': ['other_user']
  • 🆕 При необходимости используйте новую строку для разделения элементов списка, которые являются словарями
  • 📏 Длина строк в YAML не должна превышать 80 символов
  • 🛠️ Используйте dbt JSON schema с любым совместимым Studio IDE и форматтером YAML (мы рекомендуем Prettier) для валидации YAML‑файлов и их автоматического форматирования

Обратите внимание: дополнительную информацию о YAML можно найти в разделе YAML tips.

к сведению

☁️ Как и в случае с Python и SQL, Studio IDE имеет встроенное форматирование YAML‑файлов (а также Markdown и JSON!) с помощью Prettier. Просто нажмите кнопку Format, и стиль будет приведён в порядок. Как и для других инструментов, вы также можете настроить правила форматирования под себя, чтобы они соответствовали гайдлайнам вашей компании.

Пример YAML​



models:
  - name: events
    columns:
      - name: event_id
        description: This is a unique identifier for the event
        data_tests:
          - unique
          - not_null

      - name: event_time
        description: "When the event occurred in UTC (eg. 2018-01-01 12:00:00)"
        data_tests:
          - not_null

      - name: user_id
        description: The ID of the user who recorded the event
        data_tests:
          - not_null
          - relationships:
              arguments: # доступно в версии v1.10.5 и выше. В более старых версиях можно указывать <argument_name> как свойство верхнего уровня.
                to: ref('users')
                field: id

Нашли ошибку?

0
Loading