Skip to content

Commit d491eb9

Browse files
committed
docs(rest): document measureFilter operator
1 parent de76a48 commit d491eb9

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

docs/content/API-Reference/Query-Format.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,8 @@ The opposite operator of `contains`. It supports multiple values.
206206
}
207207
```
208208

209-
This opertor adds `IS NULL` check to include `NULL` values unless you add `null` to `values`.
210-
For example:
209+
This opertor adds `IS NULL` check to include `NULL` values unless you add `null`
210+
to `values`. For example:
211211

212212
```javascript
213213
{
@@ -449,6 +449,26 @@ The same as `beforeDate`, but is used to get all results after a specific date.
449449
}
450450
```
451451

452+
### <--{"id" : "Filters Operators"}--> measureFilter
453+
454+
The `measureFilter` operator is used to apply an existing measure's filters to
455+
the current query.
456+
457+
This usually happens when you call
458+
[`ResultSet.drilldown()`][ref-client-core-resultset-drilldown], which will
459+
return a query for the drill members. If the original query has a filter on a
460+
measure, that filter will be added as otherwise the drilldown query will lose
461+
that context.
462+
463+
- Applied to measures.
464+
465+
```json
466+
{
467+
"member": "Orders.count",
468+
"operator": "measureFilter"
469+
}
470+
```
471+
452472
## Boolean logical operators
453473

454474
Filters can contain `or` and `and` logical operators. Logical operators have
@@ -497,14 +517,12 @@ provides a convenient shortcut to pass a dimension and a filter as a
497517
`YYYY-MM-DDTHH:mm:ss.SSS` format. Values should always be local and in query
498518
`timezone`. Dates in `YYYY-MM-DD` format are also accepted. Such dates are
499519
padded to the start and end of the day if used in start and end of date range
500-
interval accordingly.
501-
Please note that for timestamp comparison, `>=` and `<=` operators are used.
502-
It requires, for example, that the end date range date `2020-01-01` is padded
503-
to `2020-01-01T23:59:59.999`.
504-
If only one date is specified it's equivalent to passing
505-
two of the same dates as a date range. You can also pass a string instead of
506-
array with relative date range, for example: `last quarter`, `last 360 days`,
507-
or `next 2 months`.
520+
interval accordingly. Please note that for timestamp comparison, `>=` and `<=`
521+
operators are used. It requires, for example, that the end date range date
522+
`2020-01-01` is padded to `2020-01-01T23:59:59.999`. If only one date is
523+
specified it's equivalent to passing two of the same dates as a date range.
524+
You can also pass a string instead of array with relative date range, for
525+
example: `last quarter`, `last 360 days`, or `next 2 months`.
508526
- `compareDateRange`: An array of date ranges to compare a measure change over
509527
previous period
510528
- `granularity`: A granularity for a time dimension. It supports the following
@@ -572,6 +590,8 @@ date. If you need the current date also you can use `from N days ago to now` or
572590
}
573591
```
574592

593+
[ref-client-core-resultset-drilldown]:
594+
/@cubejs-client-core#result-set-drill-down
575595
[ref-schema-ref-preaggs-refreshkey]:
576596
/schema/reference/pre-aggregations#parameters-refresh-key
577597
[ref-schema-ref-preaggs-refreshkey-every]:

0 commit comments

Comments
 (0)