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

Свойства моделей

Свойства моделей могут быть объявлены в файлах .yml в вашем каталоге models/ (как определено в конфигурации model-paths).

Вы можете назвать эти файлы как угодно, например, whatever_you_want.yml, и вкладывать их на любую глубину в подкаталоги внутри каталога models/.

models/<filename>.yml
version: 2

models:
- name: <имя модели>
description: <markdown_string>
docs:
show: true | false
node_color: <color_id> # Используйте имя (например, node_color: purple) или шестнадцатеричный код в кавычках (например, node_color: "#cd7f32")
latest_version: <идентификатор версии>
deprecation_date: <YAML_DateTime>
access: private | protected | public
config:
<model_config>: <значение_конфигурации>
constraints:
- <ограничение>
tests:
- <тест>
- ... # объявите дополнительные тесты данных
columns:
- name: <имя_столбца> # обязательно
description: <markdown_string>
meta: {<словарь>}
quote: true | false
constraints:
- <ограничение>
tests:
- <тест>
- ... # объявите дополнительные тесты данных
tags: [<строка>]

# обязательно только в сочетании с ключом time_spine
granularity: <любая поддерживаемая временная гранулярность>

- name: ... # объявите свойства дополнительных столбцов

time_spine:
standard_granularity_column: <имя_столбца>

versions:
- v: <идентификатор версии> # обязательно
defined_in: <имя_файла_определения>
description: <markdown_string>
docs:
show: true | false
access: private | protected | public
constraints:
- <ограничение>
config:
<model_config>: <значение_конфигурации>
tests:
- <тест>
- ... # объявите дополнительные тесты данных
columns:
# включить/исключить столбцы из свойств модели верхнего уровня
- include: <значение_включения>
exclude: <список_исключений>
# указать дополнительные столбцы
- name: <имя_столбца> # обязательно
quote: true | false
constraints:
- <ограничение>
tests:
- <тест>
- ... # объявите дополнительные тесты данных
tags: [<строка>]
- v: ... # объявите дополнительные версии

0