Skip to content

[auto-build] sdk-backward-compatibility-poc -> master #326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
6 changes: 3 additions & 3 deletions _docs/master/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ With your data connected, get started asking questions, creating dashboards, and

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

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.
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.

## Documentation topics

Expand Down Expand Up @@ -189,8 +189,8 @@ Metabase's reference documentation.
- [Data permissions](./permissions/data)
- [Collection permissions](./permissions/collections)
- [Application permissions](./permissions/application)
- [Row and column security](./permissions/row-and-column-security)
- [Row and column security examples](./permissions/row-and-column-security-examples)
- [Data sandboxes](./permissions/data-sandboxes)
- [Data sandbox examples](./permissions/data-sandbox-examples)
- [Connection impersonation](./permissions/impersonation)
- [Database routing](./permissions/database-routing)
- [Snippets folder permissions](./permissions/snippets)
Expand Down
657 changes: 291 additions & 366 deletions _docs/master/api.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions _docs/master/configuring-metabase/caching.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ If you select "Don't cache results" for a question, dashboard, or database, Meta

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

> **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.
> **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.

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.

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

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

Expand Down
85 changes: 39 additions & 46 deletions _docs/master/configuring-metabase/config-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ clojure -M:doc:ee config-template

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


```yaml
# A config file template for Metabase.
# You'll need to update (or remove) the `users` and `databases` sections.
Expand All @@ -33,45 +34,45 @@ The template lists example `database`, `user`, and `settings` sections for the [
version: 1
config:
users:
- first_name: First
last_name: Person
password: metabot1
email: [email protected]
- first_name: Normal
last_name: Person
password: metabot1
email: [email protected]
- first_name: Admin
last_name: Person
password: metabot1
is_superuser: true
email: [email protected]
- first_name: First
last_name: Person
password: metabot1
email: [email protected]
- first_name: Normal
last_name: Person
password: metabot1
email: [email protected]
- first_name: Admin
last_name: Person
password: metabot1
is_superuser: true
email: [email protected]
databases:
- name: Sample PostgreSQL
engine: postgres
details:
host: postgres-data
port: 5432
user: metabase
password: metasample123
dbname: sample
- name: Sample MySQL
engine: mysql
details:
host: mysql-data
port: 3306
user: metabase
password: metasample123
dbname: sample
- name: Sample PostgreSQL
engine: postgres
details:
host: postgres-data
port: 5432
user: metabase
password: metasample123
dbname: sample
- name: Sample MySQL
engine: mysql
details:
host: mysql-data
port: 3306
user: metabase
password: metasample123
dbname: sample
api-keys:
- name: Admin API key
group: admin
creator: [email protected]
key: mb_firsttestapikey123
- name: All Users API key
group: all-users
creator: [email protected]
key: mb_secondtestapikey456
- name: Admin API key
group: admin
creator: [email protected]
key: mb_firsttestapikey123
- name: All Users API key
group: all-users
creator: [email protected]
key: mb_secondtestapikey456
settings:
admin-email: null
aggregated-query-row-limit: null
Expand Down Expand Up @@ -128,27 +129,20 @@ config:
ee-openai-api-key: null
ee-openai-model: gpt-4-turbo-preview
email-from-address: [email protected]
email-from-address-override: [email protected]
email-from-name: null
email-max-recipients-per-second: null
email-reply-to: null
email-smtp-host: null
email-smtp-host-override: null
email-smtp-password: null
email-smtp-password-override: null
email-smtp-port: null
email-smtp-port-override: null
email-smtp-security: none
email-smtp-security-override: ssl
email-smtp-username: null
email-smtp-username-override: null
embedding-app-origins-interactive: null
embedding-app-origins-sdk: localhost:*
embedding-homepage: hidden
embedding-secret-key: null
enable-embedding-interactive: false
enable-embedding-sdk: false
enable-embedding-simple: false
enable-embedding-static: false
enable-password-login: true
enable-pivoted-exports: true
Expand All @@ -175,7 +169,7 @@ config:
jwt-identity-provider-uri: null
jwt-shared-secret: null
jwt-user-provisioning-enabled: true
landing-page: ""
landing-page: ''
landing-page-illustration: default
landing-page-illustration-custom: null
ldap-attribute-email: mail
Expand Down Expand Up @@ -264,7 +258,6 @@ config:
site-url: null
slack-app-token: null
slack-bug-report-channel: metabase-bugs
smtp-override-enabled: false
source-address-header: X-Forwarded-For
sql-jdbc-fetch-size: 500
ssh-heartbeat-interval-sec: 180
Expand Down
4 changes: 2 additions & 2 deletions _docs/master/configuring-metabase/email.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Check if [email quotas](https://docs.aws.amazon.com/ses/latest/dg/quotas.html) a

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

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.
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.

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

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

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

## Further reading

Expand Down
78 changes: 0 additions & 78 deletions _docs/master/configuring-metabase/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -437,16 +437,6 @@ This feature is experimental.

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

### `MB_EMAIL_FROM_ADDRESS_OVERRIDE`

> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.

- Type: string
- Default: `[email protected]`
- [Configuration file name](./config-file): `email-from-address-override`

The email address you want to use for the sender of emails from your custom SMTP server.

### `MB_EMAIL_FROM_NAME`

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

The address of the SMTP server that handles your emails.

### `MB_EMAIL_SMTP_HOST_OVERRIDE`

> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.

- Type: string
- Default: `null`
- [Configuration file name](./config-file): `email-smtp-host-override`

The address of the custom SMTP server that handles your emails.

### `MB_EMAIL_SMTP_PASSWORD`

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

SMTP password.

### `MB_EMAIL_SMTP_PASSWORD_OVERRIDE`

> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.

- Type: string
- Default: `null`
- [Configuration file name](./config-file): `email-smtp-password-override`

Custom SMTP server password.

### `MB_EMAIL_SMTP_PORT`

- Type: integer
Expand All @@ -517,16 +487,6 @@ Custom SMTP server password.

The port your SMTP server uses for outgoing emails.

### `MB_EMAIL_SMTP_PORT_OVERRIDE`

> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.

- Type: integer
- Default: `null`
- [Configuration file name](./config-file): `email-smtp-port-override`

The port your custom SMTP server uses for outgoing emails. Only ports 465, 587, and 2525 are supported.

### `MB_EMAIL_SMTP_SECURITY`

- Type: keyword
Expand All @@ -535,16 +495,6 @@ The port your custom SMTP server uses for outgoing emails. Only ports 465, 587,

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

### `MB_EMAIL_SMTP_SECURITY_OVERRIDE`

> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.

- Type: keyword
- Default: `:ssl`
- [Configuration file name](./config-file): `email-smtp-security-override`

SMTP secure connection protocol for your custom server. (tls, ssl, or starttls).

### `MB_EMAIL_SMTP_USERNAME`

- Type: string
Expand All @@ -553,16 +503,6 @@ SMTP secure connection protocol for your custom server. (tls, ssl, or starttls).

SMTP username.

### `MB_EMAIL_SMTP_USERNAME_OVERRIDE`

> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.

- Type: string
- Default: `null`
- [Configuration file name](./config-file): `email-smtp-username-override`

Custom SMTP server username.

### `MB_EMBEDDING_APP_ORIGIN [DEPRECATED]`

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

Allow admins to embed Metabase via the SDK?

### `MB_ENABLE_EMBEDDING_SIMPLE`

- Type: boolean
- Default: `false`
- [Configuration file name](./config-file): `enable-embedding-simple`

Allow admins to embed Metabase via Embedded Analytics JS?

### `MB_ENABLE_EMBEDDING_STATIC`

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

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

### `MB_SMTP_OVERRIDE_ENABLED`

> Only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.

- Type: boolean
- Default: `false`
- [Configuration file name](./config-file): `smtp-override-enabled`

Whether to use the custom SMTP server rather than the standard settings.

### `MB_SOURCE_ADDRESS_HEADER`

- Type: string
Expand Down
2 changes: 1 addition & 1 deletion _docs/master/configuring-metabase/localization.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Report timezone is only supported for the following databases:

### First day of the week

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

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).

Expand Down
1 change: 0 additions & 1 deletion _docs/master/configuring-metabase/slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ It can take a little time for metabase to see all the channels the app has been

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.
If you think this might be the case [visit the app settings in slack](https://api.slack.com/apps/):

- Click on the metabase app in the app listing.
- Click on **OAuth & Permissions** in the sidebar.
- Under **Scopes** add the `groups:read` scope.
Expand Down
15 changes: 7 additions & 8 deletions _docs/master/dashboards/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ There are two basic types of widgets you can add. The type of filter or paramete

### Parameter widgets

**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.
**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.

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

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

1. Click the **pencil icon** to enter dashboard editing mode.
2. You can add a filter or parameter widget to:

- **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.
- **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.
- **Question cards**. Can only be connected to cards on the current tab.

- **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.
- **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.
- **Question cards**. Can only be connected to cards on the current tab.
Go to where you want to add a filter and click the **filter icon**.

3. Select a [filter type](#filter-and-parameter-widgets).
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.
5. [Configure your filter](#editing-a-filter).
Expand Down Expand Up @@ -190,7 +189,7 @@ To undo this auto-connecting of cards, click on the toast that pops up when Meta

## Filtering dashboards with native/SQL questions

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

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

Expand Down
Loading