Dimensions

You can use the dimensions parameter within cubes to define dimensions. You can think about a dimension as an attribute related to a measure, e.g. the measure user_count can have dimensions like country, age, occupation, etc. Any dimension should have the following parameters: name, sql, and type. Dimensions can be also organized into hierarchies.

Parameters

`name`

The name parameter serves as the identifier of a dimension. It must be unique among all dimensions, measures, and segments within a cube and follow the naming conventions.

cubes:
  - name: products

    dimensions:
      - name: price
        sql: price
        type: number

      - name: brand_name
        sql: brand_name
        type: string

`case`

The case statement is used to define dimensions based on SQL conditions. The when parameters declares a series of sql conditions and labels that are returned if the condition is truthy. The else parameter declares the default label that would be returned if there’s no truthy sql condition. The following example will create a size dimension with values xl, xxl, and Unknown:

cubes:
  - name: products
    # ...

    dimensions:
      - name: size
        type: string
        case:
          when:
            - sql: "{CUBE}.size_value = 'xl-en'"
              label: xl
            - sql: "{CUBE}.size_value = 'xl'"
              label: xl
            - sql: "{CUBE}.size_value = 'xxl-en'"
              label: xxl
            - sql: "{CUBE}.size_value = 'xxl'"
              label: xxl
          else:
            label: Unknown

The label property can be defined dynamically as an object with a sql property in JavaScript models:

cube(`products`, {
  // ...

  dimensions: {
    size: {
      type: `string`,
      case: {
        when: [
          {
            sql: `${CUBE}.meta_value = 'xl-en'`,
            label: { sql: `${CUBE}.english_size` }
          },
          {
            sql: `${CUBE}.meta_value = 'xl'`,
            label: { sql: `${CUBE}.euro_size` }
          },
          {
            sql: `${CUBE}.meta_value = 'xxl-en'`,
            label: { sql: `${CUBE}.english_size` }
          },
          {
            sql: `${CUBE}.meta_value = 'xxl'`,
            label: { sql: `${CUBE}.euro_size` }
          }
        ],
        else: { label: `Unknown` }
      }
    }
  }
})

`title`

You can use the title parameter to change a dimension’s displayed name. By default, Cube will humanize your dimension key to create a display name. In order to override default behavior, please use the title property:

cubes:
  - name: products
    # ...

    dimensions:
      - name: meta_value
        title: Size
        sql: meta_value
        type: string

`description`

This parameter provides a human-readable description of a dimension. When applicable, it will be displayed in Playground and exposed to data consumers via APIs and integrations.

cubes:
  - name: products
    # ...

    dimensions:
      - name: comment
        description: Comments for orders
        sql: comments
        type: string

`public`

The public parameter is used to manage the visibility of a dimension. Valid values for public are true and false. When set to false, this dimension cannot be queried through the API. Defaults to true.

cubes:
  - name: products
    # ...

    dimensions:
      - name: comment
        sql: comment
        type: string
        public: false

`format`

format is an optional parameter. It controls how dimension values are displayed to data consumers. The available formats depend on the dimension type. For string dimensions:

Format	Description
`imageUrl`	Display the value as an image
`link`	Display the value as a hyperlink

For number dimensions, you can use the same named formats and custom d3-format specifiers as measures:

Format	Description	Example	Output
`number` / `number_N`	Grouped fixed-point	`number`	1,234.57
`percent` / `percent_N`	Percentage	`percent_1`	12.5%
`currency` / `currency_N`	Currency with grouping	`currency_0`	$1,235
`abbr` / `abbr_N`	SI prefix (K, M, G, …)	`abbr`	1.2K
`accounting` / `accounting_N`	Negatives in parentheses	`accounting_2`	(1,234.57)
`id`	Raw integer, no grouping	`id`	12345

For time dimensions, you can use POSIX strftime format strings with d3-time-format extensions (e.g., %Y-%m-%d %H:%M:%S).

cubes:
  - name: orders
    # ...

    dimensions:
      - name: total
        sql: amount
        type: number
        format: currency

      - name: image
        sql: "CONCAT('https://img.example.com/id/', {id})"
        type: string
        format: imageUrl

      - name: order_link
        sql: "'http://mywebsite.com/orders/' || id"
        type: string
        format: link

      - name: crm_link
        sql: "'https://na1.salesforce.com/' || id"
        type: string
        format:
          label: View in Salesforce
          type: link

      - name: created_at
        sql: created_at
        type: time
        format: "%Y-%m-%d %H:%M:%S"

Common time format examples:

Format string	Example output
`%m/%d/%Y %H:%M`	12/04/2025 14:30
`%Y-%m-%d %H:%M:%S`	2025-12-04 14:30:00
`%B %d, %Y`	December 04, 2025
`%b %d, %Y`	Dec 04, 2025
`%I:%M %p`	02:30 PM
`%A, %B %d`	Thursday, December 04
`Q%q %Y`	Q4 2025
`Week %V, %Y`	Week 49, 2025

`currency`

The optional currency parameter specifies the ISO 4217 currency code for a number-type dimension. Use it alongside format: currency to indicate which currency the values represent. The value is a 3-letter currency code (e.g., USD, EUR, GBP) and is case-insensitive.

cubes:
  - name: orders
    # ...

    dimensions:
      - name: price
        sql: price
        type: number
        format: currency
        currency: EUR

The currency parameter can only be used with dimensions of type number. Using it with other dimension types will result in a validation error.

`links`

The links parameter allows you to define links associated with a dimension. They can be rendered as HTML links by supporting tools, e.g., Workbooks. Links are useful to let users navigate to related external resources (e.g., Google search), internal tools (e.g., Salesforce), or other pages in a BI tool. Each link must have a label and a url. The url is a SQL expression that constructs the link URL. It can reference column and dimension values, just like the sql parameter or mask parameter. Optionally, a link might use the icon parameter to reference an icon from a supported icon set to be displayed alongside the link label. Optionally, a link might use the target parameter to specify where to open it: blank (default) to open in a new tab/window or self to open in the same tab/window.

cubes:
  - name: users

    dimensions:
      # Definitions of dimensions such as `email`, etc.

      - name: full_name
        sql: full_name
        type: string
        links:
          - label: Search on Google
            url: "CONCAT('https://www.google.com/search?q=', {CUBE}.full_name)"
            icon: brand-google
            target: blank
          
          - label: Search in Salesforce
            url: "CONCAT('https://your-company.salesforce.com/search/results/?q=', {email})"
            target: blank

          - label: Write an email
            url: "CONCAT('mailto:', {email})"
            icon: send

`params`

The optional params parameter can be used to add additional query parameters to the URL. It accepts a map of key-value pairs, where keys are parameter names and values are parameter values. Values in params can reference columns and dimension values. Additionally, values in params can reference filters applied to the current query using the FILTER_PARAMS context variable. Conveniently, the propagate_filters_to_params parameter, true by default, can be used to pass all filters from the current query as an additional parameter. Filters will use the same format as the filters query parameter in the REST API. The param_name_for_filters parameter, filters by default, can be used to customize the name of this additional parameter. All parameter keys and values will be URL-encoded when the full URL is constructed.

cubes:
  - name: users

    dimensions:
      # Definitions of dimensions such as `id`, `country`, etc.

      - name: full_name
        sql: full_name
        type: string
        links:
          - label: Check performance dashboard
            url: "'https://my-account.cubecloud.dev/new/d/123/dashboards/KSqDYdUz6Ble'"
            params:
              # Pass dimension values as query parameters
              filter_user_id: "{id}"
              # Pass filters from the current query as query parameters
              filter_country: "{FILTER_PARAMS.users.country}"
              # Pass additional parameters, if needed
              utm_source: cube

          - label: Check another dashboard
            url: "'https://my-account.cubecloud.dev/new/d/456/dashboards/iuZjHd8h5mKLe'"
            # Don't pass any filters from the current query
            propagate_filters_to_params: false

          - label: Check one more dashboard
            url: "'https://my-account.cubecloud.dev/new/d/456/dashboards/iuZjHd8h5mKLe'"
            # Pass all filters from the current query as the `my_precious_filters` query parameter
            param_name_for_filters: my_precious_filters

Each link will be rendered as an additional synthetic dimension in the result set, with the following naming convention, where <id> is a zero-based index of the link in the links array:

<dimension_name>___link_<id>_url

All references in link URLs and parameters must resolve to a single value for a given value of the dimension on which the link is defined. Otherwise, it will result in duplicate rows in the result set.

`meta`

The meta parameter allows you to attach arbitrary information to a dimension. It can be consumed and interpreted by supporting tools. You can also use the ai_context key to provide context to the AI agent without exposing it in the user interface.

cubes:
  - name: products
    # ...

    dimensions:
      - name: users_count
        sql: "{users.count}"
        type: number
        meta:
          any: value
          ai_context: >
            This is a subquery dimension. Use it to get the
            number of users associated with each product.

`order`

The order parameter specifies the default sort order for a dimension. Valid values are asc (ascending) and desc (descending). This parameter is optional. When set, the dimension’s default sort order is exposed via APIs and integrations. Consuming applications, such as BI tools and custom frontends, can use this metadata to apply consistent default sorting when displaying dimension values, ensuring a uniform user experience across different tools connected to the semantic layer.

cubes:
  - name: orders
    # ...

    dimensions:
      - name: status
        sql: status
        type: string
        order: asc

      - name: created_at
        sql: created_at
        type: time
        order: desc

`primary_key`

Specify if a dimension is a primary key for a cube. The default value is false. A primary key is used to make joins work properly.

Setting primary_key to true will change the default value of the public parameter to false. If you still want public to be true, set it explicitly.

cubes:
  - name: products
    # ...

    dimensions:
      - name: id
        sql: id
        type: number
        primary_key: true

It is possible to have more than one primary key dimension in a cube if you’d like them all to be parts of a composite key:

cubes:
  - name: products
    sql: |
      SELECT 1 AS column_a, 1 AS column_b UNION ALL
      SELECT 2 AS column_a, 1 AS column_b UNION ALL
      SELECT 1 AS column_a, 2 AS column_b UNION ALL
      SELECT 2 AS column_a, 2 AS column_b

    dimensions:
      - name: composite_key_a
        sql: column_a
        type: number
        primary_key: true

      - name: composite_key_b
        sql: column_b
        type: number
        primary_key: true

    measures:
      - name: count
        type: count

Querying the count measure of the cube shown above will generate the following SQL to the upstream data source:

SELECT
  count(
    CAST("product".column_a as TEXT) || CAST("product".column_b as TEXT)
  ) "product__count"
FROM (
  SELECT 1 AS column_a, 1 AS column_b UNION ALL
  SELECT 2 AS column_a, 1 AS column_b UNION ALL
  SELECT 1 AS column_a, 2 AS column_b UNION ALL
  SELECT 2 AS column_a, 2 AS column_b
) AS "product"

`propagate_filters_to_sub_query`

When this statement is set to true, the filters applied to the query will be passed to the subquery.

cubes:
  - name: products
    # ...

    dimensions:
      - name: users_count
        sql: "{users.count}"
        type: number
        sub_query: true
        propagate_filters_to_sub_query: true

`sql`

sql is a required parameter. It can take any valid SQL expression depending on the type of the dimension. Please refer to the [Dimension Types][ref-schema-ref-dims-types] to understand what the sql parameter should be for a given dimension type.

cubes:
  - name: orders
    # ...

    dimensions:
      - name: created_at
        sql: created_at
        type: time

`mask`

The optional mask parameter defines the replacement value used when the dimension is masked by a data masking access policy. The mask can be a static value (number, boolean, or string) or a SQL expression:

cubes:
  - name: orders
    # ...

    dimensions:
      - name: secret_code
        sql: secret_code
        type: string
        mask:
          sql: "CONCAT('***', RIGHT({CUBE}.secret_code, 3))"

      - name: revenue
        sql: revenue
        type: number
        mask: -1

If no mask is defined, the default mask value is NULL. See data masking for more details.

`sub_query`

The sub_query statement allows you to reference a measure in a dimension. It’s an advanced concept and you can learn more about it here.

cubes:
  - name: products
    # ...

    dimensions:
      - name: users_count
        sql: "{users.count}"
        type: number
        sub_query: true

`type`

type is a required parameter. There are various types that can be assigned to a dimension. A dimension can only have one type.

Type	Description
`time`	Timestamp column for time series data. The target column should be `TIMESTAMP`; cast other temporal types in `sql`. See this recipe for string-based datetimes.
`string`	Text fields containing letters or special characters.
`number`	Numeric or integer fields.
`boolean`	Boolean fields or data coercible to boolean.
`switch`	Predefined set of allowed values (enum-like). Useful for `case` measures. Tesseract only.
`geo`	Geographic coordinates. Requires `latitude` and `longitude` sub-parameters instead of `sql`.

switch dimensions are powered by Tesseract, the next-generation data modeling engine. Tesseract is currently in preview. Use the CUBEJS_TESSERACT_SQL_PLANNER environment variable to enable it.

cubes:
  - name: orders
    # ...

    dimensions:
      - name: completed_at
        sql: completed_at
        type: time

      - name: full_name
        sql: "CONCAT({first_name}, ' ', {last_name})"
        type: string

      - name: amount
        sql: amount
        type: number

      - name: is_enabled
        sql: is_enabled
        type: boolean

      - name: location
        type: geo
        latitude:
          sql: "{CUBE}.latitude"
        longitude:
          sql: "{CUBE}.longitude"

`synthetic`

The synthetic parameter can’t be set by a user directly. It is used to mark dimensions that are automatically created by Cube, e.g., for links. You can check if a dimension is synthetic via the /v1/meta API endpoint.

`granularities`

By default, the following granularities are available for time dimensions: year, quarter, month, week (starting on Monday), day, hour, minute, second. You can use the granularities parameter with any dimension of the type time to define one or more custom granularities, such as a week starting on Sunday or a fiscal year.

See this recipe for more custom granularity examples.

Custom granularities are supported for the following data sources: Amazon Athena, Amazon Redshift, DuckDB, Databricks, Google BigQuery, ClickHouse, Microsoft SQL Server, MySQL, Postgres, and Snowflake. Please file an issue if you need support for another data source.

For each custom granularity, the interval parameter is required. It specifies the duration of the time interval and has the following format: quantity unit [quantity unit...], e.g., 5 days or 1 year 6 months. Optionally, a custom granularity might use the offset parameter to specify how the time interval is shifted forward or backward in time. It has the same format as interval, however, you can also provide negative quantities, e.g., -1 day or 1 month -10 days. Alternatively, instead of offset, you can provide the origin parameter. When origin is provided, time intervals will be shifted in a way that one of them will match the provided origin. It accepts an ISO 8601-compliant date time string, e.g., 2024-01-02 or 2024-01-02T12:00:00.000Z. Optionally, a custom granularity might have the title parameter with a human-friendly description.

cubes:
  - name: orders
    sql: |
      SELECT '2025-01-01T00:12:00.000Z'::TIMESTAMP AS time UNION ALL
      SELECT '2025-02-01T00:15:00.000Z'::TIMESTAMP AS time UNION ALL
      SELECT '2025-03-01T00:18:00.000Z'::TIMESTAMP AS time

    dimensions:
      - name: time
        sql: time
        type: time

        granularities:
          - name: quarter_hour
            interval: 15 minutes

          - name: week_starting_on_sunday
            interval: 1 week
            offset: -1 day

          - name: fiscal_year_starting_on_april_01
            title: Corporate and government fiscal year in the United Kingdom
            interval: 1 year
            origin: "2025-04-01"
            # You have to use quotes here to make `origin` a valid YAML string 

`time_shift`

The time_shift parameter allows overriding the time shift behavior for time dimensions within calendar cubes. Such time shifts can be referenced in time-shift measures of other cubes, enabling the use of custom calendars. The time_shift parameter can only be set on time dimensions within calendar cubes, i.e., cubes where the calendar parameter is set to true. The time_shift parameter accepts an array of time shift definitions. Each definition can include time_dimension, type, interval, and name parameters, similarly to the time_shift parameter of time-shift measures. Additionally, you can use the sql parameter to define a custom time mapping using a SQL expression.

cubes:
  - name: fiscal_calendar
    calendar: true
    sql: >
      SELECT
        date_key,
        calendar_date,
        fiscal_date_prior_year,
        fiscal_date_next_quarter
      FROM calendar_table

    dimensions:
      - name: date_key
        sql: date_key
        type: time
        primary_key: true

      - name: date
        sql: calendar_date
        type: time
        time_shift:
          - name: prior_calendar_year
            type: prior
            interval: 1 year

          - name: next_calendar_quarter
            type: next
            interval: 1 quarter

          - name: prior_fiscal_year
            sql: "{CUBE}.fiscal_date_prior_year"

          - name: next_fiscal_quarter
            sql: "{CUBE}.fiscal_date_next_quarter"

Data Modeling

Configuration

Core Data APIs

Embed APIs

Other APIs

JavaScript SDK

Dimensions

Parameters

`name`

`case`

`title`

`description`

`public`

`format`

`currency`

`links`

`params`

Dimensions

`meta`

`order`

`primary_key`

`propagate_filters_to_sub_query`

`sql`

`mask`

`sub_query`

`type`

`synthetic`

`granularities`

`time_shift`

Data Modeling

Configuration

Core Data APIs

Embed APIs

Other APIs

JavaScript SDK

Documentation Index

​Parameters

​name

​case

​title

​description

​public

​format

​currency

​links

​params

​Dimensions

​meta

​order

​primary_key

​propagate_filters_to_sub_query

​sql

​mask

​sub_query

​type

​synthetic

​granularities

​time_shift

Parameters

`name`

`case`

`title`

`description`

`public`

`format`

`currency`

`links`

`params`

Dimensions

`meta`

`order`

`primary_key`

`propagate_filters_to_sub_query`

`sql`

`mask`

`sub_query`

`type`

`synthetic`

`granularities`

`time_shift`