Skip to content

docs(workbooks): document the filter bar's operators and groups (CUB-2119) - #11573

Merged
keydunov merged 2 commits into
cube-js:masterfrom
Zhabrikoff:yauheni/cub-2119-expand-filtering-documentation
Aug 19, 2026
Merged

docs(workbooks): document the filter bar's operators and groups (CUB-2119)#11573
keydunov merged 2 commits into
cube-js:masterfrom
Zhabrikoff:yauheni/cub-2119-expand-filtering-documentation

Conversation

@Zhabrikoff

Copy link
Copy Markdown
Contributor

The Filtering section on the workbook querying-data page was one sentence. It now covers what the
filter bar actually does: where a filter comes from, that a dimension filter is a WHERE and a
measure filter a HAVING, the operators offered per data type, how values are entered, AND/OR
groups, and custom SQL conditions.

The operator wording is the filter bar's own, taken from report-filter-operators.ts and
FILTER_TYPES_BY_MEMBER_TYPE in the cloud repo. That is deliberately a different vocabulary from
the REST (JSON) API's filters
— the bar says is / after or on / is null where the API says
equals / gte / set, and it has between, is empty and the six in the month|quarter|year
period comparisons. A reader sent to the API reference for "the full list" gets the wrong names,
so this page carries its own tables.

Second commit fixes the same vocabulary in the default_ui_filters reference, which promised "what
you see in the filter bar is what you type" and then listed the retired after date /
before or on date spellings, with after, before, the empty-string checks and the period
comparisons missing — all of which the authoring parser already accepts. The old spellings are still
accepted, so they moved down to the sentence about aliases.

Closes CUB-2119. Supersedes #10632, whose operator tables described the REST (JSON) API and the old
Playground query builder rather than the workbook.

Verified with mintlify broken-links --check-anchors (the one hit is a pre-existing anchor in
reference/control-plane-api.mdx) and by reading both pages in a local mintlify dev. Not verified
against the running app: the claims about where the bar sits and what a chip's menu offers come from
the components, not from a session in the product.

🤖 Generated with Claude Code

Zhabrikoff and others added 2 commits August 17, 2026 12:00
The Filtering section was a single sentence. Document what the filter bar
actually offers: where filters come from, the dimension/measure split into
WHERE and HAVING, the operators available per data type, how values are
entered, AND/OR groups, and custom SQL conditions.

Operator wording follows the filter bar itself, which is a different
vocabulary from the REST (JSON) API's filter operators.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The list named the `after date` / `before or on date` spellings the filter bar
dropped, and omitted the operators authored views can already use: `after`,
`before`, `after or on`, `before or on`, the empty-string checks and the six
period comparisons. Group them by member type and keep the older spellings
where they belong, next to the other accepted aliases.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@Zhabrikoff
Zhabrikoff requested a review from keydunov as a code owner August 17, 2026 10:01
@github-actions github-actions Bot added the pr:community Contribution from Cube.js community members. label Aug 17, 2026
@keydunov
keydunov merged commit 14dcc9c into cube-js:master Aug 19, 2026
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr:community Contribution from Cube.js community members.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants