Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ yarn dev # Start the Mintlify dev server
relevant `group` to appear in the sidebar).
- Use Mintlify components: `<Note>`, `<Warning>`, `<Info>`, `<Tip>`, `<Steps>`/`<Step>`,
`<CardGroup>`/`<Card>`. Internal links are root-relative (e.g. `/admin/ai/rules`).
- Keep docs concise — most changes are small, surgical edits to existing pages, not new
pages or walls of text. Prefer editing an existing page over creating a new one.
- See `docs-mintlify/CLAUDE.md` for full conventions.

## Architecture Overview
Expand Down
18 changes: 18 additions & 0 deletions docs-mintlify/CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,24 @@ Benchmarking the agent's answers against a known-correct ground truth.
inline backticks for identifiers (`accessible_views`, `agents/rules/`).
- **Paragraphs**: keep them short; use `-` bullet lists for multiple items.

### Be concise; prefer surgical edits over new content

**Be explicit with yourself about length: most doc changes are small.** Do not
produce walls of text. Be less verbose. Write the shortest version that fully
answers "how do I use this?" and stop.

- **Default to editing existing pages, not creating new ones.** A new feature
usually extends a page that already exists — add a row to a table, a config
option to a reference page, a sentence to the relevant section. Search the
docs first and integrate there. Only create a new page when the topic
genuinely has no home.
- **Do not pad.** No "Overview" / "Use cases" / "Best practices" scaffolding
for a small feature. A single config option is usually a paragraph plus a
code block — not a multi-section page.
- **Say it once.** Don't restate the same point in prose and again in a
callout, and don't explain what the code sample already shows.
- **One good example beats three near-identical ones.**

## File and frontmatter conventions

- Content is `.mdx`, organized by topic directory (e.g. `admin/ai/`, `docs/explore-analyze/`).
Expand Down
15 changes: 15 additions & 0 deletions docs-mintlify/docs/data-modeling/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,18 @@ run against the data source.
Backed by
[`CUBEJS_DB_QUERY_TIMEOUT`](/reference/configuration/environment-variables#cubejs_db_query_timeout).

## Auto-run

The deployment-wide default for whether [Explore][ref-explore] and
[Workbooks][ref-workbooks] tabs run their query automatically as you build it,
or wait for you to click **Run query**. Defaults to on.

A semantic view's [`meta.auto_run`][ref-view-auto-run] setting and a user's
own per-tab toggle both take precedence over this deployment default.

Backed by
[`CUBEJS_AUTO_RUN_MODE`](/reference/configuration/environment-variables#cubejs_auto_run_mode).

## Applying changes

Saving Model Configuration restarts the deployment's development-mode
Expand All @@ -98,3 +110,6 @@ pick up the changes on the next build or deploy.
[ref-row-limit]: /reference/core-data-apis/queries#row-limit
[ref-sql-api]: /reference/core-data-apis/sql-api
[ref-environments-dev]: /admin/deployment/environments#development-environments
[ref-explore]: /docs/explore-analyze/explore
[ref-workbooks]: /docs/explore-analyze/workbooks/querying-data
[ref-view-auto-run]: /reference/data-modeling/view#auto_run
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ Configure individual columns in the **Columns** section of the **Style** tab (or
| **Width** | **Flexible** (a weight) or **Fixed** (pixels) — see [Column width](#column-width) |
| **Hide** | Show or hide the column |

When a cell's value is too long for its column and word wrap is off, the value is truncated with an ellipsis. Hover over a truncated cell to see its full value in a tooltip.

## Column width

Each column's width is set independently in the **Columns** section of the **Style** tab. A column is in one of two modes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ A data model author can change the default for a semantic view with the
views that are expensive to query. You can still toggle auto-run back on at
any time.

An admin can also turn auto-run off by default for every tab in the
deployment, from **Model Configuration**. Per-view and per-tab settings still
take precedence over this deployment-wide default. See
[Auto-run][ref-configuration-auto-run] in the Model Configuration reference.

When a cell's value is too long for its column, it is truncated with an
ellipsis. Hover over a truncated cell to see its full value in a tooltip.

## Filtering

Dimensions and measures can be added as filters to focus on specific rows of data.
Expand Down Expand Up @@ -319,4 +327,5 @@ behaves as intended.
[ref-table-chart]: /docs/explore-analyze/charts/chart-types/table
[ref-calculated-fields]: /docs/explore-analyze/workbooks/calculated-fields
[ref-auto-run]: /reference/data-modeling/view#auto_run
[ref-configuration-auto-run]: /docs/data-modeling/configuration#auto-run

21 changes: 21 additions & 0 deletions docs-mintlify/embedding/iframe/analytics-chat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,24 @@ See [Signed embedding](/embedding/iframe/auth/signed) for the full session gener
## Personalize chat with user attributes

When using signed embedding, you can pass [user attributes](/embedding/iframe/auth/signed#user-attributes) during session generation to personalize chat responses for each user — for example, scoping answers to a specific region, department, or tenant.

## Customize the chat

Add these query parameters to the embed URL to hide parts of the chat UI:

| Parameter | Effect |
| ----------------- | --------------------------------------------------- |
| `hideNewChat=1` | Hides the **New chat** button. |
| `hideChatInput=1` | Hides the message input, for a read-only transcript. |
| `hideHistory=1` | Hides the **Chat History** button. |

By default, the chat header shows a **Chat History** button that lists the
user's past conversations (matched by `externalId` under signed embedding) so
they can resume one instead of always starting fresh.

To deep-link directly into a specific past conversation, pass its ID as
`chatId` alongside `sessionId` on the short embed URL:

```text
https://your-tenant.cubecloud.dev/embed/chat?sessionId=YOUR_SESSION_ID&chatId=YOUR_CHAT_ID
```
14 changes: 14 additions & 0 deletions docs-mintlify/reference/configuration/environment-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,20 @@ different for multitenant setups.
| --------------- | ---------------------- | --------------------- |
| A valid string | `cubejs` | `cubejs` |

## `CUBEJS_AUTO_RUN_MODE`

The deployment-wide default for whether [Explore](/docs/explore-analyze/explore)
and [Workbooks](/docs/explore-analyze/workbooks/querying-data) tabs run their
query automatically as it's built, or wait for an explicit **Run query**. Set
via the **Auto-run** switch in [Model Configuration](/docs/data-modeling/configuration#auto-run).
A view's `meta.auto_run` setting and a user's per-tab toggle both take
precedence over this default. Only the literal string `false` turns it off —
any other value (including unset) is treated as on.

| Possible Values | Default in Development | Default in Production |
| ---------------- | ----------------------- | ----------------------- |
| `true`, `false` | `true` | `true` |

## `CUBEJS_AWS_KEY`

The AWS Access Key ID to use for database connections.
Expand Down
13 changes: 13 additions & 0 deletions docs-mintlify/reference/core-data-apis/sql-api/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,19 @@ HAVING status = 'shipped'
LIMIT 1 OFFSET 1;
```

`SELECT DISTINCT ON (expression [, ...])` is also supported, with the same
semantics as PostgreSQL: for each set of rows with matching values in the
given expressions, only the first row is kept, using the order specified by
`ORDER BY` (which must start with the `DISTINCT ON` expressions).

Example:

```sql
SELECT DISTINCT ON (status) status, city
FROM orders
ORDER BY status, id DESC;
```

### `EXPLAIN`

Synopsis:
Expand Down
Loading