supabase-postgres-best-practices

概览

什么是 supabase-postgres-best-practices？

Supabase Postgres 最佳实践是一项精心策划的技能，旨在帮助开发者和数据库工程师优化 Postgres 性能。由 Supabase 维护，该技能提供了切实可行的规则和示例，涵盖高效 SQL 查询编写、稳健的模式设计、连接管理以及安全最佳实践。内容涵盖八大关键类别，包括查询性能、连接管理、安全（含行级安全）、模式设计、并发、数据访问模式、监控以及高级 Postgres 功能。

谁适合使用此技能？

• 使用 Postgres 或 Supabase 的后端开发人员
• 致力于提升数据库可靠性和性能的数据库工程师
• 负责审查或重构 SQL 查询和数据库模式的团队
• 配置高并发或无服务器环境中 Postgres 的任何人员

它解决了哪些问题

• 识别并纠正常见的 Postgres 反模式
• 提供具体的 SQL 重写示例和性能指标
• 帮助避免慢查询、连接瓶颈和安全配置错误
• 针对关键和渐进式改进提供优先级指导

使用方法

安装步骤

1. 将技能添加到您的 agent 或项目中：

   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：面向 agent 的汇总文档
• references/：各项最佳实践指南（如 query-missing-indexes.md、conn-pooling.md）
• README.md：贡献和验证说明

示例用例

• 使用查询性能规则重构慢查询
• 按最佳实践设计新表结构
• 为无服务器应用配置连接池
• 通过明确且可操作的模式实施行级安全

常见问题

什么时候应该使用 supabase-postgres-best-practices？

在编写、审查或优化 Postgres 查询，设计模式，配置连接或实施安全策略时，均可使用此技能。它在代码审查、数据库迁移和性能排查过程中尤为有价值。

这项技能与一般的 Postgres 指南有何不同？

该技能由 Supabase 精心策划，重点提供具体、可操作的规则，配有前后对比的 SQL 示例、量化的性能影响以及适合 agent 使用的结构，专为实际 Postgres 和 Supabase 项目设计。

如何找到最适合我使用场景的最佳实践？

从 SKILL.md 开始，查看所有类别和优先级。针对具体主题，浏览 references/ 文件夹或查阅 AGENTS.md 中的导航列表。每个参考文档都包含清晰的标题和标签，便于查找。

我可以贡献或定制这项技能吗？

可以。请遵循 references/_contributing.md 和 README.md 中的指南，添加新的最佳实践或根据您的环境调整现有内容。技能包含验证和构建脚本以确保质量。

哪里可以看到真实的 SQL 示例？

references/ 文件夹中的每个参考文档都包含错误和正确的 SQL 模式示例，附有解释和相关官方文档链接。

完整的文件树和所有可用参考，请在您的 agent 或代码库浏览器中打开“文件”标签查看。