Skip to content

Commit 14a218a

Browse files
github-automation-metabaseMetabase Docs bot
andauthored
[auto] adding content to master->master (#720)
Co-authored-by: Metabase Docs bot <[email protected]>
1 parent aeb473e commit 14a218a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+372
-81
lines changed

_docs/master/configuring-metabase/caching.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -129,11 +129,12 @@ If you have databases connected to Metabase that are set to **Use default** poli
129129
To set a caching policy for a dashboard, you must have [curate access](../permissions/collections#curate-access) to the dashboard's collection.
130130

131131
1. Go to your dashboard.
132-
2. Click on the **info** icon.
133-
3. Click **Caching policy**.
134-
4. Select the [caching invalidation policy](#cache-invalidation-policies).
135-
5. Optional: turn on [refresh cache automatically](#refresh-cache-automatically).
136-
6. Save your changes.
132+
2. Click on the **three dots** icon in the top-right corner of the dashboard and choose **Edit settings**.
133+
3. By default, each question will use the database default caching settings. Click the current caching policy to change it.
134+
4. Select the new [caching policy](#cache-invalidation-policies).
135+
5. Optional: turn on [refresh cache automatically](#refresh-cache-automatically)
136+
6. Optional: to clear the cache for all questions on a dashboard, click **Clear cache for this dashboard** at the bottom of the setting sidebar.
137+
7. Save your changes.
137138

138139
### Question caching policy
139140

_docs/master/databases/uploads.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To manage upload settings, admins can hit cmd/ctrl + K and search for "Settings
2626
- [PostgreSQL](../databases/connections/postgresql)
2727
- [MySQL](../databases/connections/mysql)
2828
- [Redshift](../databases/connections/redshift)
29-
- [ClickHouse](../databases/connections/clickhouse)
29+
- [ClickHouse](../databases/connections/clickhouse) (only supported on ClickHouse Cloud)
3030

3131
## Setting up uploads
3232

_docs/master/developers-guide/driver-changelog.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ layout: new-docs
3636
- Added `metabase.driver/type->database-type` multimethod that returns the database type for a given Metabase
3737
type (from the type hierarchy) as a HoneySQL spec. This method handles general Metabase base types.
3838

39+
- Added driver multimethods driver/native-result-metadata, driver/validate-native-query-fields, driver.sql/resolve-field, driver.sql.normalize-unquoted-name, driver.sql.normalize/reserved-literal, driver.sql.references/find-used-fields, driver.sql.references/find-returned-fields, and driver.sql.references/field-references-impl for use with the :dependencies/native feature.
40+
3941
- Added `metabase.driver/insert-from-source!` multimethod that abstracts data insertion from various sources
4042
into existing tables. This multimethod dispatches on both the driver and the data source type
4143
(`:rows` or `:jsonl-file`). It allows drivers to optimize based on the data source type and returns the number

_docs/master/embedding/embedded-analytics-js.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ summary: 'Getting started with Embedded Analytics JS for embedding Metabase enti
1616

1717
Embedded analytics JS lets you embed Metabase entities like questions, dashboards, or even the query builder into your own application using customizable components.
1818

19+
{% include shared/in-page-promo-embedding-workshop.html %}
20+
1921
Embedded Analytics JS is a JavaScript library built on top of Metabase's [Embedded Analytics React SDK](./sdk/introduction). But it does not require using React or setting up full SDK embedding.
2022
Unlike with [interactive embedding](./interactive-embedding), where you embed the entire Metabase app in an iframe, Embedded Analytics JS lets you choose from a set of predefined components like a single chart, a dashboard with optional drill-through, or query builder, and customize those components.
2123

_docs/master/embedding/interactive-embedding.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,10 @@ redirect_from:
1818

1919
{% include shared/in-page-promo-embedding-workshop.html %}
2020

21-
**Interactive embedding** is what you want if you want to offer [multi-tenant, self-service analytics](/learn/metabase-basics/embedding/multi-tenant-self-service-analytics).
21+
**Interactive embedding** lets you embed the entire Metabase app in an iframe. Interactive embedding integrates your [permissions](../permissions/introduction) and [SSO](../people-and-groups/start#authentication) to give people the right level of access to [query](../questions/query-builder/editor) and [drill-down](/learn/metabase-basics/querying-and-dashboards/questions/drill-through) into your data.
2222

2323
> If you are just starting out with Metabase embedding, consider using [Embedded Analytics JS](./embedded-analytics-js) instead of interactive embedding - it's an improved, more customizable option for embedding interactive Metabase elements. Interactive embedding remains fully supported.
2424
25-
Interactive embedding is the only type of embedding that integrates with your [permissions](../permissions/introduction) and [SSO](../people-and-groups/start#authentication) to give people the right level of access to [query](/glossary/query-builder) and [drill-down](/learn/metabase-basics/querying-and-dashboards/questions/drill-through) into your data.
26-
2725
## Interactive embedding demo
2826

2927
To get a feel for what you can do with interactive embedding, check out our [interactive embedding demo](/embedding-demo).

_docs/master/embedding/sdk/ai-chat.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,11 @@ You can check out a [demo of the AI chat component](https://embedded-analytics-s
3131
```typescript
3232
{% include_file "{{ dirname }}/snippets/questions/ai-question.tsx" %}
3333
```
34+
3435
## API reference
3536

3637
- [Component](./api/MetabotQuestion)
38+
- [Props](./api/MetabotQuestionProps)
3739

3840
## Setting up AI chat
3941

@@ -47,3 +49,11 @@ To configure your embedded AI chat in your Metabase:
4749
When embedding the Metabot component in your app, you should specify a collection that embedded Metabot is allowed to use for creating queries. Embedded Metabot will only have access to that collection.
4850

4951
For tips and more, see [Metabot settings](../../ai/settings).
52+
53+
## Layout
54+
55+
Use the `layout` prop to specify which layout to use for the Metabot component:
56+
57+
- `auto` (default): Metabot uses the `stacked` layout on mobile screens, and a `sidebar` layout on larger screens.
58+
- `stacked`: the question visualization stacks on top of the chat interface.
59+
- `sidebar`: the question visualization appears to the left of the chat interface, which is on a sidebar on the right.

_docs/master/embedding/sdk/api/CreateQuestion.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
</div></li><li class="tsd-parameter"><h5 id="componentplugins"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">componentPlugins</span><span class="tsd-signature-symbol">?: </span><a href="MetabasePluginsConfig.html" class="tsd-signature-type tsd-kind-type-alias">MetabasePluginsConfig</a></h5><div class="tsd-comment tsd-typography"><p>Additional mapper function to override or add drill-down menu</p>
1414
</div></li><li class="tsd-parameter"><h5 id="entitytypes"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">entityTypes</span><span class="tsd-signature-symbol">?: </span><a href="EmbeddingEntityType.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingEntityType</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>An array that specifies which entity types are available in the data picker</p>
1515
</div></li><li class="tsd-parameter"><h5 id="height"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Height</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><p>A number or string specifying a CSS size value that specifies the height of the component</p>
16+
</div></li><li class="tsd-parameter"><h5 id="hiddenparameters"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">hiddenParameters</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>A list of parameters to hide.</p>
1617
</div></li><li class="tsd-parameter"><h5 id="initialsqlparameters"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">initialSqlParameters</span><span class="tsd-signature-symbol">?: </span><a href="SqlParameterValues.html" class="tsd-signature-type tsd-kind-type-alias">SqlParameterValues</a></h5><div class="tsd-comment tsd-typography"><p>Initial values for the SQL parameters.</p>
1718
</div></li><li class="tsd-parameter"><h5 id="issaveenabled"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">isSaveEnabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether to show the save button.</p>
1819
</div></li><li class="tsd-parameter"><h5 id="onbeforesave"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">onBeforeSave</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">question</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="MetabaseQuestion.html" class="tsd-signature-type tsd-kind-interface">MetabaseQuestion</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">isNewQuestion</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><p>A callback function that triggers before saving. Only relevant when <code>isSaveEnabled = true</code></p>

0 commit comments

Comments
 (0)