Skip to content

[auto-build] convert-index-js-to-ts -> master #346

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
9,473 changes: 9,113 additions & 360 deletions _docs/master/api.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _docs/master/configuring-metabase/appearance.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,4 +176,4 @@ Metabase will display this illustration when searches don't return any results.

- [Customer-facing analytics](/learn/metabase-basics/embedding).
- [Embedding introduction](../embedding/start).
- [Brand your Metabase](/learn/metabase-basics/embedding/brand).
- [Brand your Metabase](/docs/latest/configuring-metabase/appearance).
2 changes: 1 addition & 1 deletion _docs/master/configuring-metabase/setting-up-metabase.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Don't worry about picking the wrong option. If you say you're interested in embe

## Gathering your database info

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

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

Expand Down
2 changes: 1 addition & 1 deletion _docs/master/databases/connecting.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Go to **Admin settings** > **Databases** > your database and click **Remove this

## Restoring the Sample Database

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

## Troubleshooting

Expand Down
2 changes: 1 addition & 1 deletion _docs/master/embedding/interactive-embedding.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ redirect_from:

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

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

## Interactive embedding demo

Expand Down
2 changes: 1 addition & 1 deletion _docs/master/embedding/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ If you'd like to share your data with the good people of the internet, admins ca
| Restrict data with [locked filters](./static-embedding-parameters#restricting-data-in-a-static-embed-with-locked-parameters) | ❌ | ❌ | ✅ | ❌ |
| Restrict data with [sandboxes](../permissions/data-sandboxes) | ✅ | ✅ | ❌ | ❌ |
| Use the [drill-through menu](/learn/metabase-basics/querying-and-dashboards/questions/drill-through) | ✅ | ✅ | ❌ | ❌ |
| Self-serve via [query builder](/glossary/query_builder) | ✅ | ✅ | ❌ | ❌ |
| Self-serve via [query builder](/glossary/query-builder) | ✅ | ✅ | ❌ | ❌ |
| View usage of embeds with [usage analytics](../usage-and-performance-tools/usage-analytics) | ✅ | ✅ | ❌ | ❌ |
| [Actions on dashboards](../dashboards/actions) | ✅ | ✅ | ❌ | ❌ |
| Embed individual Metabase components | ✅ | ❌ | ❌ | ❌ |
Expand Down
83 changes: 83 additions & 0 deletions _docs/master/embedding/sdk/upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
version: master
has_magic_breadcrumbs: true
show_category_breadcrumb: true
show_title_breadcrumb: true
category: Embedding
title: 'Upgrading Metabase and the Embedded analytics SDK'
source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/upgrade.md'
layout: new-docs
summary: 'How to upgrade your Metabase and Embedded analytics SDK versions, test the changes, and check for breaking changes that might affect your app.'
---

# Upgrading Metabase and the Embedded analytics SDK

Here's a basic overview of the steps you'll want to take when upgrading your SDK.

## 1. Read the release post and changelog for both Metabase and the Embedded analytics SDK

- [Release posts](/releases) give a good overview of what's in each release, and call out breaking changes (which are rare).
- [Metabase changelogs](/changelog) list Metabase changes.
- [Embedded analytics SDK changelogs](/changelog/55) list changes specific to the SDK package.

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.

## 2. Test the upgrade

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.

### Spin up the new version of Metabase for testing

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.

See [upgrading Metabase](../../installation-and-operation/upgrading-metabase).

### Upgrade the SDK with npm or yarn

You'll want to test the changes locally first, as there may be breaking changes that require you to upgrade your application code.

Check out a new branch in your application and install the next stable version, either with npm or yarn:

Via npm:

```bash
npm install @metabase/embedding-sdk-react@{next-major-version-number}-stable
```

For example, if you were upgrading to version 55 of the SDK:

```bash
npm install @metabase/embedding-sdk-react@55-stable
```

If you're using yarn:

```bash
yarn add @metabase/embedding-sdk-react@{next-major-version-number}-stable
```

See more on [SDK versions](./version).

### If there are breaking changes, make the necessary changes to your application code

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.

Update or add tests for any application code changes that you make.

### Deploy to your staging environment

Before deploying your app to your staging environment, make sure you've tested your app locally (manually, as well as running any automated tests).

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.

## 3. Deploy to production

If everything is working in staging, you're ready to deploy to production.

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.

### If your instance is on Metabase Cloud, you'll need to request an upgrade

If you're on Metabase Cloud, your instance version is pinned, so you'll need to request an upgrade by [contacting support](/help-premium).

We'll coordinate with you so that your instance is upgraded when you deploy the changes to your application.
29 changes: 13 additions & 16 deletions _docs/master/embedding/sdk/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,35 +15,32 @@ layout: new-docs

The SDK stable version tracks with the Metabase version.

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

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

```sh
npm install @metabase/embedding-sdk-react@53-stable
npm install @metabase/embedding-sdk-react@55-stable
```

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

## Minimum SDK version

52 is the minimum version supported for the Embedded analytics SDK.
Version 52 is the minimum version supported for the Embedded analytics SDK.

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

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**.
By default, if you're running on Metabase Cloud and using the Embedded analytics SDK, we'll pin your version to avoid breaking changes.

## Version pinning requirements
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.

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

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

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

Normally, Metabase Cloud upgrades your Metabase as new versions roll out so that 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.

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.
This will open a mailto link to our support team.
16 changes: 14 additions & 2 deletions _docs/master/installation-and-operation/upgrading-metabase.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,15 @@ redirect_from:

# Upgrading Metabase

This page covers how to upgrade to a new [Metabase release](https://github.com/metabase/metabase/releases).
This page covers how to upgrade to a new Metabase release.

- [Announcement posts for major releases](https://www.)
- [Changelogs](/changelog).
- [Release notes on GitHub](https://github.com/metabase/metabase/releases).

## Upgrading Metabase Cloud

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

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

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

Cloud customers can request an early upgrade by emailing support at help@metabase.com. Include the URL of the Metabase you want us to upgrade.

### Instances using the Embedded analtyics SDK on Metabase Cloud must request an upgrade

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.

To upgrade your Metabase, you'll need to request an upgrade by [contacting support](/help-premium).

See our [upgrade guide for the Embedded analytics SDK](../embedding/sdk/upgrade).

## Upgrading a self-hosted Metabase

Here are the steps for upgrading to a new Metabase version (major or minor):
Expand Down
2 changes: 1 addition & 1 deletion _docs/master/permissions/impersonation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ layout: new-docs

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

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

> If you're using views in PostgresSQL, the row-level security policies on views will only work on Postgres versions 15 and higher.

Expand Down
2 changes: 1 addition & 1 deletion _docs/master/questions/native-editor/writing-sql.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ See [Caching question policies](../../configuring-metabase/caching#question-cach

[learn-sql]: /learn/sql/working-with-sql
[ref-models]: ./referencing-saved-questions-in-queries
[sample-database-gloss]: /glossary/sample_database
[sample-database-gloss]: /glossary/sample-database
[sql-gloss]: /glossary/sql
[troubleshooting-sql]: ../../troubleshooting-guide/sql
[variable-gloss]: /glossary/variable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ This section covers functions and formulas that work the same way as the Metabas

### SQL

When you run a question using the [query builder](/glossary/query_builder), Metabase will convert your graphical query settings (filters, summaries, etc.) into a query, and run that query against your database to get your results.
When you run a question using the [query builder](/glossary/query-builder), Metabase will convert your graphical query settings (filters, summaries, etc.) into a query, and run that query against your database to get your results.

If our [timestamp sample data](#creating-custom-report-dates) is a `timestamp without time zone` stored in a PostgreSQL database:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ You'll also need to set the **Group by** column to "Created Date: Month".

### SQL

When you run a question using the [query builder](/glossary/query_builder), Metabase will convert your query builder settings (filters, summaries, etc.) into a SQL query, and run that query against your database to get your results.
When you run a question using the [query builder](/glossary/query-builder), Metabase will convert your query builder settings (filters, summaries, etc.) into a SQL query, and run that query against your database to get your results.

If our [sample data](#multiple-conditions) is stored in a PostgreSQL database, the SQL query:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ datetimeAdd([Opened On], 14, "day")

### SQL

When you run a question using the [query builder](/glossary/query_builder), Metabase will convert your graphical query settings (filters, summaries, etc.) into a query, and run that query against your database to get your results.
When you run a question using the [query builder](/glossary/query-builder), Metabase will convert your graphical query settings (filters, summaries, etc.) into a query, and run that query against your database to get your results.

If our [coffee sample data](#calculating-an-end-date) is stored in a PostgreSQL database:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ This section covers functions and formulas that work the same way as the Metabas

### SQL

When you run a question using the [query builder](/glossary/query_builder), Metabase will convert your graphical query settings (filters, summaries, etc.) into a query, and run that query against your database to get your results.
When you run a question using the [query builder](/glossary/query-builder), Metabase will convert your graphical query settings (filters, summaries, etc.) into a query, and run that query against your database to get your results.

If our [cheese sample data](#calculating-age) is stored in a PostgreSQL database:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ datetimeSubtract([Arrive By], 30, "minute")

### SQL

When you run a question using the [query builder](/glossary/query_builder), Metabase will convert your graphical query settings (filters, summaries, etc.) into a query, and run that query against your database to get your results.
When you run a question using the [query builder](/glossary/query-builder), Metabase will convert your graphical query settings (filters, summaries, etc.) into a query, and run that query against your database to get your results.

If our [events sample data](#calculating-a-start-date) is stored in a PostgreSQL database:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,6 @@ case(isEmpty([Feedback]), "No feedback.", [Feedback])
[custom-expressions-doc]: ../expressions
[custom-expressions-learn]: /learn/metabase-basics/querying-and-dashboards/questions/custom-expressions
[data-types]: /learn/grow-your-data-skills/data-fundamentals/data-types-overview#examples-of-data-types
[notebook-editor-def]: /glossary/query_builder
[notebook-editor-def]: /glossary/query-builder
[numpy]: https://numpy.org/doc/
[pandas]: https://pandas.pydata.org/pandas-docs/stable/
2 changes: 1 addition & 1 deletion _docs/master/questions/query-builder/expressions/isnull.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,6 @@ case(isNull([Feedback]), "Unknown feedback.", [Feedback])
[custom-expressions-doc]: ../expressions
[custom-expressions-learn]: /learn/metabase-basics/querying-and-dashboards/questions/custom-expressions
[data-types]: /learn/grow-your-data-skills/data-fundamentals/data-types-overview#examples-of-data-types
[notebook-editor-def]: /glossary/query_builder
[notebook-editor-def]: /glossary/query-builder
[numpy]: https://numpy.org/doc/
[pandas]: https://pandas.pydata.org/pandas-docs/stable/
2 changes: 1 addition & 1 deletion _docs/master/questions/query-builder/expressions/now.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Different ways to do the same thing, because while you'd love to use custom expr

### SQL

When you run a question using the [query builder](/glossary/query_builder), Metabase will convert your query builder settings (filters, summaries, etc.) into a SQL query, and run that query against your database to get your results.
When you run a question using the [query builder](/glossary/query-builder), Metabase will convert your query builder settings (filters, summaries, etc.) into a SQL query, and run that query against your database to get your results.

By default, `now` uses your Metabase's [report time zone](../../../configuring-metabase/localization#report-timezone). If your admin hasn't set a report time zone, `now` will use your database's time zone.

Expand Down
Loading