嵌入式分析 SDK - CLI 快速入门

我们构建了一个单命令来启动 Metabase，帮助您在应用中嵌入仪表板。使用 API 密钥的此设置在生产环境中不起作用；它仅供您在本地计算机上快速试用 SDK。生产设置需要 Pro/Enterprise 许可证，以及带有 JWT 的 SSO。

先决条件

• Docker（应在您的机器上启动并运行）
• Node.js 20.x LTS 或更高版本。
• 许可证（可选 - 仅当您想试用多租户时）。
• 数据库（您可以连接到您的应用的数据库）。

快速入门命令

切换到您的 React 应用程序并运行

npx @metabase/embedding-sdk-react@latest start

该工具将引导您完成设置。有很多部分需要组合在一起，因此以下是命令作用的概述。

检查先决条件

• 检查您是否正在 React 应用程序中安装 SDK。
• 查找或安装嵌入式分析 SDK。
• 检查 Docker 是否在您的机器上运行。
• 询问您是否有要连接的数据库（使用左右箭头键选择“否”或“是”）。该工具将使用此数据库生成嵌入式仪表板。如果您回答否，脚本将使用 Metabase 附带的示例数据库创建仪表板。

设置 Metabase

• 询问您一个电子邮件地址，以在 Metabase 中创建第一个管理员帐户。不必是真实的电子邮件地址（该工具未设置 SMTP 服务器）；电子邮件地址仅是登录必需的。
• 在 Docker 上启动 Metabase。这需要一点时间。要查看 Docker 容器的状态，请使用 docker ps 命令。或者利用这段时间反思您最近做出的明智选择。
• 生成新的 API 密钥。

将 Metabase 连接到您的数据库

• 提示您连接到数据库。选择您的数据库引擎。您需要数据库的主机、端口、用户名和密码。
• 连接到数据库，并提示您从数据库中选择要嵌入的表。选择 1-3 个表。如果您想查看多租户的实际效果，请选择包含用户 ID 的表。Metabase 将对这些表进行 X 射线分析，以创建要嵌入的仪表板。

（可选）设置具有多租户的权限

如果您有 Pro/EE 许可证，该工具可以设置权限。要获得许可证，请注册 自托管 Metabase Pro 的免费试用版。

如果您选择设置多租户并连接到您自己的数据库，该工具将询问您要用于沙盒表的列（例如，用户 ID 列）。Metabase 将根据该列中的值沙盒数据。

该工具还将设置一个带有 JWT 的模拟 Express 服务器。它会询问您应将服务器代码保存在何处（默认值：./mock-server）。它将使用 npm install 安装服务器的依赖项。

您需要在另一个终端会话中启动模拟服务器。切换到模拟服务器的目录并运行

npm run start

生成您将导入到应用中的 React 组件

生成示例 React 组件文件。默认情况下，它会将它们保存在 React 应用的 ./src/components/metabase 中，但该工具会提示您将它们保存到其他目录（例如，./src/analytics）。

将 Metabase/React 组件添加到您的应用

模拟服务器运行后，返回到该工具的终端会话并按继续。

提示您在客户端应用中添加以下 import

import { AnalyticsPage } from "./metabase";

确保 from 路径有效（根据您的应用，您可能需要将组件移动到新目录）。

然后，您需要将 <AnalyticsPage /> 组件添加到应用中的页面。

启动您的应用并查看分析页面

启动您的应用，并查看您在其中添加了 <AnalyticsPage /> 组件的页面，您应该会看到嵌入式仪表板。

查看您的 Metabase

您的 Metabase 应在 http://localhost:3366 上运行。您可以在 METABASE_LOGIN.json 中找到您的登录凭据。

进一步阅读

• 示例应用和 JWT 快速入门