Metabase教學 on IT 空間

[Metabase 系列] Metabase API 使用教學，輕鬆串接自己的系統

jia@jiatool.com (Jia) — Fri, 18 Oct 2024 15:10:00 +0800

前言

前幾篇我們學會了安裝 Metabase、建立提問和圖表、建立 Dashboard，那你有沒有想過能否把 Metabase 串接到自己的系統內呢？例如可以做一些自動化執行任務，或需要大量批次處理。

其實 Metabase 本身就有提供很完善的 API。應該說，Metabase 本身連接前端和後端，就是使用這組 API，所以幾乎你在 Metabase 執行的所有操作，都有對應的 API 端點可以使用。

今天我們來學習一下如何使用 Metabase API。

Metabase 系列教學文章：

* 本文使用 Metabase 版本為：v0.50.28

圖片來源：Metabase 官網

Metabase API

Metabase 本身連接前端和後端，就是使用這組 API，所以幾乎我們在 Metabase 可以執行的所有操作，都有對應的 API 端點。
例如新增資料庫、建立提問、建立 Dashboard、人員權限設定、管理員設定、搜尋功能…

* 這邊有官方的 API 教學和 API documentation 可以參考。

但該如何知道，我們想要的功能該用哪個 API 端點，以及需要帶上哪些參數呢？

有三種方法可以來尋找：

從 Metabase API documentation
在 API live docs 進行測試
使用瀏覽器的開發人員工具

Metabase API documentation 就是官方整理的文件，可以快速查詢。

但有些看出不出參數要如何帶入，以及它回傳資料的內容與格式，所以我自己比較常用 "開發人員工具" 的方式來查詢。
(API live docs 好像是最近才加入的功能)

Metabase API documentation

API live docs 是可以在你自己運行的 Metabase 上，查看透過 RapiDoc 提供的即時 OpenAPI 文件。只要前往 /api/docs 路徑 (例如 http://localhost:3000/api/docs)。

左邊清單可以方便找到 API 端點，點擊右方的 "TRY" 會發送請求，並且會顯示回傳的結果，挺方便的。

API live docs

而瀏覽器的開發人員工具，就跟我們在寫網站或網路爬蟲時，使用的方式一樣。

開啟瀏覽器的 開發人員工具 (F12 或 Ctrl + Shift + i)，切換到 "Network" > "Fetch/XHR" 分頁。

瀏覽器的開發人員工具

"Headers" 頁面可以查看請求的網址與方法
"Payload" 頁面可以查看請求的 Body
"Preview" 頁面可以查看請求的回傳結果

瀏覽器的開發人員工具

API 金鑰 (API key)

剛剛我們再查看有哪些 API 端點時，因為是在登入的瀏覽器內操作，所以它有自動帶上我們的身分認證，但之後要整合進我們的程式或專案，那就需要使用 API 金鑰做身分認證。

在 Metabase 裡右上角齒輪 > 管理員設定 > 設定 > 授權認證 > API 金鑰。

右上角齒輪 > 管理員設定

管理員設定內設定 > 授權認證 > API 金鑰

點擊「建立 API 金鑰」。

金鑰名稱自己取一個，純粹為了區分用。
接下來要選擇一個群組，該 API 金鑰會擁有與此群組相同的權限。

建立 API 金鑰

建立後，它會顯示完整的 API 金鑰，這時候要將其複製並保存起來。

複製 API 金鑰

之後只能編輯 API 金鑰名稱跟改群組，金鑰內容忘記就只能再產生新的了。

編輯 API 金鑰

在使用 API 時，只要將此 API 金鑰帶入 Headers 內即可：

x-api-key: YOUR_API_KEY

關於其他說明，可以參考官方文件 API keys 。

Session Token

除了使用 API key 驗證以外，其實還可以使用 session token 來驗證，這個就等同輸入帳號密碼的方式。

(在以前的版本，還沒有 API key 的時候，就只能透過 session token 驗證，不過它過一段時間後會過期，需要再重新取得，現在新版都建議直接使用 API key 即可)

* 帳號是 email 格式，例如 person@metabase.com

curl -X POST \
-H "Content-Type: application/json" \
-d '{"username": "帳號", "password": "密碼"}' \
http://localhost:3000/api/session

它會回傳像是 { "id": "38f4939c-ad7f-4cbe-ae54-30946daf8593" }。

之後在使用 API 時，將此 id 帶入 Headers 內：

X-Metabase-Session: 38f4939c-ad7f-4cbe-ae54-30946daf8593

* 預設情況，session token 有效期為 14 天。可以透過設定環境變數 MB_SESSION_AGE （值以分鐘為單位）來修改持續時間。
* 最好將 session token 保存起來重複使用，直到過期再重新取得。因為安全因素，使用帳密取得 ession token 有速率限制。

API 如何使用

在整合進我們的程式或專案之前，可以先使用 HTTP Request、測試 API 的工具，例如 Postman 來先測試，方便我們理解該如何使用、回傳資料長怎樣。

以下就以最有名的 Postman 工具來示範。

我們就以取得「全部群組的清單」來當第一個例子。
* 官方 API 文件： GET /api/permissions/group

Request URL：http://localhost:3000/api/permissions/group
Request Method：GET
Headers：
x-api-key:mb_GEeE7gBEcObtBFvanzyeTMIBzvCUmhEvjYv729OCkIA=
(請換成自己剛剛建立的 API 金鑰)

Send 送出請求後，可以收到回覆，這就是我們目前的全部群組：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


[
{
"id": 2,
"name": "Administrators",
"entity_id": null,
"member_count": 2
},
{
"id": 1,
"name": "All Users",
"entity_id": null,
"member_count": 4
}
]

Postman 取得全部群組的清單

還記得剛剛建立 API 金鑰時，有指定一個群組嗎？
我們是選擇「Administrators」，代表它有管理者的權限。那假如我們再創建一個「All Users」群組的 API 金鑰，測試同一個 API 呢？

可以看到它回覆 "您沒有權限那麼做"，HTTP Status Code 是 403 Forbidden，代表客戶端沒有訪問該資源的權限，這就是權限管控。

就跟一般使用者登入 Metabase 後，他也沒有權限進入 "管理員設定" 一樣。

Postman 取得全部群組的清單 (沒權限)

再來試一個。

我想查看一個「提問 (Questions，也就是圖表) 的資訊」，該如何操作？

* 在 API 中，提問被稱為卡片(card)
* 官方 API 文件： GET /api/card/:id

例如網址是在 http://localhost:3000/question/27-products 的圖表。

card id 就是在網址後面的數字，以上範例的話就是 27。

提問 (Questions，也就是圖表) 的網址

Request URL：http://localhost:3000/api/card/27
Request Method：GET
Headers：
x-api-key:mb_j6OtF0o24wnnJb3A/wteFfuilW4lKyKHtx9Cl6cQKBE=
(請換成自己剛剛建立的 API 金鑰)

Send 送出請求後，可以收到回覆，就是有關這個提問(圖表)的資訊：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20


{
"id": 27,
"name": "Products 依類別分組",
"description": null,
"archived": false,
"view_count": 2,
"type": "question",
"query_type": "query",
"display": "bar",
"database_id": 1,
"can_write": true,
"average_query_time": 38.0000000000000000,
"enable_embedding": false,
"last_query_start": "2024-10-12T13:07:51.402753Z",
"last_used_at": "2024-10-12T13:07:51.422213Z",
"updated_at": "2024-10-12T13:31:43.873511Z",
"created_at": "2024-10-12T13:07:21.456419Z",
"creator_id": 1,
...以下省略
}

Postman 取得提問 (圖表) 的資訊

以上兩個範例都是 GET 資料，來看看假如是想要 POST 的請求方式呢？

例如想取得「提問 (Questions，圖表) 的查詢資料」，也就是網頁底下切換成原始資料的部分。

提問 (圖表) 的查詢資料

* 官方 API 文件： POST /api/card/:card-id/query

Request URL：http://localhost:3000/api/card/27/query
Request Method：POST
Headers：
x-api-key:mb_j6OtF0o24wnnJb3A/wteFfuilW4lKyKHtx9Cl6cQKBE=
(請換成自己剛剛建立的 API 金鑰)
Body:
{
"ignore_cache": true
}

* 這個 API 端點的 Body 非必要，可以省略

Send 送出請求後，可以收到回覆，是這個提問(圖表)的查詢資料：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31


{
"data": {
"rows": [
[
"Doohickey",
42
],
[
"Gadget",
53
],
[
"Gizmo",
51
],
[
"Widget",
54
]
],
...以下省略
},
"cached": null,
"database_id": 1,
"started_at": "2024-10-12T13:42:49.532062Z",
"status": "completed",
"context": "question",
"row_count": 4,
"running_time": 25,
...以下省略
}

Postman 取得提問 (圖表) 的查詢資料

其他更多說明與 API 端點，可以參考 Metabase 官方 API documentation 。

備註

雖然他們有說，API 介面盡量不會做更改，但新功能推出、舊 bug 修復可能多多少少 API 還是有調整，因此在升級 Metabase 版本之前，可以先參考官方整理的文章： API 介面的重大更改

結語

在以上了解 Metabase API 的使用之後，我們就可以把 Metabase 串接到自己的系統內，做更深度的整合，或做些自動化的應用了~

而且從 API 回傳資料，也可以發現一些沒有顯示在網頁畫面上的資訊 XD

如果對於 Metabase 有興趣的讀者，記得『 IT空間』FB 粉專要追蹤起來，才不會錯過最新的發文通知哦~🔔

參考：
Metabase 官方網站
 Metabase API 官方教學
 Metabase 官方 API documentation
Metabase 官方 GitHub
Metabase API 介面的重大更改

有那個時間絕望的話，還不如去吃好吃的美食，然後好好睡一覺。

—— 《法醫女王》(日本電視劇)

[Metabase 系列] 建立 Dashboard (資訊看板、儀表板) 教學

jia@jiatool.com (Jia) — Sat, 27 Jul 2024 20:30:00 +0800

前言

上一篇我們一起在 Metabase 裡建立各式圖表，這次要將這些相關圖表放在一張 Dashboard (資訊看板、儀表板)裡，方便讓我們一目了然，而且還可以加上篩選欄位與設定圖表間的連動。

* 在 Metabase 裡，因翻譯的緣故，可能會顯示為「資訊看板」或「儀表板」，但為了方便說明，以下統一都叫「Dashboard」。

Metabase 系列教學文章：

* 本文使用 Metabase 版本為：v0.50.15

圖片來源：Metabase 官網

Dashboard 教學

Dashboard 可以把我們之前建立的提問(圖表)放在一起呈現，方便讓我們一目了然，再加上文字卡片來說明，而且還可以再加上篩選欄位與設定圖表間的連動。

建立 Dashboard

在網頁右上角，點擊「新的」選擇 "資訊看板" 來建立 Dashboard。

建立 Dashboard

為新 Dashboard 指定名稱和描述，以及要保存的位置。
你可以放在「站內分析總覽」底下的資料夾，讓有權限的成員觀看、一同編輯；或放在「個人集合」資料夾，只有自己能看。

建立 Dashboard - 指定名稱、描述與保存位置

進入 Dashboard 的編輯狀態後，上方可以看到一排功能按鈕。
以下我們就來一一說明。

編輯 Dashboard - 上方功能按鈕說明

添加圖表卡片

首先，Dashboard 內最重要的就是我們的圖表啦，"+"加號按鈕可以添加好我們已經做好的提問(圖表、表格)，不管你是柱狀圖、圓餅圖、表格、資料透視表、地圖……全部都可以添加一起呈現。

添加圖表卡片到 Dashboard

添加進來後，會以一張「卡片」的樣子呈現。

大部分的卡片(包括連結卡片、文字卡片) 都可以拖移放不同位置，右下角按住可以調整卡片大小，其卡片內容也會自動做相應的排版調整。

(注意看 Dashboard 背景有一格一格的，那個就是放置、縮放的一個最小單位)

設定卡片大小

卡片設定

而當滑鼠移至卡片上方，會出現一排「卡片設定按鈕」。
可以對卡片做更多自定義的設定，包含外觀、點擊行為、複製、刪除……。

卡片設定按鈕

外觀設定類似在圖表頁面的設定。

卡片顯示設定

而卡片點擊行為設定，則是當使用者滑鼠點擊圖表時該做什麼事，像是跳轉到另一張圖表、網頁連結，或者將數值帶入上方的篩選欄位 (篩選欄位後續章節會介紹)。

例如你就可以做到，點擊圖表內其中一個日期，它會將此日期自動帶入上方篩選欄位，達到整張 Dashboard 都呈現此日期的資料。

卡片點擊行為設定

點擊行為 - 官方文件說明

添加連結卡片

連結卡片可以把它想像成有超連結文字的卡片。可以讓使用者點擊後跳轉到不同圖表或 Dashboard 的頁面，或者也可以設定外部連結(網址)。

添加連結卡片到 Dashboard

添加篩選

篩選功能讓你可以針對個別或全部的圖表進行篩選，這也是 Dashboard 內一項很常用到的功能。
例如顯示一週內的資料、過濾某一個類別、只顯示五星的訊息……等等之類的應用。

篩選欄位的類別分為 "時間"、"位置"、"ID"、"數字"、"文本或類別"，對應著不同資料的類別。

添加篩選到 Dashboard

像是 "時間" 的篩選，會列出一些常見的 "日期範圍" 可以直接選擇，或者下方也有 "具體日期"、"相對日期" 來指定單一天。

日期篩選

或者像是 "文本或類別" 的篩選，會有下拉清單方便使用者使用滑鼠直接點選，不必還要鍵盤輸入。

文本篩選

當你添加篩選欄位後，先來指定要連結各圖表的哪個欄位。

而右方為此篩選欄位的一些設定，像是名稱、類型、過濾運算符 (例如要一模一樣的文字、部分包含，還是比對開頭…)。

篩選設定 1

剛剛提到的，像是 "文本或類別" 篩選可以設定下拉清單，方便使用者直接點選、不必鍵盤輸入。

還可指定為單選或多選、是否必填、預設值。

篩選設定 2

下拉清單的選項來源可以是另一張提問(圖表)或自己手動輸入。

篩選設定 - 設定下拉清單

篩選 - 官方文件說明

添加文字卡片

文字卡片是為了讓你在 Dashboard 添加說明文字，或標題文字做版面區隔。

標題：預先格式化的標題文字卡，只能單行，字體大小、粗細固定無法改。
文本：可自訂的文字卡片，支援 Markdown 格式。

因為 “文本” 支援 Markdown 格式，卡片背景也可以像 “標題” 改為透明，所以我自己幾乎都是用 “文本”。

添加文字卡片到 Dashboard

而文字卡片其內容也可以顯示上面提到的 "篩選欄位的值"，只要使用雙大括號 {{ 和 }} 就可以了，中間的名稱自訂(但要用英文，並且不能有空格)。

文字卡片帶入篩選欄位的值

當然也要把篩選欄位與文字卡片內的變數連結起來。

文字卡片帶入篩選欄位的值連結

保存後，當選擇篩選時，其值就會帶入文字卡片內。

文字卡片帶入篩選欄位的值顯示

* 進階用法：使用雙中括號 [[ 和 ]]，這樣當沒有選擇時，中括號內的文字就不會顯示。例如：# 產品分析 [[from {{category}}]]。

分頁標籤 (Tab)

在 Metabase v0.47 版本之後，引進了「分頁標籤 (Tab)」這個實用的功能，可以在一張 Dashboard 中切分不同的分頁，讓你的 Dashboard 更有條理、版面更簡潔。

分頁標籤 (Tab)

其他功能

公開分享

Dashboard 製做好後，還可以透過右上角的 "分享按鈕"，有分為「公開分享」和「嵌入」功能，將 Dashboard 分享給其他人觀看。

(跟在上一篇建立圖表文章內的 "公開分享" 功能差不多，只是新版本在 UI 介面上有調整)

Dashboard 分享 - 公開連結 & 嵌入

公開連結

如同上次介紹的圖表，Dashboard 製做好後也可以公開分享給其他人查看，不需要登入。

同樣，需要先確認此功能是否有開啟，至 "系統管理員" > "設定" > "公開分享" 來啟用，

Dashboard 分享 - 公開連結

嵌入

而「嵌入」功能同樣也需要系統管理員先至 "系統管理員" > "設定" > "嵌入" 來啟用。

可以將 Dashboard 或提問(圖表) 嵌入到你自己的應用程式或網頁中，進一步地將 Metabase 與自己的服務整合。

Dashboard 分享 - 嵌入

同樣的，因為公開分享等於把 Dashboard 或提問(圖表) 的資料給不用登入的人員觀看，為了更好管控資料權限安全，「公開分享」只限制給有 "系統管理群組" 權限的使用者來開啟。
所以如果你發現公開分享按鈕無法使用，可以先確認你是否擁有系統管理群組的權限哦。

公開分享功能需要系統管理員權限

全螢幕顯示 & 定時刷新 & 導出為 PDF

Dashboard 右上角的功能按鈕，還有其他像是 "全螢幕顯示"、"定時刷新資料" 和 "導出為 PDF" 等等功能。

Dashboard 全螢幕顯示 & 定時刷新 & 導出為 PDF

在全螢幕顯示時，還可以切換成深色模式。

Dashboard 全螢幕顯示 & 定時刷新 & 深色模式

結語

除了我上面介紹的這些，關於更多功能或更進階的用法，可以參考 Metabase 官方 Dashboard 介紹文章。

下一次 Metabase 教學系列文章，我預計要來介紹「Metabase API」，讓你可以自己寫程式達到自動化的操作，或者可以跟自己的應用程式做更深度的整合。

如果對於 Metabase 有興趣的讀者，記得『 IT空間』FB 粉專要追蹤起來，才不會錯過最新的發文通知哦~🔔

參考：
Metabase 官方網站
 Metabase 官方文件 - Dashboards
Metabase 官方 GitHub

樹木結疤的地方，也是樹幹最堅硬的地方，
而我們遍體鱗傷的地方，到後來都會成最強壯的秘方。

—— 楊勇緯 (臺灣柔道運動員)

[Metabase 系列] 建立提問 (Question) 與繪製各式圖表 (Chart) 教學

jia@jiatool.com (Jia) — Sun, 11 Feb 2024 17:45:00 +0800

前言

本篇文章延續第一篇安裝完 Metabase ，來開始在 Metabase 裡創建提問 (Question) 與繪製圖表 (Chart)。

如果你還沒有安裝 Metabase 或不知道 Metabase 是什麼的話，可先前往本系列第一篇文章。

Metabase 系列教學文章：

* 本文使用 Metabase 版本為：v0.48.4

圖片來源：Metabase 官網

提問與圖表教學

建立提問

網頁右上角，點擊「新的」可創建 "提問"、"SQL查詢"、"資訊看板 (Dashboard)"、"Collection (資料夾)"、"模型"，我們這邊示範 "提問"。

加入新提問

選擇我們要查詢的資料庫(DB)、表格(Table)後，下方就有幾種查詢會用的操作，像是篩選器(where)、匯總(group by)、關聯(join)、自訂欄位、排序(order by)、行限制(limit)，讓我們透過 UI 來快速操作。

提問編輯器

點擊下方的可視化，會來到資料檢視畫面，呈現查詢的結果。

資料檢視畫面

* 為了效能緣故，最多顯示 2000 筆資料。不過在網頁右下角可以下載完整的資料，有提供 ‵.csv‵、‵.xlsx‵、‵.json‵、‵.png‵ 等檔案格式可以選擇。

下載完整結果

在網頁 UI 介面上，有三個地方可以添加條件。

第一個是直接點擊 "表格的資料" 或 "欄位名稱"，第二個是右上角的 "篩選器"、"匯總" 按鈕，最後就是剛剛講的在 "提問編輯器" 裡最完整的介面。

有三個地方可以添加條件

我們直接點選資料，也會出現如下的篩選條件，並且它會依照是字串、數字、日期不同的格式，而給出不同的選項。

新的

可視化圖表

點擊左下角的「可視化」按鈕，會打開左側的圖表選擇頁面，常見的柱狀圖、橫條圖、折線圖、分佈圖、地圖…當然有，它還有些是為了在資訊看板 (Dashboard) 顯示的圖表，像是數字、趨勢、標尺…等等。

雖然相較於其他 BI 工具，可能圖表樣式種類還沒到那麼多，但其實常用的那幾種都有支援了。

* 避免佔版面、影響閱讀，我將各式圖表的樣子截圖放在文章最後面的章節。

有多樣圖表可以選擇

柱狀圖

而左下角的齒輪符號，會切換到圖表參數設定頁面，有一些關於此圖表的設定可以調整，座標軸是否顯示、座標軸名稱、座標軸範圍、顏色、數值設定……等等。

圖表參數設定

範例

我這邊隨意加幾個條件給大家看看。

稍微複雜的查詢條件

其中的「自定欄位」，可以讓你在原有的欄位上去擴充更多需要的欄位，像是取出日期中的年份、轉換時區、取得兩個日期之間的相差、合併多個字串、字串轉大寫、判斷欄位使否為空，它也有提供一些函式可以使用，有點類似 Excel 的公式，但當然還沒那麼強大。

例如我們想要取出 Birth Date 欄位中的年份，另外放在 Birth year 新欄位，可能後續會需要用來做什麼動作。

就可以如下設定自定欄位：

自定欄位設定

自定欄位呈現結果

最後，我把它選擇用橫條圖(行)的圖表呈現，並做一些圖表相關的設定，結果如下：

橫條圖表呈現

點擊中間下方的按鈕，可在圖表和原始數據切換。

中間下方的按鈕，可在圖表和原始數據切換

沒問題後，記得要點擊右上角的「儲存」。

創建 SQL 查詢

在一開始，我們有提到網頁右上角，點擊「新的」可創建 "SQL查詢"。

新的 > SQL 查詢

它可以讓我們直接輸入 SQL 語法，這對於比較複雜的查詢或已經熟悉 SQL 的工程師來說可能比較方便，但使用這種就沒有一些 UI 上快捷的功能可以使用(排序、篩選…)，不過你也可以將 "SQL查詢" 再另存成 "提問"，就一樣會有 UI 上的快捷功能了。

SQL 查詢

SQL 查詢也可以讓我們帶入變數，這樣會在上方有個篩選欄位方便查詢使用，只要在 SQL 內使用雙大括號 "{{}}" 即可，同時網頁右方會跳出變數設定頁面，可以做一些變數格式、篩選欄位名稱、篩選欄位單選或多選、篩選欄位下拉清單…等等設定。

SQL 查詢帶入變數

公開分享

製做好的圖表除了讓其他使用者登入查看外，如果你想給沒有權限登入的人查看，也就是只要有連結就能看到圖表的話，可以使用「公開分享」功能。

預設它是沒有開啟的，需至 "系統管理員" > "設定" > "公開分享" 來啟用，

"系統管理員" > "設定" > "公開分享"

接下來就可以在圖表的右下角 "分享按鈕"

圖表右下角的分享按鈕

複製 "公開連結" 給別人。

圖表開啟公開分享

網址打開後就會呈現類似這樣的網頁囉，當然這邊是沒辦法編輯的。

* 注意看網址跟一般我們在編輯圖表時是不一樣的。
* 我因為只是在我自己的電腦執行 Metabase 服務，所以網域是 localhost。

公開圖表網頁

另外稍微注意，因為公開分享等於把這張圖表的資料給不用登入的人觀看，多少還是會擔心有資安問題，因此「公開分享」只限制給有 "系統管理群組" 權限的使用者來開啟。
所以如果你發現怎麼都沒有公開分享按鈕，可以先確認你是否有系統管理員權限哦。

"系統管理員" > "帳號管理"

各式圖表

這邊我列出各式圖表的樣子截圖給大家參考：

圖表：柱

圖表：線段

圖表：區域

圖表：組合(Combo)

圖表：行(Row)

圖表：圓餅圖

圖表：分散

圖表：瀑布

圖表：漏斗

圖表：資料透視表

圖表：數字

圖表：趨勢(Trend)

圖表：標尺

圖表：處理

圖表：地圖

結語

上次我們安裝好 Metabase，這次建立好各式圖表，在下一次的系列文章，將帶大家來把多張相關圖表放在一張資訊看板(Dashboard)裡，方便讓我們一目了然，而且還可以加上篩選欄位與設定圖表間的連動。

如果對於 Metabase 有興趣的讀者，記得『 IT空間』FB 粉專要追蹤起來，才不會錯過最新的發文通知哦~🔔

參考：
Metabase 官方網站
 Metabase 官方文件
 Metabase 官方 GitHub

過ぎ去った時間をもう一度やり直せても
僕はまたきっとこの道を選ぶ

就算將已經逝去的時間再重新來過
我一定會再次選擇這條路

—— 【Answer】幾田りら (YOASOBI 主唱 ikura)

[Metabase 系列] Metabase 簡介與安裝教學，BI 工具推薦

jia@jiatool.com (Jia) — Sun, 27 Aug 2023 19:10:00 +0800

前言

最近因緣際會下，接觸到 Metabase 這項 BI (Business Intelligence) 工具，跟有名的 Tableau 和 Power BI 類似，雖然 Metabase 相對來說比較簡潔，但其實大部分常見的功能都有，重點它是免費的！！

Metabase 系列教學文章：

本篇文章會先介紹 Metabase 的特點，再來手把手教學如何使用 Docker 的方法來安裝 Metabase。

* 本文使用 Metabase 版本為：v0.47.0

圖片來源：Metabase 官網

[小廣告] 我製作了一款可愛的「企鵝魔法師」貼圖~
歡迎下載：LINE 貼圖、Telegram 貼圖 (免費)

Metabase 簡介

Fast analytics with the friendly UX and integrated tooling to let your company explore data on their own.

Help your team answer their own questions about data in just 5 minutes—no SQL required.

Metabase 是一種 BI (Business Intelligence) 工具，可以繪製圖表、Dashboard，或者探索你的資料，提供 UI 圖形化的查詢 (關聯、篩選、聚合、排序…等等)，方便從沒學習過 SQL 的人使用，上手快速，也較容易推廣到非程式專業的人員使用。

Metabase 擁有容易使用的操作、漂亮的 UI 畫面

價格

Metabase 有分為三種方案："開源"、"專業版"、"企業"。
並可以選擇部署在他們的 Server 上(不用自己管理)，或自己建置在自己的 Server(當然就要自己管理)。
如果是"開源"並建置在自己的 Server 是完全免費的~

詳細比較在這：https://www.metabase.com/pricing/#compare
我覺得開源免費的方案其實就夠用了。

Metabase 價格方案

Metabase License：https://www.metabase.com/license/

提問(圖表) & 資訊看板(Dashboard)

網頁 UI 圖形化的查詢(關聯、篩選、聚合、排序…等等)，方便從沒學習過 SQL 的人使用。
(當然它也提供自己寫 SQL 的方式)

雖然提供的圖表樣式沒有到非常多，但常見的樣式都有，其實一般用途有這些都足夠了。

提問(圖表)

提問(圖表) 編輯器

當你做好多張圖表之後，可以使用 "資訊看板(Dashboard)" 將圖表放在同一個頁面中展示，並還可以加上篩選框、文本卡片加強。

資訊看板(Dashboard)

資訊看板(Dashboard) 在全螢幕展示時，也可以切換為深色主題：

資訊看板(Dashboard) 深色主題

除了要登入才能觀看(編輯)提問、Dashboard，它也可以個別將其公開分享出來，不需要登入就可以查看，需要分享給其他人非常方便。

公開分享提問、Dashboard

Database 資料庫

製作圖表 & Dashboard 的源頭就是資料來源，在 Metabase 官方提供以下幾種可以連接 Database 的種類：

或者由官方認證的合作夥伴：

可以看到比較有名的 DB 都有包含在裡面了。

而資料來源除了連接 DB，在最新的 0.47.0 版本也提供讓使用者自行上傳 CSV 檔案的方式。

登入方式

除了一般的 "email&密碼" 之外，也提供 "Google帳號登入"、"LDAP" 的方式，如果公司內部有在使用 LDAP/AD 驗證登入的話，那 Metabase 就可以也採用同樣 LDAP 的方式，員工就不需要還要註冊(記憶)另外一組帳密，還是挺方便的。

Metabase 登入方式

權限設定

可以針對資料庫(甚至細到表格)、資料夾(集合) 去做權限的區分、控管。

Metabase 權限設定

API

還有一點我覺得很不錯的，因為 Metabase 前後端是透過 WebAPI 溝通(幾乎大部分你在網站上的操作，都可以呼叫 API 來完成)，所以你假如會自己寫程式，或有專案想跟 Metabase 整合，就可以透過 WebAPI 跟 Metabase 互動。

Metabase API 使用教學：https://www.metabase.com/learn/administration/metabase-api
Metabase API 文件：https://www.metabase.com/docs/latest/api-documentation

安裝 Metabase

Metabase 有好幾種安裝方式(官方網站都有教學文章)，我這邊就以最簡單的 Docker 方法來示範。

官方安裝文件：https://www.metabase.com/docs/latest/installation-and-operation/start

Docker Run

首先確認電腦有安裝 Docker (網路上有許多文章可以參考，這邊就不贅述了)。

並且執行以下指令來 "下載 image"、"啟動 container"，簡簡單單就將 Metabase 跑起來了。

1
2
3
4
5


# 從 Docker Hub 上下載 metabase image
docker pull metabase/metabase:latest
# 將 image 建立並啟動 container
docker run -d -p 3000:3000 --name metabase metabase/metabase

安裝 Metabase，使用 docker run

(下方還有說明使用 Docker Compose 的作法)

啟動後，接下來要做一些初始化設定。

打開瀏覽器至 http://localhost:3000，會出現這個歡迎畫面 (雖然是簡體中文，但下一步我們可以改語言)。

Metabase 安裝後，初始歡迎畫面

這邊設定預設語言。

Metabase 安裝後，初始設定畫面 (選擇語言)

接下來是一些其他設定，這些在之後都可以進入管理員後台修改。

DB 可以先不用新增，Metabase 有預設的 Sample 資料可以讓我們體驗。

Metabase 安裝後，初始設定畫面

完成後會進到首頁，到這邊就算安裝&初始化完成。

Metabase 首頁

從右上角的設定按鈕，可以進入管理員後台做一些系統方面的設定，包含帳號管理、全線管理、資料庫設定……

Metabase 右上角設定

Metabase 管理員設定

Docker Compose

除了使用 docker run，我們也可以改使用 Docker Compose 的方式來啟動，並且把 Metabase 本身的 DB 改至另外的 PostgreSQL。

* Metabase 本身的 DB 預設是使用附帶的嵌入式 H2，但對於正式生產環境建議使用另外的 DB，目前支援 PostgreSQL、MySQL、MariaDB。( 官方說明 )

以下是 docker-compose.yml 的範例，請依照自己的需求再做修改：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40


version: '3'

services:
 metabase:
 image: metabase/metabase:latest
 container_name: metabase
 restart: always
 # volumes:
 # - ./metabase/plugins:/plugins
 ports:
 - 3000:3000
 environment:
 MB_DB_TYPE: postgres
 MB_DB_HOST: postgres
 MB_DB_PORT: 5432
 MB_DB_DBNAME: metabase
 MB_DB_USER: admin
 MB_DB_PASS: password
 networks:
 - metanet
 depends_on:
 - postgres
 postgres:
 image: postgres:latest
 container_name: postgres
 # ports:
 # - 30003:5432
 restart: always
 volumes:
 - ./postgres:/var/lib/postgresql/data
 environment:
 POSTGRES_DB: metabase
 POSTGRES_USER: admin
 POSTGRES_PASSWORD: password
 networks:
 - metanet

networks:
 metanet:
 driver: bridge

建好我們 mount 出來的資料夾(如上範例是 ./postgres)，並在 docker-compose.yml 的路徑下執行指令啟動：

1
2
3
4
5


# Create and start containers
docker-compose up -d
# Stop and remove containers, networks
docker-compose down

Metabase 管理員設定

後續初始化的內容與上方一樣。

結語

「 Metabase 系列」後續的文章我預計會陸續介紹 "提問(圖表)"、"資訊看板(Dashboard)"、"權限" 等等功能。

如果對於 Metabase 有興趣的讀者，記得『 IT空間』FB 粉專要追蹤起來，才不會錯過最新的發文通知哦~🔔

參考：
Metabase 官方網站
 Metabase 官方文件
 Metabase 官方 GitHub

仰慕對手是無法超越他們的，我們是來超越的，是來登上第一的，
今天就好，把那些仰慕捨棄掉吧，只要想著勝利就好。

—— 大谷翔平 (MLB 棒球選手)

Metabase教學 on IT 空間

[Metabase 系列] Metabase API 使用教學，輕鬆串接自己的系統

前言

Metabase API

API 金鑰 (API key)

Session Token

API 如何使用

備註

結語

[Metabase 系列] 建立 Dashboard (資訊看板、儀表板) 教學

前言

Dashboard 教學

建立 Dashboard

添加 圖表卡片

卡片設定

添加 連結卡片

添加 篩選

添加 文字卡片

分頁標籤 (Tab)

其他功能

訂閱

公開分享

公開連結

嵌入

全螢幕顯示 & 定時刷新 & 導出為 PDF

結語

[Metabase 系列] 建立提問 (Question) 與繪製各式圖表 (Chart) 教學

前言

提問與圖表教學

建立提問

可視化圖表

範例

創建 SQL 查詢

公開分享

各式圖表

結語

[Metabase 系列] Metabase 簡介與安裝教學，BI 工具推薦

前言

Metabase 簡介

價格

提問(圖表) & 資訊看板(Dashboard)

Database 資料庫

登入方式

權限設定

API

更多功能

安裝 Metabase

Docker Run

Docker Compose

結語

添加圖表卡片

添加連結卡片

添加篩選

添加文字卡片