Includes

Overview

The includes and excludes properties control which measures, dimensions, and segments from a cube are exposed in a view. This enables creating focused interfaces that show only relevant data.

Basic Syntax

Include Specific Members

- join_path: orders
  includes:
    - count
    - total_revenue
    - status

Include All Members

- join_path: orders
  includes: "*"

Exclude Specific Members

- join_path: orders
  includes: "*"
  excludes:
    - internal_id
    - debug_flag

Member Types

All cube member types can be included:

- join_path: orders
  includes:
    # Measures
    - count
    - total_revenue
    - average_order_value

    # Dimensions
    - status
    - created_at
    - customer_email

    # Segments
    - completed
    - high_value

Renaming with Alias

Rename members to avoid collisions or improve clarity:

- join_path: orders
  includes:
    - name: count
      alias: order_count

    - name: created_at
      alias: order_date

Prefix Mode

Automatically prefix all members with cube name:

- join_path: orders
  prefix: true
  includes: "*"
  # count -> orders_count
  # status -> orders_status

Custom prefix:

- join_path: orders
  prefix: true
  includes:
    - name: count
      alias: total_orders  # Override automatic prefix

Combining Multiple Cubes

When including the same member name from multiple cubes, use aliases:

views:
  - name: combined_metrics
    cubes:
      - join_path: orders
        includes:
          - name: count
            alias: order_count

      - join_path: users
        includes:
          - name: count
            alias: user_count

Wildcard Patterns

Use "*" to include all, then exclude what you don't need:

- join_path: users
  includes: "*"
  excludes:
    - password_hash
    - api_secret
    - internal_notes

Best Practices

Be explicit — list specific members rather than using "*" in production
Use aliases — make member names clear and consistent
Exclude sensitive data — never expose passwords, keys, or PII
Document with descriptions — override descriptions for clarity