跳至主要內容
翻譯頁面

本頁面由英文在 AI 協助下翻譯而成。若兩者有出入,請以英文版本為準。

開始使用 StackQL

本教學分三個階段,從安裝一路到即時查詢:對公開 GitHub 資料執行未經驗證的查詢(不需要憑證)、使用中繼命令探索 schema,以及對 AWS 執行經過驗證的雲端查詢。

1. 安裝​

macOS (Homebrew):

brew install stackql

Linux:

curl -L https://bit.ly/stackql-zip -O && unzip stackql-zip

Windows、套件與 Docker 映像檔的安裝方式請參閱安裝頁面。使用 stackql --version 驗證安裝,然後啟動互動式 shell:

stackql shell

2. 第一個查詢:不需要憑證​

提取 GitHub Provider 並查詢公開組織:

REGISTRY PULL github;

SELECT name, description, language, stargazers_count
FROM github.repos.repos
WHERE org = 'stackql';

傳回的資料列(包括 stackql 引擎存放庫本身)都是在查詢時轉換為關聯式資料的即時 GitHub API 回應。沒有任何資料經過同步、快取或匯入。(未經驗證的 GitHub 存取限制為每小時 60 個要求;個人存取權杖可提高此限制。)

3. 探索 schema​

Provider 介面可自我描述,您(或 AI 代理程式)可藉此了解哪些內容可以查詢,而無須閱讀 Provider 文件:

SHOW PROVIDERS; -- installed providers
SHOW SERVICES IN github; -- services in a provider
SHOW RESOURCES IN github.repos; -- tables in a service
SHOW METHODS IN github.repos.repos; -- operations + required parameters
DESCRIBE github.repos.repos; -- columns

最需要記住的是 SHOW METHODS:其 RequiredParams 資料行會確切告訴您每個作業在 WHERE 子句中需要什麼,以及由哪個 SQL 動詞(SELECT、INSERT、UPDATE、DELETE、EXEC)叫用該作業。

4. 查詢雲端供應商​

匯出憑證(此處以 AWS 為例;Azure 和 Google Cloud 的做法相同)、提取 Provider,然後查詢:

export AWS_ACCESS_KEY_ID=YOURACCESSKEYID
export AWS_SECRET_ACCESS_KEY=YOURSECRETACCESSKEY
REGISTRY PULL aws;

SELECT instance_id, instance_type, launch_time
FROM aws.ec2.instances
WHERE region = 'us-east-1';

彙總會自動扇出,以下查詢會以各區域平行的 API 呼叫執行:

SELECT region, COUNT(*) as num_instances
FROM aws.ec2.instances
WHERE region IN ('us-east-1','us-west-2','eu-west-1')
GROUP BY region;

5. 後續步驟​

  • 變更:SHOW INSERT INTO <resource> 會產生建立範本;INSERT/UPDATE/DELETE 作用於您所查詢的相同資料表。
  • 伺服器模式:stackql srv 公開 PostgreSQL 線路協定,供 psql、DBeaver、BI 工具與 pandas 使用。
  • AI 代理程式:stackql mcp 會執行內建的 MCP 伺服器,請參閱如何搭配 AI 代理程式使用 StackQL。
  • Python:pip install pystackql,用於筆記本與管線。