Skip to content

Commit 7215ad9

Browse files
github-automation-metabaseMetabase Docs bot
andauthored
[auto] adding content to backport-55-b75ef21b91696dd940802f7bf3dad8bb73fceba6->release-x.55.x (#334)
Co-authored-by: Metabase Docs bot <[email protected]>
1 parent a8cb802 commit 7215ad9

File tree

24 files changed

+220
-10607
lines changed

24 files changed

+220
-10607
lines changed

_docs/latest/databases/connections/bigquery.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,12 @@ If you're having trouble with your BigQuery connection, you can check out this [
170170

171171
There aren't (yet) any model features available for BigQuery.
172172

173+
## Database routing
174+
175+
Database routing for BigQuery works between BigQuery **projects** with identical schemas.
176+
177+
See [Database routing](../../permissions/database-routing).
178+
173179
## Danger zone
174180

175181
See [Danger zone](../danger-zone).

_docs/latest/developers-guide/driver-changelog.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,29 @@ latest: true
1313

1414
# Driver Interface Changelog
1515

16+
## Metabase 0.56.0
17+
18+
- Add the testing multi-method `tx/track-dataset` for shared cloud dbs to track loaded datasets for more efficient sharing.
19+
20+
- Join alias escaping has been reworked; when compiling MBQL for a join please use
21+
`metabase.driver-api.core/qp.add.alias` instead of `:join-alias`. (This is mostly relevant if you have a custom
22+
`metabase.driver.sql.query-processor/join->honeysql` implementation.)
23+
24+
Join aliases are no longer globally unique by default, but instead unique within a given level of a query. If you
25+
need globally unique join aliases, you can pass the new `{:globally-unique-join-aliases? true}` option to
26+
`driver-api/add-alias-info`.
27+
28+
Also note that `driver-api/add-alias-info` only adds additional keys to field refs and join maps, and does not
29+
replace existing keys like `:alias`, `:join-alias`, or `:name`; make sure you use `driver-api/qp.add.alias`,
30+
`driver-api/qp.add.source-table`, and `driver-api/qp.add.source-alias` respectively.
31+
32+
- Added the driver multi-method `driver/extra-info` for drivers to provide info such as db routing configuration details
33+
from their `metabase-plugin.yaml` file.
34+
35+
- Extend `datetime()` to accept UTF-8 encoded binary and numbers (unix timestamps) in addition to strings.
36+
37+
- Added a feature `:expressions/today` for drivers that support generating a date for the current day.
38+
1639
## Metabase 0.55.0
1740

1841
- Add the multi-method `->date` that allows the driver to control how to cast strings and temporal types to dates.

_docs/latest/embedding/sdk/upgrade.md

Lines changed: 0 additions & 86 deletions
This file was deleted.

_docs/latest/embedding/sdk/version.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,32 +16,35 @@ latest: true
1616

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

19-
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.
19+
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.
2020

21-
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:
21+
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:
2222

2323
```sh
24-
npm install @metabase/embedding-sdk-react@55-stable
24+
npm install @metabase/embedding-sdk-react@53-stable
2525
```
2626

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

2929
## Minimum SDK version
3030

31-
Version 52 is the minimum version supported for the Embedded analytics SDK.
31+
52 is the minimum version supported for the Embedded analytics SDK.
3232

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

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

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

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

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

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

47-
This will open a mailto link to our support team.
46+
Normally, Metabase Cloud upgrades your Metabase as new versions roll out so that you don't have to deal with upgrades.
47+
48+
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.
49+
50+
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.

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

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,11 @@ latest: true
1515

1616
# Upgrading Metabase
1717

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

2420
## Upgrading Metabase Cloud
2521

26-
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)).
22+
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.
2723

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

@@ -32,14 +28,6 @@ How soon we upgrade you depends on the type of release:
3228

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

35-
### Instances using the Embedded analtyics SDK on Metabase Cloud must request an upgrade
36-
37-
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.
38-
39-
To upgrade your Metabase, you'll need to request an upgrade by [contacting support](/help-premium).
40-
41-
See our [upgrade guide for the Embedded analytics SDK](../embedding/sdk/upgrade).
42-
4331
## Upgrading a self-hosted Metabase
4432

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

_docs/latest/permissions/database-routing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Database routing is useful for:
2929

3030
## Databases that support database routing
3131

32+
- [BigQuery](../databases/connections/bigquery)
3233
- [Druid](../databases/connections/druid)
3334
- [MongoDB](../databases/connections/mongodb)
3435
- [MariaDB](../databases/connections/mariadb)

_docs/v0.55/databases/connections/bigquery.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,12 @@ If you're having trouble with your BigQuery connection, you can check out this [
168168

169169
There aren't (yet) any model features available for BigQuery.
170170

171+
## Database routing
172+
173+
Database routing for BigQuery works between BigQuery **projects** with identical schemas.
174+
175+
See [Database routing](../../permissions/database-routing).
176+
171177
## Danger zone
172178

173179
See [Danger zone](../danger-zone).

_docs/v0.55/developers-guide/driver-changelog.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,29 @@ layout: new-docs
1111

1212
# Driver Interface Changelog
1313

14+
## Metabase 0.56.0
15+
16+
- Add the testing multi-method `tx/track-dataset` for shared cloud dbs to track loaded datasets for more efficient sharing.
17+
18+
- Join alias escaping has been reworked; when compiling MBQL for a join please use
19+
`metabase.driver-api.core/qp.add.alias` instead of `:join-alias`. (This is mostly relevant if you have a custom
20+
`metabase.driver.sql.query-processor/join->honeysql` implementation.)
21+
22+
Join aliases are no longer globally unique by default, but instead unique within a given level of a query. If you
23+
need globally unique join aliases, you can pass the new `{:globally-unique-join-aliases? true}` option to
24+
`driver-api/add-alias-info`.
25+
26+
Also note that `driver-api/add-alias-info` only adds additional keys to field refs and join maps, and does not
27+
replace existing keys like `:alias`, `:join-alias`, or `:name`; make sure you use `driver-api/qp.add.alias`,
28+
`driver-api/qp.add.source-table`, and `driver-api/qp.add.source-alias` respectively.
29+
30+
- Added the driver multi-method `driver/extra-info` for drivers to provide info such as db routing configuration details
31+
from their `metabase-plugin.yaml` file.
32+
33+
- Extend `datetime()` to accept UTF-8 encoded binary and numbers (unix timestamps) in addition to strings.
34+
35+
- Added a feature `:expressions/today` for drivers that support generating a date for the current day.
36+
1437
## Metabase 0.55.0
1538

1639
- Add the multi-method `->date` that allows the driver to control how to cast strings and temporal types to dates.

_docs/v0.55/embedding/sdk/upgrade.md

Lines changed: 0 additions & 83 deletions
This file was deleted.

_docs/v0.55/embedding/sdk/version.md

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

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

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.
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.
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 55, 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 53, run:
2121

2222
```sh
23-
npm install @metabase/embedding-sdk-react@55-stable
23+
npm install @metabase/embedding-sdk-react@53-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-
Version 52 is the minimum version supported for the Embedded analytics SDK.
30+
52 is the minimum version supported for the Embedded analytics SDK.
3131

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

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

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

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

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

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**.
43+
## Why you'd want to pin your Metabase Cloud version
4544

46-
This will open a mailto link to our support team.
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.

0 commit comments

Comments
 (0)