Skip to content

[auto-build] backport-56-e62c8f1fff647793dd41f73a19fa70f27c159ab9 -> release-x.56.x #379

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 2 commits 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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions _docs/v0.56/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 data sandboxing, 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 row and column security, 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)
- [Data sandboxes](./permissions/data-sandboxes)
- [Data sandbox examples](./permissions/data-sandbox-examples)
- [Row and column security](./permissions/row-and-column-security)
- [Row and column security examples](./permissions/row-and-column-security-examples)
- [Connection impersonation](./permissions/impersonation)
- [Database routing](./permissions/database-routing)
- [Snippets folder permissions](./permissions/snippets)
Expand Down
6 changes: 3 additions & 3 deletions _docs/v0.56/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 [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.
> **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.

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

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

Expand Down
77 changes: 38 additions & 39 deletions _docs/v0.56/configuring-metabase/config-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ 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 @@ -34,45 +33,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 @@ -176,7 +175,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
4 changes: 2 additions & 2 deletions _docs/v0.56/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 [sandboxed](../permissions/data-sandboxes) 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 [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.

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 who are sandboxed won't see suggestions.
People with [row or column restrictions](../permissions/row-and-column-security) won't see suggestions.

## Further reading

Expand Down
2 changes: 1 addition & 1 deletion _docs/v0.56/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: 1 addition & 0 deletions _docs/v0.56/configuring-metabase/slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ 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: 8 additions & 7 deletions _docs/v0.56/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,12 +45,13 @@ 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 @@ -189,7 +190,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
6 changes: 3 additions & 3 deletions _docs/v0.56/dashboards/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ You can change the width of a dashboard by going into the three dots menu in the
- **Fixed width** (default). Metabase will restrict the layout to a fixed width in the center of the screen. This fixed width can keep dashboard layouts consistent between smaller laptop screens and larger desktop screens.
- **Full width**. The layout and cards will expand to take up the full width of the screen.

## Editing dashboard cards
## Editing dashboard cards

To edit a card's:

Expand Down Expand Up @@ -274,7 +274,7 @@ If you want to revert a dashboard card to its original visualization settings (i

1. Go to your dashboard and click the **pencil icon** to go into edit mode.
2. Hover over the card (question) that you want to edit.
3. Click the **palette icon** to bring up the visualization settings for that card.
3. Click the **palette icon** to bring up the visualization settings for that card.
4. Click **Reset to defaults** (bottom right).
5. Click **Done** to save the card's visualization settings.
6. Click **Save** to save the dashboard.
Expand Down Expand Up @@ -318,7 +318,7 @@ If your Metabase administrator has enabled [public sharing](../embedding/public-

![Share icon](./images/share-icon.png)

Public links can be viewed by anyone, even if they don't have access to Metabase. You can also use the public embedding code to embed your question or dashboard in a simple web page or blog post. Check out examples of simple apps with embedded dashboards in our [embedding-reference-apps repository](https://github.com/metabase/embedding-reference-apps). To learn more about [embedding](../embedding/introduction), check out our article on [How to use Metabase to deliver analytics to your customers](/learn/metabase-basics/embedding/overview), as well as an article on how to combine branding, Single Sign-On, full app embedding, and data sandboxing to deliver [multi-tenant, self-service analytics](/learn/metabase-basics/embedding/multi-tenant-self-service-analytics).
Public links can be viewed by anyone, even if they don't have access to Metabase. You can also use the public embedding code to embed your question or dashboard in a simple web page or blog post. Check out examples of simple apps with embedded dashboards in our [embedding-reference-apps repository](https://github.com/metabase/embedding-reference-apps). To learn more about [embedding](../embedding/introduction), check out our article on [How to use Metabase to deliver analytics to your customers](/learn/metabase-basics/embedding/overview), as well as an article on how to combine branding, Single Sign-On, full app embedding, and row and column security to deliver [multi-tenant, self-service analytics](/learn/metabase-basics/embedding/multi-tenant-self-service-analytics).

## Exporting results from a dashboard

Expand Down
2 changes: 1 addition & 1 deletion _docs/v0.56/dashboards/multiple-series.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ You can layer multiple questions on a single dashboard card. You can even layer

![Edit visualization](./images/edit-visualization.png)

4. **Add more data**. In the Manage data sidebar on the left, click on **Add more data**.
4. **Add more data**. In the Manage data sidebar on the left, click on **Add more data**.

![Manage data sidebar](./images/add-data.png)

Expand Down
10 changes: 5 additions & 5 deletions _docs/v0.56/data-modeling/formatting.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You can override the global defaults for a specific field by going to the `Table

## Formatting options depend on the data type and the semantic type

The options you'll see here will depend on the field's data type and it's [semantic type](./semantic-types).
The options you'll see here will depend on the field's data type and it's [semantic type](./semantic-types).

## Text formatting options

Expand All @@ -38,11 +38,11 @@ Options depend on the [semantic type](./semantic-types) you select for the field

### Align

Whether to display the values in the middle, left, or right in table cells.
Whether to display the values in the middle, left, or right in table cells.

### Display As

If you have text, like an image URL, you may need to change the semantic type before Metabase will offer you the option to display the text as an image.
If you have text, like an image URL, you may need to change the semantic type before Metabase will offer you the option to display the text as an image.

- Text (display "as is").
- Email link (i.e., if you have a `mailto` link).
Expand Down Expand Up @@ -94,7 +94,7 @@ This lets you choose if this time field should be displayed by default without t

- **Off** - Display only the date without time
- **HH:MM** - Display hours and minutes
- **HH:MM:SS** - Display hours, minutes, and seconds
- **HH:MM:SS** - Display hours, minutes, and seconds
- **HH:MM:SS.MS** - Display hours, minutes, seconds, and milliseconds

### Time style
Expand Down Expand Up @@ -129,7 +129,7 @@ Only applies to table visualizations. Displays a bar for each value to show larg
Lets you choose to display the number as a plain number, a percent, in scientific notation, or as a currency.

- **Normal** - Display as a regular number
- **Percent** - Display as a percentage
- **Percent** - Display as a percentage
- **Scientific notation** - Display in scientific format (e.g., 1.23e+4)
- **Currency** - Display with currency formatting

Expand Down
2 changes: 1 addition & 1 deletion _docs/v0.56/data-modeling/model-persistence.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Metabase can persist the results of your models so that your models (and the que

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.

> Model persistence doesn't work with [data sandboxing](../permissions/data-sandboxes) or [impersonation](../permissions/impersonation).
> Model persistence doesn't work with [row and column security](../permissions/row-and-column-security) or [impersonation](../permissions/impersonation).

## Turn on model persistence in Metabase

Expand Down
4 changes: 2 additions & 2 deletions _docs/v0.56/data-modeling/segments.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ layout: new-docs

# Segments

Metabase allows admins to create segments so people can quickly and easily reference them in the query builder.
Metabase allows admins to create segments so people can quickly and easily reference them in the query builder.

To manage segments:

1. Click the **gear** icon in the upper right.
2. Select **Admin setting**.
3. Go to the **Table Metadata** tab.
5. Click **Segments** at the bottom left.
4. Click **Segments** at the bottom left.

## Creating a Segment

Expand Down
10 changes: 5 additions & 5 deletions _docs/v0.56/databases/sync-scan.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,11 +176,11 @@ To reduce the number of tables and fields Metabase needs to scan in order to sta

Here's the kind of data that scans get and why:

| What | Why |
| ---------------------------------------------- | ---------------------------------------- |
| Distinct values for category fields | Dropdown filter UI instead of text entry |
| Cached values for active fields | Improves filter UI experience |
| Advanced field values (with filtering context) | Values when the data is sandboxed |
| What | Why |
| ---------------------------------------------- | ------------------------------------------------------------ |
| Distinct values for category fields | Dropdown filter UI instead of text entry |
| Cached values for active fields | Improves filter UI experience |
| Advanced field values (with filtering context) | Values when the data is restricted by row or column security |

## Periodically refingerprint tables

Expand Down
3 changes: 2 additions & 1 deletion _docs/v0.56/developers-guide/api-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,14 @@ layout: new-docs
thing.

- `GET /api/util/diagnostic_info/connection_pool_info` has been renamed to `GET
/api/bug-reporting/connection-pool-details`.
/api/bug-reporting/connection-pool-details`.

## Metabase 0.54.0

- The alert system has been migrated from the legacy pulse infrastructure to the new notification system. This migration includes the following changes:

- The majority of `/api/alert` endpoints have been removed in favor of the new `/api/notification` endpoints. For backward compatibility, these endpoints will remain available until the next release:

- `GET /api/alert`
- `GET /api/alert/:id`
- `DELETE /api/alert/:id/subscription`
Expand Down
Loading