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

Сохраненные запросы

Сохраненные запросы — это способ сохранить часто используемые запросы в MetricFlow. Вы можете сгруппировать метрики, измерения и фильтры, которые логически связаны, в сохраненный запрос. Сохраненные запросы являются узлами и видны в dbt DAG.

Сохранённые запросы служат основой, позволяя настраивать экспорты в конфигурации сохранённого запроса. Экспорты расширяют эту функциональность, позволяя запускать сохранённые запросы по расписанию и записывать их результаты непосредственно в вашей платформе данных с помощью планировщика заданий dbt.

Параметры​

Чтобы создать сохраненный запрос, обратитесь к следующей таблице параметров.

подсказка

Обратите внимание, что мы используем точечную нотацию (.), чтобы указать, является ли параметр вложенным в другой параметр. Например, query_params.metrics означает, что параметр metrics вложен в query_params.

(Версии dbt: v1.9 и новее)
ПараметрТипОбязательныйОписание
nameStringRequiredИмя объекта сохранённого запроса.
descriptionStringRequiredОписание сохранённого запроса.
labelStringRequiredОтображаемое имя для сохранённого запроса. Это значение будет показано в downstream‑инструментах.
configStringOptionalИспользуйте свойство config для задания конфигураций сохранённого запроса. Поддерживаются конфигурации cache, enabled, export_as, group, meta, tags и schema.
config.cache.enabledObjectOptionalОбъект с вложенным ключом, который используется для указания, должен ли сохранённый запрос заполнять cache. Принимает значение true или false. По умолчанию false.
limitIntegerOptionalМаксимальное количество строк, которое нужно вернуть.
order_byStringOptionalМетрики и group by, по которым нужно упорядочить запрос.
query_paramsStructureRequiredСодержит параметры запроса.
query_params.metricsList or StringOptionalСписок метрик, которые будут использоваться в запросе, в формате, соответствующем интерфейсу командной строки.
query_params.group_byList or StringOptionalСписок Entities и Dimensions, которые будут использоваться в запросе, включая Dimension или TimeDimension.
query_params.whereList or StringOptionalСписок строк, которые могут включать объекты Dimension или TimeDimension.
exportsList or StructureOptionalСписок экспортов, задаваемых внутри структуры exports.
exports.nameStringRequiredИмя объекта экспорта.
exports.configList or StructureRequiredСвойство config для задания параметров экспорта.
exports.config.export_asStringRequiredТип экспорта, который нужно выполнить. В настоящее время доступны варианты table или view, а в ближайшем будущем — cache.
exports.config.schemaStringOptionalSchema для создания таблицы или представления. Этот параметр нельзя использовать для кэширования.
exports.config.aliasStringOptionalAlias таблицы, используемый при записи таблицы или представления. Этот параметр нельзя использовать для кэширования.

Если вы используете несколько метрик в сохраненном запросе, то вы сможете ссылаться только на общие измерения, которые эти метрики разделяют в group_by или where выражениях. Используйте префикс имени сущности с объектом Dimension, например Dimension('user__ds').

Настройка сохраненного запроса​

Используйте сохранённые запросы (saved queries) для определения и управления общими запросами Semantic Layer в YAML, включая метрики и измерения. Сохранённые запросы позволяют организовывать и повторно использовать типовые запросы MetricFlow внутри проектов dbt. Например, вы можете группировать связанные метрики для более удобной структуры, а также включать часто используемые измерения и фильтры.

В конфигурации сохранённого запроса вы также можете использовать кэширование с планировщиком заданий dbt, чтобы кэшировать часто выполняемые запросы, повысить производительность и сократить затраты на вычисления.

В следующем примере вы можете задать сохраненный запрос в файле semantic_model.yml:

semantic_model.yml
(Версии dbt: v1.9 и новее)
saved_queries:
- name: test_saved_query
description: "{{ doc('saved_query_description') }}"
label: Test saved query
config:
cache:
enabled: true | false
tags: 'my_tag'
query_params:
metrics:
- simple_metric
group_by:
- "Dimension('user__ds')"
where:
- "{{ Dimension('user__ds', 'DAY') }} <= now()"
- "{{ Dimension('user__ds', 'DAY') }} >= '2023-01-01'"
exports:
- name: my_export
config:
export_as: table
alias: my_export_alias
schema: my_export_schema_name

Обратите внимание, что параметр export_as можно задать как для сохранённого запроса, так и в конфигурации экспорта config, при этом значение, указанное в конфигурации экспорта, имеет приоритет. Если какой‑либо ключ не задан в конфигурации экспорта, он будет унаследован из конфигурации сохранённого запроса.

Where выражение​

Используйте следующий синтаксис для ссылки на сущности, измерения, временные измерения или метрики в фильтрах и обратитесь к Метрики как измерения для получения подробной информации о том, как использовать метрики как измерения с фильтрами метрик:

filter: | 
{{ Entity('entity_name') }}

filter: |
{{ Dimension('primary_entity__dimension_name') }}

filter: |
{{ TimeDimension('time_dimension', 'granularity') }}

filter: |
{{ Metric('metric_name', group_by=['entity_name']) }}

Сохранённые запросы на уровне проекта​

Чтобы включить сохраненные запросы на уровне проекта, вы можете задать конфигурацию saved-queries в файле dbt_project.yml. Это сэкономит вам время на настройку сохраненных запросов в каждом файле:

dbt_project.yml
saved-queries:
my_saved_query:
+cache:
enabled: true

Для получения дополнительной информации о dbt_project.yml и соглашениях об именах конфигураций, см. страницу справки dbt_project.yml.

Чтобы собрать saved_queries:

Настройка экспортов​

После того как вы настроили сохранённый запрос и задали базовый блок, можно настроить экспорты в YAML-файле конфигурации saved_queries (в том же файле, где определены ваши метрики). Это также позволит автоматически запускать экспорты на вашей платформе данных с помощью планировщика заданий dbt.

После того как вы настроили сохранённый запрос и задали базовый блок, вы можете сконфигурировать экспорты в YAML‑файле конфигурации saved_queries (в том же файле, где находятся определения метрик). Это также позволит вам запускать экспорты автоматически внутри вашей платформы данных с помощью планировщика заданий .

Следующий пример показывает сохраненный запрос с экспортом:

semantic_model.yml
(Версии dbt: v1.9 и новее)
saved_queries:
- name: order_metrics
description: Relevant order metrics
config:
tags:
- order_metrics
query_params:
metrics:
- orders
- large_order
- food_orders
- order_total
group_by:
- Entity('order_id')
- TimeDimension('metric_time', 'day')
- Dimension('customer__customer_name')
- ... # Дополнительные group_by
where:
- "{{TimeDimension('metric_time')}} > current_timestamp - interval '1 week'"
- ... # Дополнительные where выражения
exports:
- name: order_metrics
config:
export_as: table # Доступные варианты: table, view
alias: my_export_alias # Необязательно — по умолчанию используется имя Export
schema: my_export_schema_name # Необязательно — по умолчанию используется схема деплоя

Запуск экспортов​

Настроив экспорты, вы можете пойти дальше и запускать их, чтобы автоматически записывать результаты сохранённых запросов на вашей платформе данных с помощью планировщика заданий dbt. Эта возможность доступна только при использовании Semantic Layer в dbt.

Для получения дополнительной информации о том, как запускать экспорты, обратитесь к документации Экспорты.

Часто задаваемые вопросы​

 Могу ли я иметь несколько экспортов в одном сохраненном запросе?
 Как я могу выбрать saved_queries по их типу ресурса?

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

0
Loading