Skip to content

Commit

Permalink
docs: describe additional meta params for MDX API (#8690)
Browse files Browse the repository at this point in the history
* update

* update
  • Loading branch information
MikeNitsenko committed Sep 10, 2024
1 parent 7a7c8cb commit 70ff901
Showing 1 changed file with 64 additions and 1 deletion.
65 changes: 64 additions & 1 deletion docs/pages/product/apis-integrations/mdx-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,72 @@ views:
- city
```
### Dimension keys
You can define a member that will be used as a key for a dimension in the cube's model file.
```yaml
cubes:
- name: users
sql_table: USERS
public: false

dimensions:
- name: id
sql: "{CUBE}.ID"
type: number
primary_key: true

- name: first_name
sql: FIRST_NAME
type: string
meta:
key_member: users_id
```
### Dimension labels
You can define a member that will be used as a label for a dimension in the cube's model file.
```yaml
cubes:
- name: users
sql_table: USERS
public: false

dimensions:
- name: id
sql: "{CUBE}.ID"
type: number
meta:
label_member: users_first_name
```
### Custom properties
You can define custom properties for dimensions in the cube's model file.
```yaml
cubes:
- name: users
sql_table: USERS
public: false

dimensions:
- name: id
sql: "{CUBE}.ID"
type: number
meta:
properties:
- name: "Property A"
column: users_first_name
- name: "Property B"
value: users_city
```
### Measure groups
MDX API supports organizing measures into groups (folders). You can define measure groups in the view's schema file.
MDX API supports organizing measures into groups (folders). You can define measure groups in the view's model file.
```yaml
views:
Expand Down

0 comments on commit 70ff901

Please sign in to comment.