本頁面由英文在 AI 協助下翻譯而成。若兩者有出入,請以英文版本為準。
什麼是 SQL for APIs?
SQL for APIs(適用於 API 的 SQL)是一種設計模式,將 API 作業投影到關聯式語意上:列出與取得作業成為 SELECT,建立作業成為 INSERT,修改作業成為 UPDATE 或 REPLACE,移除作業成為 DELETE。API 的回應物件成為資料列;其屬性成為資料行。此模式讓任何 REST 或 RPC API 都具備資料庫的易用性,而不需要 API 供應商做任何變更。
運作方式
這種對應是機械式的,正因如此才能通用化:
| API 概念 | 關聯式概念 |
|---|---|
| Provider(AWS、GitHub) | schema 命名空間 |
| 服務(EC2、repos) | 子 schema |
| 資源集合 | 資料表 |
| 列出 / 取得作業 | SELECT 方法 |
| 建立作業 | INSERT 方法 |
| Patch / put 作業 | UPDATE / REPLACE 方法 |
| 刪除作業 | DELETE 方法 |
| 其他生命週期動作(啟動、停止、重新開機) | EXEC 方法 |
| 必要的路徑或查詢參數 | 必要的 WHERE 子句述詞 |
| 要求本文欄位 | 以 data__ 為前置詞的插入/更新資料行 |
在 StackQL 中,此對應是從保存在開放的 StackQL Provider 登錄庫 中的擴充 OpenAPI 規格產生的。必要的 API 參數可在執行階段探索:SHOW METHODS IN aws.ec2.instances 會傳回每個方法的 SQL 動詞及其必要參數,因此人員或 AI 代理程式不必閱讀 Provider 文件,就能推導出正確的查詢。
範例
讀取是一個 SELECT,其 WHERE 子句帶有 API 的必要參數:
SELECT name, language, stargazers_count
FROM github.repos.repos
WHERE org = 'stackql';
建立是一個 INSERT,其資料行帶有要求本文(前置詞為 data__)與路由參數:
INSERT INTO google.storage.buckets(
project,
data__name,
data__location
)
SELECT
'my-project',
'my-new-bucket',
'US';
SHOW INSERT INTO google.storage.buckets 會以機械方式產生此範本,包括所有可寫入的欄位。
為何存在
SQL 是現存部署最廣泛的查詢語言,擁有五十年的工具生態:驅動程式、ORM、BI 平台、筆記本,以及日益重要的 LLM 訓練資料。每個主流 AI 模型都已經能夠讀寫合格的 SQL。將 API 投影到 SQL,意味著所有這些工具與模型能力都能立即套用到任何 API 介面。另一種做法是為每個 Provider、每種語言各提供一個 SDK,這會使整合工作倍增,也無法為代理程式提供任何可重複使用的東西。這個論點在為什麼 SQL 是雲端 API 的強大介面中有進一步闡述。
相關概念
- 什麼是 StackQL?:此模式針對雲端與 SaaS API 的參考實作
- 什麼是可查詢基礎架構?:此模式所促成的運作模式
- 為什麼 SQL 是雲端 API 的強大介面:深入說明設計理由
- StackQL 架構概觀:此對應如何實作
- 如何使用 StackQL 查詢 GitHub 存放庫:將此模式套用到 SaaS API