drill_queries - Measures

If a measure has drill_queries and drill_fields defined, drill_queries will override drill_fields.

Drill queries appear as options when you click to drill on a measure in a document. Providing drill queries is more flexible than a drill_fields set, as they allow you to specify the underlying query to drill. This includes changes such as limits, sorts, filters, and base views. Filters specified in a drill query are additive, meaning they will be applied in addition to any filters from the main query and the associated dimension values of the cell being drilled. If you want to reference fields from multiple views, ensure that a relationship exists between your base view and the other referenced views so that your drill down will render as expected. To get the structure + syntax of a query, build a query in a workbook and open up the inspector and scroll down to the “Query Structure” settings.

Syntax

<measure_name>:
  drill_queries:
    <Drill Query Label>:
      fields: [<field1>, <field2>, ...]
      base_view: <view_name>
      filters: {...}
      sorts: [...]
      limit: <number>
      vis_config: {...}

Properties

object[]

The name of the measure.

Hide measure_name properties

object

An object containing one or more drill query definitions, each with a human-readable label as the key.

Hide drill_queries properties

object[]

An object containing a drill query definition. Underscores are not required for drill query labels.

Hide Drill Query Label properties

string[]

An array of field names to include in the drill query.

string

The table that will act as the FROM clause of the query.

object

Optional filters to apply to the drill query using filter syntax.

string[]

Optional sort specifications. Note: Full scoping for fields is required.

number

Optional row limit for the drill query.

object

Opens the drill as a chart instead of a table. The vis_config syntax may change in a future release.

To set only the chart type, specify chartType, for example chartType: bar. Omni picks the other chart settings from the query results.
To use a fully configured chart, build the chart in a workbook, open the workbook inspector, and copy the YAML from the Vis Config section.

If the vis_config isn’t valid, the drill opens as a table. Users with model IDE access see a warning that names the invalid property.

Examples

Multiple drill options

my_fun_measure:
  sql: ${field_we_aggregate}
  aggregate_type: sum
  drill_queries:
    First Drill for Top 10:
      fields:
        [
        field_1,
        field_2
        ]
      base_view: view_name_1
      filters:
        is_top_10:
          is: true
      sorts:
        - field: view_name_1.field_1
        - field: view_name_1.field_2
          desc: true
    Customer Details:
      fields:
        [
        customer_name,
        customer_email,
        registration_date
        ]
      base_view: customers
      limit: 20
      sorts:
        - field: customers.registration_date
          desc: true

Drill query that opens as a bar chart

my_fun_measure:
  sql: ${field_we_aggregate}
  aggregate_type: sum
  drill_queries:
    Revenue by Category:
      fields:
        [
        orders.category,
        orders.total_revenue
        ]
      base_view: orders
      vis_config:
        chartType: bar

Getting started

Manage content

Analyze & build

Visualize & present

Deliver content

Model data

Manage integrations

drill_queries - Measures

Syntax

Properties

Examples

​Syntax

​Properties

​Examples

Syntax

Properties

Examples