Skip to content

Commit 70ff901

Browse files
authored
docs: describe additional meta params for MDX API (#8690)
* update * update
1 parent 7a7c8cb commit 70ff901

File tree

1 file changed

+64
-1
lines changed

1 file changed

+64
-1
lines changed

docs/pages/product/apis-integrations/mdx-api.mdx

Lines changed: 64 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,72 @@ views:
5050
- city
5151
```
5252
53+
### Dimension keys
54+
55+
You can define a member that will be used as a key for a dimension in the cube's model file.
56+
57+
```yaml
58+
cubes:
59+
- name: users
60+
sql_table: USERS
61+
public: false
62+
63+
dimensions:
64+
- name: id
65+
sql: "{CUBE}.ID"
66+
type: number
67+
primary_key: true
68+
69+
- name: first_name
70+
sql: FIRST_NAME
71+
type: string
72+
meta:
73+
key_member: users_id
74+
```
75+
76+
### Dimension labels
77+
78+
You can define a member that will be used as a label for a dimension in the cube's model file.
79+
80+
```yaml
81+
cubes:
82+
- name: users
83+
sql_table: USERS
84+
public: false
85+
86+
dimensions:
87+
- name: id
88+
sql: "{CUBE}.ID"
89+
type: number
90+
meta:
91+
label_member: users_first_name
92+
```
93+
94+
### Custom properties
95+
96+
You can define custom properties for dimensions in the cube's model file.
97+
98+
```yaml
99+
cubes:
100+
- name: users
101+
sql_table: USERS
102+
public: false
103+
104+
dimensions:
105+
- name: id
106+
sql: "{CUBE}.ID"
107+
type: number
108+
meta:
109+
properties:
110+
- name: "Property A"
111+
column: users_first_name
112+
- name: "Property B"
113+
value: users_city
114+
```
115+
53116
### Measure groups
54117
55-
MDX API supports organizing measures into groups (folders). You can define measure groups in the view's schema file.
118+
MDX API supports organizing measures into groups (folders). You can define measure groups in the view's model file.
56119
57120
```yaml
58121
views:

0 commit comments

Comments
 (0)