kysely
型別安全的 TypeScript SQL 查詢建構器
kysely 是什麼?
型別安全的 TypeScript SQL 查詢建構器
kysely 概覽
這是什麼
Kysely(發音為「Key-Seh-Lee」)是一個型別安全且支援自動補全的 TypeScript SQL 查詢建構器。它受 Knex.js 啟發,主要為 Node.js 開發,但也可在 Deno、Bun、Cloudflare Workers 及網頁瀏覽器中執行。Kysely 確保你只會引用查詢中可見的資料表與欄位,且結果型別僅包含已選取的欄位及其正確型別與別名。
主要功能
- 型別安全的 SQL 查詢建構,具備完整的 TypeScript 自動補全功能。
- 自動推斷選取子查詢、聯結子查詢、
with陳述式及其他結構中的欄位名稱、別名與型別。 - 提供逃脫機制(例如
sql模板標籤與DynamicModule),以處理編譯時期無法確定型別的情況。 - 所有 API 文件皆撰寫於型別定義檔中,可透過 IDE 懸浮提示檢視。
- 支援多種 JavaScript 環境:Node.js、Deno、Bun、Cloudflare Workers 及瀏覽器。
使用情境
- 在 TypeScript 專案中建構複雜的 SQL 查詢,同時享有編譯時期的型別安全。
- 在 Node.js、Deno 或 Bun 應用程式中取代原始 SQL 字串或型別安全性較低的查詢建構器。
- 在無伺服器環境(如 Cloudflare Workers)中執行資料庫查詢。
- 開發需要精確控制 SQL 並充分利用 TypeScript 型別系統的應用程式。
快速開始
請參閱儲存庫的 README 以取得安裝與快速開始指令。
授權與價格
採用 MIT 授權條款。此專案為開放原始碼且免費使用。
內容整理自該專案公開的 README 與儲存庫資訊。