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

# Extending cubes and views

> Use extends on cubes and views to inherit and merge members from a parent so shared measures, dimensions, joins, and includes stay defined once.

The `extends` parameter, supported for [cubes][ref-cube-extends] and
[views][ref-view-extends], allows you to create a *child* cube (or a view) that reuses
all declared members of a *parent* cube (or a view). This helps build reusable data models.

Cubes declare members such as measures, dimensions, and segments. When a child cube extends
the parent cube, lists of measures, dimensions, and segments are merged.
For example, if the parent cube defines the `a` measure and the child cube defines the `b`
measure, the resulting cube will have both measures `a` and `b`.

The usual pattern is to extract common measures, dimensions, and joins into
the parent cube and then extend from it. This helps prevent code duplication
and makes code easier to maintain and refactor.

In the example below, the `base_events` cube defines the common events measures,
dimensions, and a join to the `users` cube:

```yaml title="YAML" theme={"dark"}
cubes:
  - name: base_events
    sql_table: events

    joins:
      - name: users
        relationship: many_to_one
        sql: "{CUBE}.user_id = {users.id}"

    measures:
      - name: count
        type: count

    dimensions:
      - name: timestamp
        sql: time
        type: time
```

```javascript title="JavaScript" theme={"dark"}
cube(`base_events`, {
  sql_table: `events`,

  joins: {
    users: {
      relationship: `many_to_one`,
      sql: `${CUBE}.user_id = ${users.id}`
    }
  },

  measures: {
    count: {
      type: `count`
    }
  },

  dimensions: {
    timestamp: {
      sql: `time`,
      type: `time`
    }
  }
})
```

> [!NOTE]
>
> It’s important to use the \[`CUBE` variable]\[ref-cube-variable] when referencing members
> and columns of the cube. Not specifying the cube name or using `${base_events}` does not
> work when the cube is extended.

The `product_purchases` and `page_views` cubes are extended from `base_events`
and define only the specific dimensions: `product_name` for product purchases
and `page_path` for page views.

```yaml title="YAML" theme={"dark"}
cubes:
  - name: product_purchases
    sql_table: product_purchases
    extends: base_events

    dimensions:
      - name: product_name
        sql: product_name
        type: string

  - name: page_views
    sql_table: page_views
    extends: base_events

    dimensions:
      - name: page_path
        sql: page_path
        type: string
```

```javascript title="JavaScript" theme={"dark"}
cube(`product_purchases`, {
  sql_table: `product_purchases`,
  extends: base_events,

  dimensions: {
    product_name: {
      sql: `product_name`,
      type: `string`
    }
  }
})

cube(`page_views`, {
  sql_table: `page_views`,
  extends: base_events,

  dimensions: {
    page_path: {
      sql: `page_path`,
      type: `string`
    }
  }
})
```

## Extending views

A child view that extends a parent view gets these items from the parent view:

* The [`cubes`][ref-view-cubes] includes. The child view's own `cubes` items are
  added to them.
* The view's own [measures][ref-view-measures] and
  [dimensions][ref-view-dimensions], defined on the parent view.
* The [folders][ref-view-folders]. The child view's own folders are added to
  them.
* The [access policies][ref-view-access-policy]. The child view's own policies
  are added to them; they do not replace the parent's.
* Each other parameter that the child view does not set, such as `public` and
  `description`.

In the example below, `sales_overview` gets `orders_total_amount`,
`orders_count` and `average_order_value` from `orders_base`, and adds
`orders_status`:

```yaml title="YAML" theme={"dark"}
views:
  - name: orders_base
    public: false

    cubes:
      - join_path: orders
        prefix: true
        includes:
          - total_amount
          - count

    measures:
      - name: average_order_value
        type: number
        sql: "{CUBE.orders_total_amount} / NULLIF({CUBE.orders_count}, 0)"

  - name: sales_overview
    extends: orders_base
    public: true

    cubes:
      - join_path: orders
        prefix: true
        includes:
          - status
```

```javascript title="JavaScript" theme={"dark"}
view(`orders_base`, {
  public: false,

  cubes: [
    {
      join_path: orders,
      prefix: true,
      includes: [`total_amount`, `count`]
    }
  ],

  measures: {
    average_order_value: {
      type: `number`,
      sql: `${CUBE.orders_total_amount} / NULLIF(${CUBE.orders_count}, 0)`
    }
  }
})

view(`sales_overview`, {
  extends: orders_base,
  public: true,

  cubes: [
    {
      join_path: orders,
      prefix: true,
      includes: [`status`]
    }
  ]
})
```

A child view cannot remove an inherited member. To reuse a multi-fact measure
that only a view defines, and for the limits of view inheritance, see [Reusing a
view measure across views][ref-recipe-reuse-view-measures].

## Usage with `FILTER_PARAMS`

If the parent cube is using [`FILTER_PARAMS`][ref-schema-ref-cube-filter-params]
in any `sql` parameter, then child cubes can accomodate to that in two ways.

First, the `sql` parameter can be overridden in each child cube:

```yaml title="YAML" theme={"dark"}
cubes:
  - name: product_purchases
    sql: |
      SELECT *
      FROM events
      WHERE {FILTER_PARAMS.product_purchases.timestamp.filter('time')}

    # ...
```

```javascript title="JavaScript" theme={"dark"}
cube(`product_purchases`, {
  sql: `
    SELECT *
    FROM events
    WHERE ${FILTER_PARAMS.product_purchases.timestamp.filter("time")}
  `,

  // ...
})
```

Alternatively, all filters can be put inside the parent cube and referenced
in the child cubes using `AND`. The unused filters will be rendered to `1 = 1`
in the SQL query:

```yaml title="YAML" theme={"dark"}
cubes:
  - name: base_events
    sql: |
      SELECT *
      FROM events
      WHERE
        {FILTER_PARAMS.base_events.timestamp.filter('time')} AND
        {FILTER_PARAMS.product_purchases.timestamp.filter('time')} AND
        {FILTER_PARAMS.page_views.timestamp.filter('time')}

    # ...
```

```javascript title="JavaScript" theme={"dark"}
cube(`base_events`, {
  sql: `
    SELECT *
    FROM events
    WHERE
      {$FILTER_PARAMS.base_events.timestamp.filter('time')} AND
      {$FILTER_PARAMS.product_purchases.timestamp.filter('time')} AND
      {$FILTER_PARAMS.page_views.timestamp.filter('time')}
  `,

  // ...
})
```

[ref-cube-extends]: https://docs.cube.dev/reference/data-modeling/cube.md#extends

[ref-view-extends]: https://docs.cube.dev/reference/data-modeling/view.md#extends

[ref-view-cubes]: https://docs.cube.dev/reference/data-modeling/view.md#cubes

[ref-view-measures]: https://docs.cube.dev/reference/data-modeling/view.md#measures

[ref-view-dimensions]: https://docs.cube.dev/reference/data-modeling/view.md#dimensions

[ref-view-folders]: https://docs.cube.dev/reference/data-modeling/view.md#folders

[ref-view-access-policy]: https://docs.cube.dev/reference/data-modeling/view.md#access_policy

[ref-recipe-reuse-view-measures]: https://docs.cube.dev/recipes/data-modeling/reusing-view-measures.md

[ref-schema-ref-cube-filter-params]: https://docs.cube.dev/reference/data-modeling/context-variables.md#filter_params

[ref-cube-variable]: https://docs.cube.dev/docs/data-modeling/concepts/syntax.md#cube-variable


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.