Skip to content

Commit 43535d7

Browse files
author
Metabase Docs bot
committed
[auto] adding content to convert-index-js-to-ts->master
1 parent df9483e commit 43535d7

Some content is hidden

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

42 files changed

+23627
-820
lines changed

_docs/master/api.html

Lines changed: 9113 additions & 360 deletions
Large diffs are not rendered by default.

_docs/master/configuring-metabase/appearance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,4 +176,4 @@ Metabase will display this illustration when searches don't return any results.
176176

177177
- [Customer-facing analytics](/learn/metabase-basics/embedding).
178178
- [Embedding introduction](../embedding/start).
179-
- [Brand your Metabase](/learn/metabase-basics/embedding/brand).
179+
- [Brand your Metabase](/docs/latest/configuring-metabase/appearance).

_docs/master/configuring-metabase/setting-up-metabase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Don't worry about picking the wrong option. If you say you're interested in embe
4343

4444
## Gathering your database info
4545

46-
At this point you’ll need to gather some information about the database you want to use with Metabase. We won’t be able to connect to your database without it, but you’d like to deal with all of this later, that’s okay: just click **I’ll add my data later**. Metabase comes with a [Sample Database](/glossary/sample_database) that you can play around with to get a feel for how Metabase works.
46+
At this point you’ll need to gather some information about the database you want to use with Metabase. We won’t be able to connect to your database without it, but you’d like to deal with all of this later, that’s okay: just click **I’ll add my data later**. Metabase comes with a [Sample Database](/glossary/sample-database) that you can play around with to get a feel for how Metabase works.
4747

4848
If you’re ready to connect, here’s what you’ll need:
4949

_docs/master/databases/connecting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Go to **Admin settings** > **Databases** > your database and click **Remove this
7676

7777
## Restoring the Sample Database
7878

79-
If you've deleted the Metabase [Sample Database](/glossary/sample_database), go to **Admin settings** > **Databases** and click **Bring the Sample Database back**.
79+
If you've deleted the Metabase [Sample Database](/glossary/sample-database), go to **Admin settings** > **Databases** and click **Bring the Sample Database back**.
8080

8181
## Troubleshooting
8282

_docs/master/embedding/interactive-embedding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ redirect_from:
2020

2121
**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).
2222

23-
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.
23+
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.
2424

2525
## Interactive embedding demo
2626

_docs/master/embedding/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ If you'd like to share your data with the good people of the internet, admins ca
5353
| Restrict data with [locked filters](./static-embedding-parameters#restricting-data-in-a-static-embed-with-locked-parameters) |||||
5454
| Restrict data with [sandboxes](../permissions/data-sandboxes) |||||
5555
| Use the [drill-through menu](/learn/metabase-basics/querying-and-dashboards/questions/drill-through) |||||
56-
| Self-serve via [query builder](/glossary/query_builder) |||||
56+
| Self-serve via [query builder](/glossary/query-builder) |||||
5757
| View usage of embeds with [usage analytics](../usage-and-performance-tools/usage-analytics) |||||
5858
| [Actions on dashboards](../dashboards/actions) |||||
5959
| Embed individual Metabase components |||||

_docs/master/embedding/sdk/upgrade.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
version: master
3+
has_magic_breadcrumbs: true
4+
show_category_breadcrumb: true
5+
show_title_breadcrumb: true
6+
category: Embedding
7+
title: 'Upgrading Metabase and the Embedded analytics SDK'
8+
source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/upgrade.md'
9+
layout: new-docs
10+
summary: 'How to upgrade your Metabase and Embedded analytics SDK versions, test the changes, and check for breaking changes that might affect your app.'
11+
---
12+
13+
# Upgrading Metabase and the Embedded analytics SDK
14+
15+
Here's a basic overview of the steps you'll want to take when upgrading your SDK.
16+
17+
## 1. Read the release post and changelog for both Metabase and the Embedded analytics SDK
18+
19+
- [Release posts](/releases) give a good overview of what's in each release, and call out breaking changes (which are rare).
20+
- [Metabase changelogs](/changelog) list Metabase changes.
21+
- [Embedded analytics SDK changelogs](/changelog/55) list changes specific to the SDK package.
22+
23+
Check for any relevant changes, especially breaking changes that require you to update your application's code. If there are breaking changes, we'll have docs that'll walk you through what changes you'll need to make and why.
24+
25+
## 2. Test the upgrade
26+
27+
When upgrading to a new major version, you'll want to upgrade both Metabase and the SDK version in parallel, as having Metabase and the SDK major versions out of sync can cause errors.
28+
29+
### Spin up the new version of Metabase for testing
30+
31+
You can do this locally or in a dev instance. If your testing setup involves a lot of test user accounts, getting a [development instance](../../installation-and-operation/development-instance) could be more cost-effective.
32+
33+
See [upgrading Metabase](../../installation-and-operation/upgrading-metabase).
34+
35+
### Upgrade the SDK with npm or yarn
36+
37+
You'll want to test the changes locally first, as there may be breaking changes that require you to upgrade your application code.
38+
39+
Check out a new branch in your application and install the next stable version, either with npm or yarn:
40+
41+
Via npm:
42+
43+
```bash
44+
npm install @metabase/embedding-sdk-react@{next-major-version-number}-stable
45+
```
46+
47+
For example, if you were upgrading to version 55 of the SDK:
48+
49+
```bash
50+
npm install @metabase/embedding-sdk-react@55-stable
51+
```
52+
53+
If you're using yarn:
54+
55+
```bash
56+
yarn add @metabase/embedding-sdk-react@{next-major-version-number}-stable
57+
```
58+
59+
See more on [SDK versions](./version).
60+
61+
### If there are breaking changes, make the necessary changes to your application code
62+
63+
Breaking changes are rare, but if you do need to make changes, we'll mention it in the release notes for the new major version and have docs that walk you through the changes.
64+
65+
Update or add tests for any application code changes that you make.
66+
67+
### Deploy to your staging environment
68+
69+
Before deploying your app to your staging environment, make sure you've tested your app locally (manually, as well as running any automated tests).
70+
71+
If all goes well with your local tests, deploy to your staging environment. Check that the Metabase embeds in your staging app are still working as expected, and perform any other testing you normally do with your application with respect to your embedded analytics.
72+
73+
## 3. Deploy to production
74+
75+
If everything is working in staging, you're ready to deploy to production.
76+
77+
Be sure to deploy your application changes and upgrade your Metabase in parallel so that the SDK version and the Metabase version stay in sync.
78+
79+
### If your instance is on Metabase Cloud, you'll need to request an upgrade
80+
81+
If you're on Metabase Cloud, your instance version is pinned, so you'll need to request an upgrade by [contacting support](/help-premium).
82+
83+
We'll coordinate with you so that your instance is upgraded when you deploy the changes to your application.

_docs/master/embedding/sdk/version.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,35 +15,32 @@ layout: new-docs
1515

1616
The SDK stable version tracks with the Metabase version.
1717

18-
So, for example, if you're on Metabase 53 (`0.53.x`, `1.53.x`), _any_ version 0.53.x of the @metabase/embedding-sdk-react npm package will be compatible.
18+
So, for example, if you're on Metabase 55 (`0.55.x`, `1.55.x`), _any_ version 0.55.x of the @metabase/embedding-sdk-react npm package will be compatible.
1919

20-
To simplify things, we publish dist-tags for each stable Metabase version. For example, to install the latest version of the SDK compatible with Metabase 53, run:
20+
To simplify things, we publish dist-tags for each stable Metabase version. For example, to install the latest version of the SDK compatible with Metabase 55, run:
2121

2222
```sh
23-
npm install @metabase/embedding-sdk-react@53-stable
23+
npm install @metabase/embedding-sdk-react@55-stable
2424
```
2525

2626
To grab the latest version of the SDK that works with Metabase nightly builds, use the `canary` dist-tag.
2727

2828
## Minimum SDK version
2929

30-
52 is the minimum version supported for the Embedded analytics SDK.
30+
Version 52 is the minimum version supported for the Embedded analytics SDK.
3131

32-
## Version pinning when using the SDK with Metabase Cloud
32+
## Instances on Metabase Cloud will be pinned to a specific version
3333

34-
To pin your version of Metabase, go to **Admin settings > Settings > Embedding**. Go to the Embedded analytics SDK card and scroll to **Version pinning** and click **Request version pinning**.
34+
By default, if you're running on Metabase Cloud and using the Embedded analytics SDK, we'll pin your version to avoid breaking changes.
3535

36-
## Version pinning requirements
36+
Normally, Metabase Cloud upgrades your Metabase as new versions roll out so you don't have to deal with upgrades. But if you're using the SDK with Metabase Cloud, you'll want to upgrade manually to make sure your embeds don't break when you upgrade both your Metabase and your SDK version.
3737

38-
To pin a version of Metabase, you must:
38+
### Manually pinning your instance version on Metabase Cloud
3939

40-
- Be on Metabase Cloud (obviously)
41-
- Be on the Pro or Enterprise plans
40+
To manually pin your version of Metabase:
4241

43-
## Why you'd want to pin your Metabase Cloud version
42+
1. Go to **Admin settings > Settings > Embedding**.
43+
2. Go to the Embedded analytics SDK card.
44+
3. Scroll to **Version pinning** and click **Request version pinning**.
4445

45-
Normally, Metabase Cloud upgrades your Metabase as new versions roll out so that you don't have to deal with upgrades.
46-
47-
But if you're using the SDK with Metabase Cloud, you'll want to upgrade manually to make sure your embeds don't break when you upgrade both your Metabase and your SDK version.
48-
49-
To upgrade manually, you can pin your Metabase version so that it stays in sync with the SDK version you're using. That way you can choose when to upgrade your Metabase.
46+
This will open a mailto link to our support team.

_docs/master/installation-and-operation/upgrading-metabase.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,15 @@ redirect_from:
1313

1414
# Upgrading Metabase
1515

16-
This page covers how to upgrade to a new [Metabase release](https://github.com/metabase/metabase/releases).
16+
This page covers how to upgrade to a new Metabase release.
17+
18+
- [Announcement posts for major releases](https://www.)
19+
- [Changelogs](/changelog).
20+
- [Release notes on GitHub](https://github.com/metabase/metabase/releases).
1721

1822
## Upgrading Metabase Cloud
1923

20-
If you're on a [Metabase Cloud](/pricing/) plan, we'll upgrade your Metabase automatically with each new release; no action needed on your end.
24+
If you're on a [Metabase Cloud](/pricing/) plan, we'll upgrade your Metabase automatically with each new release; no action needed on your end ([unless you're using the Embedded analytics SDK](#instances-using-the-embedded-analtyics-sdk-on-metabase-cloud-must-request-an-upgrade)).
2125

2226
How soon we upgrade you depends on the type of release:
2327

@@ -26,6 +30,14 @@ How soon we upgrade you depends on the type of release:
2630

2731
Cloud customers can request an early upgrade by emailing support at [email protected]. Include the URL of the Metabase you want us to upgrade.
2832

33+
### Instances using the Embedded analtyics SDK on Metabase Cloud must request an upgrade
34+
35+
If you're using the [Embedded analytics SDK](../embedding/sdk/introduction) on Metabase Cloud, we pin your version so that it doesn't upgrade automatically, as you should test the changes before upgrading.
36+
37+
To upgrade your Metabase, you'll need to request an upgrade by [contacting support](/help-premium).
38+
39+
See our [upgrade guide for the Embedded analytics SDK](../embedding/sdk/upgrade).
40+
2941
## Upgrading a self-hosted Metabase
3042

3143
Here are the steps for upgrading to a new Metabase version (major or minor):

_docs/master/permissions/impersonation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ layout: new-docs
1313

1414
{% include plans-blockquote.html feature="Impersonation access" %}
1515

16-
> For now, impersonation access is only available for MySQL, PostgreSQL, Redshift, Snowflake, and SQL Server. If you want to switch database _connections_ based on who is logged in, check out [Database routing](./database-routing).
16+
> For now, impersonation access is only available for ClickHouse, MySQL, PostgreSQL, Redshift, Snowflake, and SQL Server. If you want to switch database _connections_ based on who is logged in, check out [Database routing](./database-routing).
1717
1818
> If you're using views in PostgresSQL, the row-level security policies on views will only work on Postgres versions 15 and higher.
1919

0 commit comments

Comments
 (0)