Skip to content

Commit 72e2b4d

Browse files
author
Metabase Docs bot
committed
[auto] adding content to docs-rc-notes->master
1 parent 3cdeb36 commit 72e2b4d

File tree

380 files changed

+23656
-12314
lines changed

Some content is hidden

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

380 files changed

+23656
-12314
lines changed

_docs/master/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ With your data connected, get started asking questions, creating dashboards, and
4242

4343
### [A tour of Metabase](/learn/metabase-basics/overview/tour-of-metabase)
4444

45-
Metabase is a deep product with a lot of tools to simplify business intelligence, from embeddable charts and interactive dashboards, to GUI and SQL editors, to auditing and data sandboxing, and more.
45+
Metabase is a deep product with a lot of tools to simplify business intelligence, from embeddable charts and interactive dashboards, to GUI and SQL editors, to auditing and row and column security, and more.
4646

4747
## Documentation topics
4848

@@ -189,8 +189,8 @@ Metabase's reference documentation.
189189
- [Data permissions](./permissions/data)
190190
- [Collection permissions](./permissions/collections)
191191
- [Application permissions](./permissions/application)
192-
- [Data sandboxes](./permissions/data-sandboxes)
193-
- [Data sandbox examples](./permissions/data-sandbox-examples)
192+
- [Row and column security](./permissions/row-and-column-security)
193+
- [Row and column security examples](./permissions/row-and-column-security-examples)
194194
- [Connection impersonation](./permissions/impersonation)
195195
- [Database routing](./permissions/database-routing)
196196
- [Snippets folder permissions](./permissions/snippets)

_docs/master/api.html

Lines changed: 368 additions & 293 deletions
Large diffs are not rendered by default.

_docs/master/configuring-metabase/caching.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ If you select "Don't cache results" for a question, dashboard, or database, Meta
8181

8282
{% include plans-blockquote.html feature="Refresh cache automatically" %}
8383

84-
> **Refreshing the cache automatically doesn't apply when [data sandboxing](../permissions/data-sandboxes) or [connection impersonation](../permissions/impersonation) permissions are in effect.** In those permissions setups, Metabase ignores the automatically generated cache and runs a fresh query (which it will then cache). So _caching_ still works for sandboxing and impersonation, it's just that this preemptive, automatic caching doesn't apply in these cases, as those permissions setups filter data specific to each viewer.
84+
> **Refreshing the cache automatically doesn't apply when [row and column security](../permissions/row-and-column-security) or [connection impersonation](../permissions/impersonation) permissions are in effect.** In those permissions setups, Metabase ignores the automatically generated cache and runs a fresh query (which it will then cache). So _caching_ still works for row and column security and impersonation, it's just that this preemptive, automatic caching doesn't apply in these cases, as those permissions setups filter data specific to each viewer.
8585
8686
If you turn on refresh cache automatically for a question or dashboard, Metabase will rerun the query/queries as soon as the cache is invalidated by whichever caching policy you've set. Normally, Metabase only refreshes the cache when someone views the item _after_ its cache has expired. So, normally, when the cache has expired, the next person to view the question will be stuck waiting for the query to run and refresh the cache. But by automatically refreshing results to update the cache, the loading times will always be as fast as possible, and people will always get valid, cached results.
8787

@@ -144,8 +144,8 @@ To set a caching policy for a question, you must have [curate access](../permiss
144144
1. Go to your question.
145145
2. Click on the three-dot menu **...** and select **Edit settings**.
146146
3. Under **Caching**, select the [caching invalidation policy](#cache-invalidation-policies).
147-
5. Optional: if you select a Duration or Schedule policy, you'll have the option to [refresh cache automatically](#refresh-cache-automatically).
148-
6. Save your changes.
147+
4. Optional: if you select a Duration or Schedule policy, you'll have the option to [refresh cache automatically](#refresh-cache-automatically).
148+
5. Save your changes.
149149

150150
## How dashboard, question, database, and default caching policies interact
151151

_docs/master/configuring-metabase/config-template.md

Lines changed: 46 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ clojure -M:doc:ee config-template
1919

2020
The template lists example `database`, `user`, and `settings` sections for the [config file](./config-file).
2121

22-
2322
```yaml
2423
# A config file template for Metabase.
2524
# You'll need to update (or remove) the `users` and `databases` sections.
@@ -34,45 +33,45 @@ The template lists example `database`, `user`, and `settings` sections for the [
3433
version: 1
3534
config:
3635
users:
37-
- first_name: First
38-
last_name: Person
39-
password: metabot1
40-
41-
- first_name: Normal
42-
last_name: Person
43-
password: metabot1
44-
45-
- first_name: Admin
46-
last_name: Person
47-
password: metabot1
48-
is_superuser: true
49-
36+
- first_name: First
37+
last_name: Person
38+
password: metabot1
39+
40+
- first_name: Normal
41+
last_name: Person
42+
password: metabot1
43+
44+
- first_name: Admin
45+
last_name: Person
46+
password: metabot1
47+
is_superuser: true
48+
5049
databases:
51-
- name: Sample PostgreSQL
52-
engine: postgres
53-
details:
54-
host: postgres-data
55-
port: 5432
56-
user: metabase
57-
password: metasample123
58-
dbname: sample
59-
- name: Sample MySQL
60-
engine: mysql
61-
details:
62-
host: mysql-data
63-
port: 3306
64-
user: metabase
65-
password: metasample123
66-
dbname: sample
50+
- name: Sample PostgreSQL
51+
engine: postgres
52+
details:
53+
host: postgres-data
54+
port: 5432
55+
user: metabase
56+
password: metasample123
57+
dbname: sample
58+
- name: Sample MySQL
59+
engine: mysql
60+
details:
61+
host: mysql-data
62+
port: 3306
63+
user: metabase
64+
password: metasample123
65+
dbname: sample
6766
api-keys:
68-
- name: Admin API key
69-
group: admin
70-
71-
key: mb_firsttestapikey123
72-
- name: All Users API key
73-
group: all-users
74-
75-
key: mb_secondtestapikey456
67+
- name: Admin API key
68+
group: admin
69+
70+
key: mb_firsttestapikey123
71+
- name: All Users API key
72+
group: all-users
73+
74+
key: mb_secondtestapikey456
7675
settings:
7776
admin-email: null
7877
aggregated-query-row-limit: null
@@ -129,20 +128,27 @@ config:
129128
ee-openai-api-key: null
130129
ee-openai-model: gpt-4-turbo-preview
131130
email-from-address: [email protected]
131+
email-from-address-override: [email protected]
132132
email-from-name: null
133133
email-max-recipients-per-second: null
134134
email-reply-to: null
135135
email-smtp-host: null
136+
email-smtp-host-override: null
136137
email-smtp-password: null
138+
email-smtp-password-override: null
137139
email-smtp-port: null
140+
email-smtp-port-override: null
138141
email-smtp-security: none
142+
email-smtp-security-override: ssl
139143
email-smtp-username: null
144+
email-smtp-username-override: null
140145
embedding-app-origins-interactive: null
141146
embedding-app-origins-sdk: localhost:*
142147
embedding-homepage: hidden
143148
embedding-secret-key: null
144149
enable-embedding-interactive: false
145150
enable-embedding-sdk: false
151+
enable-embedding-simple: false
146152
enable-embedding-static: false
147153
enable-password-login: true
148154
enable-pivoted-exports: true
@@ -169,7 +175,7 @@ config:
169175
jwt-identity-provider-uri: null
170176
jwt-shared-secret: null
171177
jwt-user-provisioning-enabled: true
172-
landing-page: ''
178+
landing-page: ""
173179
landing-page-illustration: default
174180
landing-page-illustration-custom: null
175181
ldap-attribute-email: mail
@@ -258,6 +264,7 @@ config:
258264
site-url: null
259265
slack-app-token: null
260266
slack-bug-report-channel: metabase-bugs
267+
smtp-override-enabled: false
261268
source-address-header: X-Forwarded-For
262269
sql-jdbc-fetch-size: 500
263270
ssh-heartbeat-interval-sec: 180

_docs/master/configuring-metabase/email.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Check if [email quotas](https://docs.aws.amazon.com/ses/latest/dg/quotas.html) a
146146

147147
Allowed email address domain(s) for new [dashboard subscriptions](../dashboards/subscriptions) and [alerts](../questions/alerts).
148148

149-
Adding approved domains allows you to restrict which email addresses people can send alerts and subscriptions to. This restriction only applies to sending email to people who lack an account with that Metabase. People with Metabase accounts who aren't [sandboxed](../permissions/data-sandboxes) will be able to email any other person with an account in that same Metabase.
149+
Adding approved domains allows you to restrict which email addresses people can send alerts and subscriptions to. This restriction only applies to sending email to people who lack an account with that Metabase. People with Metabase accounts who aren't [restricted by row or column security](../permissions/row-and-column-security) will be able to email any other person with an account in that same Metabase.
150150

151151
To allow all domains, leave the field empty (allowing all domains is the default).
152152

@@ -168,7 +168,7 @@ Options include:
168168
- Only suggest users in the same groups
169169
- Don't show suggestions
170170

171-
People who are sandboxed won't see suggestions.
171+
People with [row or column restrictions](../permissions/row-and-column-security) won't see suggestions.
172172

173173
## Further reading
174174

_docs/master/configuring-metabase/environment-variables.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -437,6 +437,16 @@ This feature is experimental.
437437

438438
The email address you want to use for the sender of emails.
439439

440+
### `MB_EMAIL_FROM_ADDRESS_OVERRIDE`
441+
442+
> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.
443+
444+
- Type: string
445+
- Default: `[email protected]`
446+
- [Configuration file name](./config-file): `email-from-address-override`
447+
448+
The email address you want to use for the sender of emails from your custom SMTP server.
449+
440450
### `MB_EMAIL_FROM_NAME`
441451

442452
- Type: string
@@ -471,6 +481,16 @@ The email address you want the replies to go to, if different from the from addr
471481

472482
The address of the SMTP server that handles your emails.
473483

484+
### `MB_EMAIL_SMTP_HOST_OVERRIDE`
485+
486+
> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.
487+
488+
- Type: string
489+
- Default: `null`
490+
- [Configuration file name](./config-file): `email-smtp-host-override`
491+
492+
The address of the custom SMTP server that handles your emails.
493+
474494
### `MB_EMAIL_SMTP_PASSWORD`
475495

476496
- Type: string
@@ -479,6 +499,16 @@ The address of the SMTP server that handles your emails.
479499

480500
SMTP password.
481501

502+
### `MB_EMAIL_SMTP_PASSWORD_OVERRIDE`
503+
504+
> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.
505+
506+
- Type: string
507+
- Default: `null`
508+
- [Configuration file name](./config-file): `email-smtp-password-override`
509+
510+
Custom SMTP server password.
511+
482512
### `MB_EMAIL_SMTP_PORT`
483513

484514
- Type: integer
@@ -487,6 +517,16 @@ SMTP password.
487517

488518
The port your SMTP server uses for outgoing emails.
489519

520+
### `MB_EMAIL_SMTP_PORT_OVERRIDE`
521+
522+
> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.
523+
524+
- Type: integer
525+
- Default: `null`
526+
- [Configuration file name](./config-file): `email-smtp-port-override`
527+
528+
The port your custom SMTP server uses for outgoing emails. Only ports 465, 587, and 2525 are supported.
529+
490530
### `MB_EMAIL_SMTP_SECURITY`
491531

492532
- Type: keyword
@@ -495,6 +535,16 @@ The port your SMTP server uses for outgoing emails.
495535

496536
SMTP secure connection protocol. (tls, ssl, starttls, or none).
497537

538+
### `MB_EMAIL_SMTP_SECURITY_OVERRIDE`
539+
540+
> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.
541+
542+
- Type: keyword
543+
- Default: `:ssl`
544+
- [Configuration file name](./config-file): `email-smtp-security-override`
545+
546+
SMTP secure connection protocol for your custom server. (tls, ssl, or starttls).
547+
498548
### `MB_EMAIL_SMTP_USERNAME`
499549

500550
- Type: string
@@ -503,6 +553,16 @@ SMTP secure connection protocol. (tls, ssl, starttls, or none).
503553

504554
SMTP username.
505555

556+
### `MB_EMAIL_SMTP_USERNAME_OVERRIDE`
557+
558+
> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.
559+
560+
- Type: string
561+
- Default: `null`
562+
- [Configuration file name](./config-file): `email-smtp-username-override`
563+
564+
Custom SMTP server username.
565+
506566
### `MB_EMBEDDING_APP_ORIGIN [DEPRECATED]`
507567

508568
> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.
@@ -579,6 +639,14 @@ Allow admins to embed Metabase via interactive embedding?
579639

580640
Allow admins to embed Metabase via the SDK?
581641

642+
### `MB_ENABLE_EMBEDDING_SIMPLE`
643+
644+
- Type: boolean
645+
- Default: `false`
646+
- [Configuration file name](./config-file): `enable-embedding-simple`
647+
648+
Allow admins to embed Metabase via Embedded Analytics JS?
649+
582650
### `MB_ENABLE_EMBEDDING_STATIC`
583651

584652
- Type: boolean
@@ -1650,6 +1718,16 @@ The name of the channel where bug reports should be posted.
16501718

16511719
The name of the channel to which Metabase files should be initially uploaded.
16521720

1721+
### `MB_SMTP_OVERRIDE_ENABLED`
1722+
1723+
> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.
1724+
1725+
- Type: boolean
1726+
- Default: `false`
1727+
- [Configuration file name](./config-file): `smtp-override-enabled`
1728+
1729+
Whether to use the custom SMTP server rather than the standard settings.
1730+
16531731
### `MB_SOURCE_ADDRESS_HEADER`
16541732

16551733
- Type: string

_docs/master/configuring-metabase/localization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Report timezone is only supported for the following databases:
121121

122122
### First day of the week
123123

124-
If you need to, you can change the first day of the week for your instance (the default is Sunday).
124+
If you need to, you can change the first day of the week for your instance (the default is Sunday).
125125

126126
Setting the first day of the week affects how the [query builder](../questions/query-builder/editor) filters or groups by week. People can, however, use the `week` function to override this default when filtering or grouping by week of year. See [using a different first week of the year](../questions/query-builder/expressions/week#using-a-different-first-week-of-the-year).
127127

_docs/master/configuring-metabase/slack.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ It can take a little time for metabase to see all the channels the app has been
9191

9292
In order for metabase to see private channels, the app must have the `groups:read` oauth scope. Although this scope should be granted when setting up the app through metabase, older installations might not have this scope.
9393
If you think this might be the case [visit the app settings in slack](https://api.slack.com/apps/):
94+
9495
- Click on the metabase app in the app listing.
9596
- Click on **OAuth & Permissions** in the sidebar.
9697
- Under **Scopes** add the `groups:read` scope.

_docs/master/dashboards/filters.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ There are two basic types of widgets you can add. The type of filter or paramete
3535

3636
### Parameter widgets
3737

38-
**Parameters** determine _how_ to show the data. The time grouping parameter, for example, changes the granularity of time-based visualizations (like showing data by month instead of by day) without removing any data points.
38+
**Parameters** determine _how_ to show the data. The time grouping parameter, for example, changes the granularity of time-based visualizations (like showing data by month instead of by day) without removing any data points.
3939

4040
- [Time grouping](#time-grouping-parameter)
4141

@@ -45,12 +45,13 @@ There are two basic types of widgets you can add. The type of filter or paramete
4545

4646
1. Click the **pencil icon** to enter dashboard editing mode.
4747
2. You can add a filter or parameter widget to:
48-
49-
- **The whole dashboard**. You'll need to connect these dashboard-level filters to individual cards. Metabase will only display dashboard-level widgets if they're connected to a card on the current tab.
50-
- **Heading cards**. Not text cards, only [heading cards](./introduction#adding-headings-or-descriptions-with-text-cards). Can only be connected to cards on the current tab.
51-
- **Question cards**. Can only be connected to cards on the current tab.
52-
48+
49+
- **The whole dashboard**. You'll need to connect these dashboard-level filters to individual cards. Metabase will only display dashboard-level widgets if they're connected to a card on the current tab.
50+
- **Heading cards**. Not text cards, only [heading cards](./introduction#adding-headings-or-descriptions-with-text-cards). Can only be connected to cards on the current tab.
51+
- **Question cards**. Can only be connected to cards on the current tab.
52+
5353
Go to where you want to add a filter and click the **filter icon**.
54+
5455
3. Select a [filter type](#filter-and-parameter-widgets).
5556
4. [Connect your filter or parameter widget to one or more dashboard cards](#connecting-a-filter-or-parameter-widget-to-dashboard-cards). Only dashboard-level widgets can be connected to cards on multiple tabs.
5657
5. [Configure your filter](#editing-a-filter).
@@ -189,7 +190,7 @@ To undo this auto-connecting of cards, click on the toast that pops up when Meta
189190

190191
## Filtering dashboards with native/SQL questions
191192

192-
For filters, you'll need to [add a variable or field filter to your query](../questions/native-editor/sql-parameters).
193+
For filters, you'll need to [add a variable or field filter to your query](../questions/native-editor/sql-parameters).
193194

194195
For parameters, check out [Time grouping parameters](../questions/native-editor/time-grouping-parameters).
195196

0 commit comments

Comments
 (0)