嵌入式分析 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 應在 https://127.0.0.1:3366 上執行。您可以在 METABASE_LOGIN.json 中找到您的登入憑證。

延伸閱讀

• 搭配範例應用程式和 JWT 快速入門