> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.

# drill_fields

> Enables hierarchical drilling inside a row of the result set.

Drill fields allow for hierarchical drilling inside a row of the result set. Dimensional drill retains the table structure, but adds the dimensions as filters and swaps the dimensions for the drill fields.

<img src="https://mintcdn.com/omni-e7402367/6ikujnGo2ytdwGbR/images/docs/modeling/assets/images/dimension_drill-3882cb3264f66c5df41952a226a50c5b.png?fit=max&auto=format&n=6ikujnGo2ytdwGbR&q=85&s=57cd6ac86df59f7f5f55d62ea224ab52" alt="Dimension drill example" width="654" height="424" data-path="images/docs/modeling/assets/images/dimension_drill-3882cb3264f66c5df41952a226a50c5b.png" />

Setting this parameter with an empty value (`drill_fields: []`) removes the drill from the dimension. You can also remove drilling in workbooks by hovering over a field in the field picker, clicking <Icon icon="ellipsis-vertical" iconType="solid" />, and selecting **Edit**.

## Syntax

```yaml theme={null}
<dimension_name>:
  drill_fields: [<field_1>, <field_2>, ...]
```

## Properties

<ParamField path="dimension_name" type="object">
  The name of the dimension. Dimension names must:

  * Be unique within the view
  * Start with a letter
  * Contain only alphanumeric characters and underscores

  <Expandable title="dimension_name properties" defaultOpen="true">
    <ParamField path="drill_fields" type="array">
      An array of field names that will be displayed when drilling into this dimension. An empty value (`[]`) removes the drill from the dimension.
    </ParamField>
  </Expandable>
</ParamField>

## Examples

```yaml title="Geographic drill-down" theme={null}
country:
  drill_fields: [state]
```

```yaml title="Timeframe drill with metadata" theme={null}
created_at:
  timeframe_metadata:
    year:
      drill_fields: [state]
      group_label: Created At
```

```yaml title="Remove drill capability" theme={null}
category:
  drill_fields: []
```
