docs: describe the outcome messages after a manual pre-aggregation refresh - #11773
docs: describe the outcome messages after a manual pre-aggregation refresh#11773keydunov wants to merge 1 commit into
Conversation
…fresh A chart's Refresh, a dashboard's Refresh all, and a workbook's Run all now report whether a pre-aggregation rebuild actually completed, was only requested, or is still running — rather than assuming success. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011oxbph2zZPPPv8NCMRofH4
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
Claude finished @keydunov's task in 57s —— View job Review: docs-only change, looks accurate — 0 high, 0 medium, 3 low (1 inline comment)Full reviewTodos
SummaryThe PR adds one paragraph to the "Result freshness and provenance" section of Findings (all low)
All three are folded into a single inline comment with a What I did not do
|
| - **Freshness** — a leaf icon shows how recently the underlying data was refreshed. Hover over it to see the last refresh time (for example, "Refreshed 5 minutes ago"); its color shifts as the data ages, so you can tell fresh from stale results at a glance. If the refresh time can't be determined, the leaf turns gray with a "Data age unknown" label. When you have access to [Query History](/admin/monitoring/query-history), clicking the leaf opens the underlying request for that result. | ||
| - **Pre-aggregation** — for those same users, a lightning-bolt icon appears next to the leaf with a "Served from a pre-aggregation" label whenever the result was served from a [pre-aggregation](/docs/pre-aggregations). If no icon is shown, the query ran directly against your data source. | ||
|
|
||
| Manually refreshing a result served from a pre-aggregation (a chart's **Refresh**, a dashboard's **Refresh all**, or a workbook's **Run all**) reports what actually happened, since a pre-aggregation rebuild can take longer than the request itself waits for: **Refreshed successfully** once the rebuild is confirmed complete, **Refresh requested** when Cube can't yet confirm whether a rebuild finished, or a message noting the rebuild is still running if it takes more than a few minutes. |
There was a problem hiding this comment.
This is a single ~90-word sentence that packs the trigger controls, the why, and three outcomes behind one colon. The rest of this section uses bullets for exactly this kind of enumeration, so splitting it reads better and stays scannable:
| Manually refreshing a result served from a pre-aggregation (a chart's **Refresh**, a dashboard's **Refresh all**, or a workbook's **Run all**) reports what actually happened, since a pre-aggregation rebuild can take longer than the request itself waits for: **Refreshed successfully** once the rebuild is confirmed complete, **Refresh requested** when Cube can't yet confirm whether a rebuild finished, or a message noting the rebuild is still running if it takes more than a few minutes. | |
| Manually refreshing a result served from a pre-aggregation — a chart's **Refresh**, a dashboard's **Refresh all**, or a workbook's **Run all** — reports what actually happened, since a pre-aggregation rebuild can take longer than the request waits for: | |
| - **Refreshed successfully** — the rebuild is confirmed complete. | |
| - **Refresh requested** — Cube can't yet confirm whether the rebuild finished. | |
| - If the rebuild is still running after a few minutes, Cube reports that it's still in progress. |
Two smaller things while you're in here:
- The third outcome is the only one whose message isn't quoted verbatim ("a message noting the rebuild is still running"). If that string is stable in
cubejs-enterprise#14657, quoting it in bold like the other two makes the paragraph consistent and lets a reader match what they see in the UI against the docs. - Refresh all and Run all aren't described anywhere else in the Cube Cloud docs (only in the Excel/Sheets integration pages, for a different control). Readers hitting this paragraph via the
#result-freshness-and-provenancedeep link fromdashboards/index.mdx:27may not know those controls. Not blocking, but a short "these controls live at …" clause, or documenting them on the dashboards page, would close the gap.
Check List
Description of Changes Made
cubejs-enterprise#14657(CUB-3373) changed what a manual refresh reports: instead ofalways claiming "Refreshed successfully", Cube now distinguishes a confirmed rebuild
from one it can't yet confirm ("Refresh requested") or one still running past a few
minutes. This adds a short paragraph to the "Result freshness and provenance" section
of the querying-data page describing those three outcomes, since the existing text
only covered the passive freshness/pre-aggregation indicators, not what a manual
Refresh / Refresh all / Run all reports.
🤖 Generated with Claude Code
https://claude.ai/code/session_011oxbph2zZPPPv8NCMRofH4
Generated by Claude Code