Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 47 additions & 19 deletions docs/pages/reference/data-model/view.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,14 @@ view(`orders`, {
includes: [
{
name: `name`,
alias: `product`
alias: `product`,
title: `My custom product`,
description: `My custom product description`,
format: `number`,
meta: {
some: `custom`,
meta: `data`
}
}
]
},
Expand Down Expand Up @@ -120,21 +127,18 @@ views:
includes:
- name: name
alias: product
title: My custom product
description: My custom product description
format: number
meta:
some: custom
meta: data

- join_path: base_orders.users
prefix: true
includes: "*"
excludes:
- company









```

</CodeTabs>
Expand All @@ -154,19 +158,38 @@ to list measures, dimensions, or segments you'd like to include into the view.

To include all members from a cube, use the _includes all_ shorthand: `includes: "*"`.
In that case, you can also use the `excludes` parameter to list members that
you'd like to exclude.
you'd like to exclude.

#### `prefix`

If you'd like to prefix exposed members with the cube name, you can do so by setting the
`prefix` parameter to `true`. It will prefix members with the cube name, e.g. `users_city`.
You can use the [`alias` parameter](#alias) to specify a custom prefix.

#### `alias`

Optionally, in case you need to rename some of included members, you can provide
`name` and `alias` parameters.
If you'd like to [rename][ref-dim-name] an included member, you can use the `alias`
parameter.

#### `prefix`
#### `title`

If you'd like to override the [title][ref-dim-title] of a member, you can use the
`title` parameter.

#### `description`

If you'd like to override the [description][ref-dim-description] of a member, you
can use the `description` parameter.

#### `format`

If you'd like to override the [format][ref-dim-format] of a member, you can use the
`format` parameter.

#### `meta`

Optionally, if you'd like to prefix exposed measures, dimensions, or segments
with the cube name, you can use the `prefix: true` parameter. It will prefix
them with the cube name, e.g. `users_city`. You can use the `alias` parameter to
specify a custom prefix.
If you'd like to override the [metadata][ref-dim-meta] of a member, you can use the
`meta` parameter. Note that the `meta` is overridded as a whole.

### `folders`

Expand Down Expand Up @@ -369,4 +392,9 @@ The `access_policy` parameter is used to configure [data access policies][ref-re
[ref-ref-dap]: /reference/data-model/data-access-policies
[ref-apis-support]: /product/apis-integrations#data-modeling
[ref-playground]: /product/workspace/playground#viewing-the-data-model
[ref-viz-tools]: /product/configuration/visualization-tools
[ref-viz-tools]: /product/configuration/visualization-tools
[ref-dim-name]: /reference/data-model/dimensions#name
[ref-dim-title]: /reference/data-model/dimensions#title
[ref-dim-description]: /reference/data-model/dimensions#description
[ref-dim-format]: /reference/data-model/dimensions#format
[ref-dim-meta]: /reference/data-model/dimensions#meta