query - Views - Omni Docs

Defines a view from a workbook query.

For an easier building experience, build your query view using the workbook and then promote it to the shared model.

Syntax

query:
  fields:
    <view_name>.<field_name>
    <view_name>.<field_name>: <optional_alias>
  base_view: <view_name>
  filters: [ ... ]

Properties

object

An object containing query sub-parameters.

Hide query properties

array

Fields to include in the query, specified as view_name.field_name. To alias fields, specify as view_name.field_name: alias.

string

The view to use as the base for the query.

object

Filters to apply to the query, specified using filter syntax.

Examples

In this example, query.fields contains aliased fields - that is, the string after the colon defines the alias. For example, created_at. The dimensions.sales field is an example of a field that was not aliased.

Example with aliased fields

query:
  fields:
    order_items.created_at[date]: created_at
    order_items.user_id: user_id
    order_items.total_sales
  filters:
    orders.amount_returns:
      not: 0
  base_view: order_items

dimensions:
  created_at:
    timeframes: [date]
    sql: created_at
  user_id:
    sql: user_id
  sales:
    sql: order_items__total_sales

⌘I

Getting started

Manage content

Analyze & build

Visualize & present

Deliver content

Model data

Manage integrations

query - Views

Syntax

Properties

Examples

​Syntax

​Properties

​Examples

Syntax

Properties

Examples