-
Notifications
You must be signed in to change notification settings - Fork 2.1k
docs: document undocumented customer-facing changes from the last week #11636
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
a699949
cc1d4fc
5c054d6
a22b8dd
198b8e7
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -672,6 +672,27 @@ Each push creates exactly two new files: | |||||||||||||||||||||||||
| from the cube's joins (only to targets that originated in dbt), and the cube's measures | ||||||||||||||||||||||||||
| preserved under `meta.cube.measures` for context. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Author dbt models from Analytics Chat | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| <Warning> | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Authoring dbt models from Analytics Chat is currently in preview, and its behavior may | ||||||||||||||||||||||||||
| still change. Reach out to the [Cube support team](/admin/account-billing/support) to | ||||||||||||||||||||||||||
| activate this feature for your account. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
|
Comment on lines
+677
to
+682
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This callout says to contact support to activate the feature, but the last paragraph of the section says enablement is shared with dbt push — and dbt push is activated by the customer themselves under Settings → Data Sources → Push to dbt (the Note the sibling preview callout at line 567 deliberately uses the softer form ("If you run into issues, reach out to the Cube support team") for exactly this reason. Suggest matching it:
Suggested change
If it genuinely does need a support-side flag on top of the push setting, then say that explicitly instead — "requires dbt push to be enabled and activation by the Cube support team." |
||||||||||||||||||||||||||
| </Warning> | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Ask [the agent](/docs/explore-analyze/analytics-chat) to create or update a dbt | ||||||||||||||||||||||||||
| model — for example, "turn this cube into a dbt model" or "add a `region` column to the | ||||||||||||||||||||||||||
| `orders` dbt model." The agent opens a private **dbt workspace**: a live sandbox scoped | ||||||||||||||||||||||||||
| to that model, where it reads the existing model and YAML files, drafts or edits the | ||||||||||||||||||||||||||
| SQL, runs `dbt` to validate the change, and iterates until it compiles. Once you | ||||||||||||||||||||||||||
| confirm, it publishes the result — a pull request or a direct commit, per your | ||||||||||||||||||||||||||
| [delivery mode](#enable-push) — back to your dbt repository. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| This shares its enablement with [dbt push](#push-cubes-to-dbt): activating one activates | ||||||||||||||||||||||||||
| the other, and a model authored from chat is delivered the same way a pushed cube is. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Limitations | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| - **Supported warehouses:** Snowflake, Amazon Redshift, PostgreSQL, Google | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -244,6 +244,14 @@ work together. | |||||||||||||||||||||||||
| Call `searchDataModel` before `runQuery` to find exact view and member names rather than | ||||||||||||||||||||||||||
| guessing them. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Pass an optional `branchName` to `runQuery` to query a dev branch's model — the one | ||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Placement suggestion: this paragraph documents a data-model-editing workflow but lives in the "Query and discovery" reference section, ~160 lines above the walkthrough it belongs to. The "Edit the data model" workflow (lines 405–412) currently ends at "Review the result with Keeping this paragraph here is fine, but consider adding one sentence there cross-linking it (e.g. "To check the edit against real data before committing, call |
||||||||||||||||||||||||||
| returned by `startDataModelEdit` — instead of the deployed model, so you can verify an | ||||||||||||||||||||||||||
| edit before it's committed. The response reports the branch it actually queried | ||||||||||||||||||||||||||
| (`null` for the deployed model), which never just echoes the argument back. Keep | ||||||||||||||||||||||||||
| `branchName` identical across paginated calls: `runQuery` re-issues the whole query for | ||||||||||||||||||||||||||
| each page, so dropping it on a later page silently switches that page to the deployed | ||||||||||||||||||||||||||
| model. | ||||||||||||||||||||||||||
|
Comment on lines
+249
to
+253
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Two things here:
Suggested change
|
||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ### Dashboard authoring | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| These tools build [workbooks][ref-workbooks] and [dashboards][ref-dashboards] | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -77,20 +77,22 @@ This works on both regular and published (embedded) dashboards. The filter is | |||||
| only applied if a matching filter widget for that dimension already exists on the | ||||||
| dashboard. | ||||||
|
|
||||||
| ## Allow CSV export | ||||||
| ## Allow chart export | ||||||
|
|
||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Renaming this heading changes its slug from
includes `allowExport=true` (see [Dashboards → Allow CSV
export](/embedding/iframe/dashboards#allow-csv-export)). The event fires when aTwo ways to fix — either keep the old slug with Mintlify's explicit anchor syntax (the repo already does this elsewhere for link stability, e.g.
Suggested change
…or rename the heading as-is and update the link text/target in |
||||||
| By default, embedded dashboards do not expose a download action on individual | ||||||
| widgets. To let viewers download a chart widget's data as a CSV file, add the | ||||||
| `allowExport=true` query parameter to the embed URL: | ||||||
| widgets. To let viewers export a chart widget, add the `allowExport=true` query | ||||||
| parameter to the embed URL: | ||||||
|
|
||||||
| ```text | ||||||
| https://your-tenant.cubecloud.dev/embed/dashboard/YOUR_DASHBOARD_PUBLIC_ID?session=YOUR_SESSION_ID&allowExport=true | ||||||
| ``` | ||||||
|
|
||||||
| When enabled, each chart widget's ⋮ menu shows a **Download as CSV** action. The | ||||||
| CSV is generated client-side from the data already loaded into the widget, so no | ||||||
| additional query is issued. The parameter is opt-in — omit it (the default) to | ||||||
| keep the download action hidden. | ||||||
| When enabled, each chart widget's ⋮ menu shows **Download as CSV**, **Download as | ||||||
| PNG**, and **Download as PDF** actions. CSV is generated client-side from the data | ||||||
| already loaded into the widget; PNG and PDF are [server-rendered | ||||||
| snapshots](/docs/explore-analyze/dashboards#download-as-png-or-pdf), the same as | ||||||
| on a non-embedded dashboard. The parameter is opt-in — omit it (the default) to | ||||||
| keep the download actions hidden. | ||||||
|
Comment on lines
+91
to
+95
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This change leaves two now-stale statements in
Worth updating both in this PR so the |
||||||
|
|
||||||
| ## Show or hide the AI chat | ||||||
|
|
||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Worth double-checking "fold them into the last bucket". The buckets described just above are ordered by value (
< 0,[0, 18),[18, 25),>= 25), so "the last bucket" meansNULLrows land in the highest bucket — a surprising enough behavior that if it's right it deserves a word of emphasis, and if the actual behavior is "the first/lowest bucket" or "the generatedCASEfalls through to theELSEbranch", the sentence is wrong in a way a reader can't detect.Also, this paragraph replaces the old flat statement "Rows where the dimension is
NULLare reported asUnknown", so it's now the only place that behavior is documented — worth getting exactly right.