Skip to content

version.md

Latest commit

 

History

History
49 lines (29 loc) · 2.01 KB

version.md

File metadata and controls

49 lines (29 loc) · 2.01 KB
title Modular embedding SDK - versions
summary Learn about Modular embedding SDK versioning and compatibility with Metabase. Install compatible versions and pin your Metabase Cloud instance version.

Modular embedding SDK - versions

{% include plans-blockquote.html feature="Modular embedding SDK" sdk=true %}

Metabase 57 and later

Starting with Metabase 57, the @metabase/embedding-sdk-react npm package loads the SDK Bundle from your Metabase.

Install the SDK Package matching your Metabase major with the @{major}-stable dist-tag, so the package's TypeScript types and exported components stay in sync with your instance's SDK Bundle:

npm install @metabase/embedding-sdk-react@60-stable

Installing without a dist-tag (npm install @metabase/embedding-sdk-react) still works. The bundle loads from your Metabase, but the package's types and exports will track the latest published SDK major, which may drift from your Metabase version.

Metabase 56 and earlier

For Metabase 56 and earlier, the SDK major version must match the Metabase major version. Use the matching @{major}-stable dist-tag. For example, for Metabase 55:

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

On Metabase 55 (0.55.x, 1.55.x), any 0.55.x release of @metabase/embedding-sdk-react will be compatible.

Minimum SDK version

Version 52 is the minimum version supported for the Modular embedding SDK.

You can pin instances to a version on Metabase Cloud

Metabase Cloud upgrades your instance automatically as new versions roll out. If you're using the SDK with Metabase Cloud, you may want to pin your version so you can upgrade manually.

On Metabase 56 or earlier, pinning also keeps the SDK Package and Metabase majors in lockstep.

Manually pinning your instance version on Metabase Cloud

To manually pin your version of Metabase:

  1. Go to Admin > Embedding > Modular.
  2. Scroll to Version pinning and click Request version pinning.

This will open a mailto link to our support team.