Skip to content

Commit 71a9a36

Browse files
github-automation-metabaseMetabase Docs bot
github-automation-metabase
and
Metabase Docs bot
authored
[auto] adding content to master->master (#779)
Co-authored-by: Metabase Docs bot <[email protected]>
1 parent 7d5aca2 commit 71a9a36

File tree

301 files changed

+1003
-599
lines changed

Some content is hidden

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

301 files changed

+1003
-599
lines changed

‎_docs/master/api.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@
8080
<body>
8181
<script id="api-reference" data-url="api.json"></script>
8282

83-
<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
83+
<script src="https://cdn.jsdelivr.net/npm/@scalar/[email protected]/dist/browser/standalone.min.js"></script>
84+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@scalar/[email protected]/dist/style.min.css">
8485
</body>
8586
</html>

‎_docs/master/api.json‎

Lines changed: 51 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2912,6 +2912,9 @@
29122912
"authority_level" : {
29132913
"type" : "string"
29142914
},
2915+
"description" : {
2916+
"type" : "string"
2917+
},
29152918
"name" : {
29162919
"type" : "string"
29172920
}
@@ -16189,6 +16192,44 @@
1618916192
"tags" : [ "/api/ee/billing" ]
1619016193
}
1619116194
},
16195+
"/api/ee/cloud-add-ons/addons" : {
16196+
"get" : {
16197+
"summary" : "GET /api/ee/cloud-add-ons/addons",
16198+
"description" : "Get addons information from the Metabase Store API.",
16199+
"parameters" : [ ],
16200+
"responses" : {
16201+
"2XX" : {
16202+
"description" : "Successful response"
16203+
},
16204+
"4XX" : {
16205+
"description" : "Client error response"
16206+
},
16207+
"5XX" : {
16208+
"description" : "Server error response"
16209+
}
16210+
},
16211+
"tags" : [ "/api/ee/cloud-add-ons" ]
16212+
}
16213+
},
16214+
"/api/ee/cloud-add-ons/plans" : {
16215+
"get" : {
16216+
"summary" : "GET /api/ee/cloud-add-ons/plans",
16217+
"description" : "Get plans information from the Metabase Store API.",
16218+
"parameters" : [ ],
16219+
"responses" : {
16220+
"2XX" : {
16221+
"description" : "Successful response"
16222+
},
16223+
"4XX" : {
16224+
"description" : "Client error response"
16225+
},
16226+
"5XX" : {
16227+
"description" : "Server error response"
16228+
}
16229+
},
16230+
"tags" : [ "/api/ee/cloud-add-ons" ]
16231+
}
16232+
},
1619216233
"/api/ee/cloud-add-ons/{product-type}" : {
1619316234
"post" : {
1619416235
"summary" : "POST /api/ee/cloud-add-ons/{product-type}",
@@ -16199,7 +16240,7 @@
1619916240
"required" : true,
1620016241
"schema" : {
1620116242
"type" : "string",
16202-
"enum" : [ "metabase-ai" ]
16243+
"enum" : [ "metabase-ai", "python-execution" ]
1620316244
}
1620416245
} ],
1620516246
"responses" : {
@@ -16222,8 +16263,7 @@
1622216263
"terms_of_service" : {
1622316264
"type" : "boolean"
1622416265
}
16225-
},
16226-
"required" : [ "terms_of_service" ]
16266+
}
1622716267
}
1622816268
}
1622916269
}
@@ -20914,6 +20954,14 @@
2091420954
"default" : false,
2091520955
"type" : "boolean"
2091620956
}
20957+
}, {
20958+
"in" : "query",
20959+
"name" : "reindex",
20960+
"required" : true,
20961+
"schema" : {
20962+
"default" : true,
20963+
"type" : "boolean"
20964+
}
2091720965
} ],
2091820966
"responses" : {
2091920967
"2XX" : {

‎_docs/master/configuring-metabase/appearance.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,11 @@ Appearance settings are split across different tabs:
3939

4040
People can display their Metabase in dark mode in their [account settings](../people-and-groups/account-settings#theme). Options are:
4141

42-
- System default (which is also the default setting). Metabase will switch between light and dark mode when the system switches without having to reload the page.
43-
- Always use dark mode.
44-
- Always use light mode.
42+
- System default (which is also the default setting). Metabase will switch between light and dark mode when the system switches without having to reload the page.
43+
- Always use dark mode.
44+
- Always use light mode.
45+
46+
You can quickly toggle dark mode from anywhere in Metabase by opening the [command palette](../exploration-and-organization/exploration#command-palette) and searching for "light" or "dark" or "theme".
4547

4648
Dark mode is a user-level setting, not an instance-level setting. Currently, there's no way to change the theme to dark mode for the entire instance, but you can edit some [user interface colors](#user-interface-colors).
4749

‎_docs/master/data-modeling/model-persistence.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,22 @@ layout: new-docs
1111

1212
# Model persistence
1313

14-
> Currently available for PostgreSQL, MySQL, and Redshift.
15-
1614
Metabase can persist the results of your models so that your models (and the questions based on those models) load faster.
1715

1816
Metabase will store model results in tables in a bespoke schema in your data warehouse (not the Metabase application database). When people ask questions based on your models, Metabase will use the tables with the stored results instead of re-running the model's query.
1917

2018
> Model persistence doesn't work with [row and column security](../permissions/row-and-column-security) or [impersonation](../permissions/impersonation).
2119
20+
## Databases that support model persistence
21+
22+
Currently, model persistence is only available for the following databases:
23+
24+
- PostgreSQL
25+
- MySQL
26+
- Redshift
27+
28+
Model persistence doesn't work with [row and column security](../permissions/row-and-column-security) or [impersonation](../permissions/impersonation).
29+
2230
## Turn on model persistence in Metabase
2331

2432
To persist models for faster loading, you'll need to turn on model persistence for:

‎_docs/master/embedding/sdk/dashboards.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,10 @@ If you want to replace the existing menu with your own component, you can do so
136136
{% include_file "{{ dirname }}/snippets/dashboards/plugins.tsx" snippet="example-custom-actions-menu" %}
137137
```
138138

139+
### `mapQuestionClickActions`
140+
141+
You can customize what happens when people click on a data point on a dashboard with the `mapQuestionClickActions` plugin. See [mapQuestionClickActions](./questions#mapquestionclickactions).
142+
139143
## Creating dashboards
140144

141145
Creating a dashboard could be done with `useCreateDashboardApi` hook or `CreateDashboardModal` component.

‎_docs/master/embedding/sdk/plugins.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,43 @@ To use a plugin on a per-component basis, pass the plugin as a prop to the compo
3131
{% include_file "{{ dirname }}/snippets/plugins/component-plugins.tsx" snippet="example" %}
3232
```
3333

34+
## `handleLink`
35+
36+
To customize what happens when people click a link in your embedded questions and dashboards, use the global plugin `handleLink`:
37+
38+
```typescript
39+
export default function App() {
40+
const navigate = useNavigate(); // coming from whatever routing lib you're using
41+
42+
const plugins = {
43+
handleLink: (urlString: string) => {
44+
const url = new URL(urlString, window.location.origin);
45+
const isInternal = url.origin === window.location.origin;
46+
if (isInternal) {
47+
// client side navigation
48+
navigate(url.pathname + url.search + url.hash);
49+
50+
return { handled: true }; // prevent default navigation
51+
}
52+
return { handled: false }; // let the sdk do the default behavior
53+
},
54+
};
55+
56+
return (
57+
<MetabaseProvider authConfig={authConfig} pluginsConfig={plugins}>
58+
<nav style={{ display: "flex", gap: 12, padding: 12 }}>
59+
<Link to="/">Home</Link>
60+
<Link to="/question">Question</Link>
61+
<Link to="/about">About</Link>
62+
</nav>
63+
<div style={{ padding: 12 }}>
64+
<Outlet />
65+
</div>
66+
</MetabaseProvider>
67+
);
68+
}
69+
```
70+
3471
## Further reading
3572

3673
- [Interactive question plugins](./questions#interactive-question-plugins)

‎_docs/master/embedding/sdk/questions.md‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,27 @@ You can use [plugins](./plugins) to add custom functionality to your questions.
131131

132132
### `mapQuestionClickActions`
133133

134-
This plugin allows you to add custom actions to the click-through menu of an interactive question. You can add and
135-
customize the appearance and behavior of the custom actions.
134+
When people click on a data point in the embedded interactive chart, Metabase shows them a menu of actions by default. The plugin `mapQuestionClickActions` allows you to customize this behavior. You can choose to:
135+
136+
- Open the default Metabase menu.
137+
- Add custom actions to that click-through menu.
138+
- Perform immediate action without opening a menu.
139+
140+
Use `mapQuestionClickActions` globally at the provider level, or on individual `InteractiveQuestion` or `InteractiveDashboard` components. For more on provider scope, see [Plugins](./plugins)
141+
142+
The example below shows all the options for click action behavior. This example will:
143+
144+
- Open a menu with custom actions when "Last Name" column is clicked.
145+
- Perform an immediate action (show an alert) when the "Plan" column is clicked.
146+
- Shows the default menu (available as `clickActions`) in all other cases.
147+
148+
The behavior is determined by what `mapQuestionClickActions` returns: array of actions to open a menu, or a single action to trigger an immediate action.
149+
150+
```typescript
151+
{% include_file "{{ dirname }}/snippets/questions/interactive-question-click-actions.tsx" snippet="example" %}
152+
```
153+
154+
You can also customize the appearance of custom actions in the click menu. The example below shows an example of a click menu with default actions, a custom action, and a custom action with customized appearance:
136155

137156
```typescript
138157
{% include_file "{{ dirname }}/snippets/questions/interactive-question-plugins.tsx" snippet="example" %}

‎_docs/master/embedding/sdk/snippets/questions/interactive-question-click-actions.tsx‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
import {
2+
defineMetabaseAuthConfig,
3+
InteractiveQuestion,
4+
MetabaseProvider,
5+
} from "@metabase/embedding-sdk-react";
6+
7+
const authConfig = defineMetabaseAuthConfig({
8+
metabaseInstanceUrl: "http://localhost:3000",
9+
});
10+
11+
const Example = () => {
12+
return (
13+
// [<snippet example>]
14+
<MetabaseProvider
15+
authConfig={authConfig}
16+
pluginsConfig={{
17+
mapQuestionClickActions: (clickActions, clicked) => {
18+
if (clicked?.column?.display_name === "Last Name") {
19+
// This adds a custom action to the menu when clicked on on "Last Name" column
20+
return [
21+
...clickActions,
22+
{
23+
buttonType: "horizontal",
24+
name: "custom",
25+
title: "This is the Last Name column",
26+
onClick: () => alert("You clicked the Last Name column!"),
27+
},
28+
];
29+
}
30+
31+
if (clicked?.column?.display_name === "Plan") {
32+
// This performs an immediate action on "Plan" column instead of opening the menu
33+
return {
34+
onClick: () => alert("You clicked the Plan column!"),
35+
};
36+
}
37+
// default behavior (open Metabase's default click menu) on other columns
38+
return clickActions;
39+
},
40+
}}
41+
>
42+
<InteractiveQuestion questionId={1} />
43+
</MetabaseProvider>
44+
);
45+
// [<endsnippet example>]
46+
};

‎_docs/master/installation-and-operation/remote-sync.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -376,6 +376,21 @@ In Production mode, you can set Metabase to auto-sync changes from your main bra
376376

377377
By default, Metabase will pull any changes (if any) from the branch you specify every five minutes. You can also manually sync as needed.
378378

379+
## Disabling Remote Sync
380+
381+
To disable Remote Sync, go to the Remote Sync settings page in Admin settings.
382+
383+
To disable Remote Sync:
384+
385+
1. Go to **Admin settings** > **Settings** > **Remote sync**.
386+
2. Click **Disable Remote Sync**.
387+
3. In the confirmation dialog, click **Disable**.
388+
389+
- All remote sync settings are cleared, including the repository URL, access token, and branch information.
390+
- Your synced collection and its content remain in your Metabase (they're not deleted).
391+
- The synced collection becomes a regular collection that you can edit like any other collection.
392+
- You can re-enable Remote Sync later by reconnecting to a repository, but any changes you made to the collection after disabling can be overwritten if you enable sync again.
393+
379394
## Migrating existing content to Remote Sync
380395

381396
If you already have content in your Metabase, you can gradually adopt Remote Sync. Content that lives outside the synced collection remains unaffected—you can continue working with it normally while you migrate content into the synced collection over time.

‎_docs/master/installation-and-operation/running-metabase-on-docker.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,8 @@ services:
305305
MB_DB_USER_FILE: /run/secrets/db_user
306306
MB_DB_PASS_FILE: /run/secrets/db_password
307307
MB_DB_HOST: postgres
308+
logging:
309+
driver: local
308310
networks:
309311
- metanet1
310312
secrets:

0 commit comments

Comments
 (0)