mcpField
P
postgresql-expert-best-practices-code-review

postgresql-expert-best-practices-code-review

github.com/wispbit-ai数据与数据库8387 次安装37 周前更新
代码仓库

关于 postgresql-expert-best-practices-code-review

面向编写或审查 PostgreSQL 数据库结构、迁移和查询的开发者,提供生产环境实践指南。规则按优先级组织,并通过错误与修正示例说明迁移做法。

主要功能

  1. 01按优先级整理索引规则
  2. 02更安全地修改约束与外键
  3. 03数据库结构与命名指南
  4. 04错误及修正迁移示例

适用场景

  1. 01检查数据库结构的性能问题
  2. 02添加索引时避免阻塞写入
  3. 03规划更安全的约束迁移

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/wispbit-ai/skills --skill postgresql-expert-best-practices-code-review

安装后在 Claude Code 中输入/postgresql-expert-best-practices-code-review确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

rules/
add-index-for-foreign-key.md
always-include-columns.md
column-naming-standards.md
index-naming-standards.md
limit-non-unique-index.md
only-concurrent-indexes.md
only-jsonb.md
set-column-not-null.md
split-foreign-key.md
unique-constraint.md

详细介绍

PostgreSQL 专家最佳实践

简单、务实、有主见。只关注编写生产级 PostgreSQL 查询时真正重要的内容。

适用场景

在以下情况下参考这些指南:

  • 编写数据库迁移或架构变更
  • 创建或修改 PostgreSQL 表和列
  • 添加索引、约束或外键
  • 检查数据库架构中的性能问题
  • 重构现有数据库结构
  • 优化查询性能或数据库设计

按优先级划分的规则类别

优先级类别影响前缀
1索引管理极高only-concurrent-indexes、add-index-for-foreign-key
2约束安全高unique-constraint、split-foreign-key、set-column-not-null
3架构设计中only-jsonb、always-include-columns、limit-non-unique-index
4命名规范低index-naming-standards、column-naming-standards

快速参考

  • only-concurrent-indexes - 始终使用 CONCURRENTLY,防止创建索引时阻塞写入
  • add-index-for-foreign-key - 为外键创建索引,以提升查询性能
  • unique-constraint - 将创建唯一约束拆分为并发创建索引和添加约束两个步骤
  • split-foreign-key - 先添加未经验证的外键,再单独进行验证
  • set-column-not-null - 设置 NOT NULL 前使用检查约束,避免锁定表
  • only-jsonb - 使用 JSONB 而不是 JSON,以获得更好的性能和索引功能
  • always-include-columns - 所有表都应包含 id、created_at 和 updated_at,以便审计
  • limit-non-unique-index - 为提升效率,将非唯一索引限制为最多三列
  • index-naming-standards - 采用一致的索引命名方式:idx_tablename_columnname
  • column-naming-standards - 保持一致的 snake_case 命名方式,并为外键使用 id 后缀

使用方法

阅读各规则文件,了解详细说明和代码示例:

rules/only-concurrent-indexes.md
rules/add-index-for-foreign-key.md
rules/unique-constraint.md
rules/split-foreign-key.md
rules/set-column-not-null.md
rules/only-jsonb.md
rules/always-include-columns.md
rules/limit-non-unique-index.md
rules/index-naming-standards.md
rules/column-naming-standards.md

每个规则文件都包含:

  • 简要说明其重要性
  • 影响级别及说明
  • 错误迁移示例及解释
  • 遵循最佳实践的正确迁移示例
  • 补充背景和参考资料

评论

支持 Markdown