supabase-postgres-best-practices

概覽

什麼是 supabase-postgres-best-practices？

Supabase Postgres 最佳實踐是一套由 Supabase 維護的技能，旨在協助開發者與資料庫工程師優化 Postgres 的效能。此技能提供具體的規則與範例，涵蓋高效 SQL 查詢撰寫、穩健架構設計、連線管理及安全性最佳實務，內容涵蓋八大關鍵類別，包括查詢效能、連線管理、安全性（含列級安全）、架構設計、併發控制、資料存取模式、監控以及進階 Postgres 功能。

適合誰使用此技能？

• 使用 Postgres 或 Supabase 的後端開發者
• 希望提升資料庫穩定性與速度的資料庫工程師
• 需要審查或重構 SQL 查詢與資料庫架構的團隊
• 配置高併發或無伺服器環境的任何人

解決的問題

• 識別並修正常見的 Postgres 反模式
• 提供具體的 SQL 重寫範例與效能指標
• 預防慢查詢、連線瓶頸與安全性錯誤配置
• 提供優先排序的指導，涵蓋關鍵與漸進式改進

使用說明

安裝步驟

1. 將技能加入您的代理或專案：

   npx skills add https://github.com/supabase/agent-skills --skill supabase-postgres-best-practices
   

2. 從主要文件開始：
   • 開啟 SKILL.md，了解所有最佳實踐與規則類別概覽。
   • 查看 AGENTS.md，取得彙整且可導覽的所有參考資料清單。
3. 深入探索主題：
   • 瀏覽 references/ 資料夾，深入了解全文檢索、JSONB 索引、連線池與查詢優化等主題。
   • 使用 references/_sections.md 了解各規則類別的影響力與優先順序。
4. 整合至您的工作流程：
   • 將相關規則與 SQL 範例融入程式碼審查、資料庫遷移或自動化檢查。
   • 若計畫擴充或自訂技能，請參考 README.md 了解貢獻與驗證指引。

主要檔案與資料夾

• SKILL.md：技能主檔與概覽（請先閱讀）
• AGENTS.md：代理端彙整文件
• references/：各項最佳實踐指南（如 query-missing-indexes.md、conn-pooling.md）
• README.md：貢獻與驗證說明

範例應用場景

• 使用查詢效能規則重構慢查詢
• 依照架構最佳實踐設計新資料表
• 為無伺服器應用設定連線池
• 以明確且可執行的模式強制列級安全

常見問題

什麼時候應該使用 supabase-postgres-best-practices？

當您撰寫、審查或優化 Postgres 查詢，設計架構，配置連線或實施安全策略時，都適合使用此技能。特別是在程式碼審查、資料庫遷移與效能排錯階段。

這個技能與一般 Postgres 指南有何不同？

此技能由 Supabase 精心策劃，強調具體且可執行的規則，附有前後對比的 SQL 範例、量化效能影響，並以代理友善的結構呈現，專為實務應用於真實 Postgres 與 Supabase 專案設計。

如何找到最適合我使用情境的最佳實踐？

請先閱讀 SKILL.md，了解所有類別與優先順序。針對特定主題，瀏覽 references/ 資料夾或查閱 AGENTS.md 的導覽清單。每個參考文件均有清楚標題與標籤，方便搜尋。

我可以貢獻或自訂此技能嗎？

可以。請依照 references/_contributing.md 與 README.md 的指引，新增最佳實踐或調整現有規則以符合您的環境。技能內含驗證與建置腳本以確保品質。

哪裡可以看到實際的 SQL 範例？

references/ 資料夾中的每個參考文件都包含錯誤與正確的 SQL 範例，並附有說明與相關官方文件連結。

欲查看完整檔案結構與所有可用參考，請在您的代理或程式碼庫瀏覽器中開啟檔案標籤。