Skip to content

Commit 1da80db

Browse files
authored
docs: Remove deprecated top-level includes in views from docs (#9171)
* Update deprecations * Update examples * Revert "Update deprecations" This reverts commit 1f3f600. * Fixes * Fix
1 parent 97af50e commit 1da80db

File tree

2 files changed

+48
-58
lines changed

2 files changed

+48
-58
lines changed

docs/pages/guides/recipes/access-control/controlling-access-to-cubes-and-views.mdx

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,15 @@ cubes:
5252
views:
5353
- name: total_revenue_per_customer
5454
public: {{ COMPILE_CONTEXT['securityContext']['isFinance'] }}
55-
includes:
56-
- orders.total_revenue
57-
- users.company
55+
56+
cubes:
57+
- join_path: orders
58+
includes:
59+
- total_revenue
60+
61+
- join_path: orders.users
62+
includes:
63+
- company
5864
```
5965
6066
```javascript
@@ -75,12 +81,25 @@ cube(`users`, {
7581
});
7682

7783
// total_revenue_per_customer.js
78-
view("total_revenue_per_customer", {
84+
view(`total_revenue_per_customer`, {
7985
description: `Total revenue per customer`,
8086
public: COMPILE_CONTEXT.securityContext.isFinance,
8187

82-
includes: [orders.total_revenue, users.company],
83-
});
88+
cubes: [
89+
{
90+
join_path: orders,
91+
includes: [
92+
`total_revenue`
93+
]
94+
},
95+
{
96+
join_path: orders.users,
97+
includes: [
98+
`company`
99+
]
100+
}
101+
]
102+
})
84103
```
85104

86105
</CodeTabs>

docs/pages/reference/data-model/view.mdx

Lines changed: 23 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -292,8 +292,20 @@ view(`arr`, {
292292
description: `Annual Recurring Revenue`,
293293
public: COMPILE_CONTEXT.security_context.is_finance,
294294

295-
includes: [revenue.arr, revenue.date, customers.plan],
296-
});
295+
cubes: [
296+
{
297+
join_path: revenue,
298+
includes: [
299+
`arr`,
300+
`date`
301+
]
302+
},
303+
{
304+
join_path: revenue.customers,
305+
includes: `plan`
306+
}
307+
]
308+
})
297309
```
298310

299311
```yaml
@@ -302,12 +314,15 @@ views:
302314
description: Annual Recurring Revenue
303315
public: COMPILE_CONTEXT.security_context.is_finance
304316

305-
includes:
306-
# Measures
307-
- revenue.arr
308-
# Dimensions
309-
- revenue.date
310-
- customers.plan
317+
cubes:
318+
- join_path: revenue
319+
includes:
320+
- arr
321+
- date
322+
323+
- join_path: revenue.customers
324+
includes:
325+
- plan
311326
```
312327
313328
</CodeTabs>
@@ -344,50 +359,6 @@ views:
344359

345360
The `access_policy` parameter is used to configure [data access policies][ref-ref-dap].
346361

347-
### `includes` (deprecated)
348-
349-
<WarningBox>
350-
351-
The top-level `includes` parameter is deprecated and might be removed in
352-
the future. Please always use the `includes` parameter with `cubes` and
353-
`join_path` parameters so you can explicitly control the join path.
354-
355-
</WarningBox>
356-
357-
The top-level `includes` parameter is used to bulk add measures or dimensions
358-
to a view.
359-
360-
<CodeTabs>
361-
362-
```javascript
363-
view(`active_users`, {
364-
includes: [
365-
// Measures
366-
users.rolling_count,
367-
368-
// Dimensions
369-
users.city,
370-
users.created_at,
371-
],
372-
});
373-
```
374-
375-
```yaml
376-
views:
377-
- name: active_users
378-
379-
includes:
380-
# Measures
381-
- users.rolling_count
382-
383-
# Dimensions
384-
- users.city
385-
- users.created_at
386-
```
387-
388-
</CodeTabs>
389-
390-
391362
[ref-recipe-control-access-cubes-views]:
392363
/guides/recipes/access-control/controlling-access-to-cubes-and-views
393364
[ref-schema-joins-direction]:

0 commit comments

Comments
 (0)