docs: 完成所有文档的中文翻译并应用到项目

This commit is contained in:
xuxiang
2026-01-28 00:12:54 +08:00
parent 0ced59a26b
commit e133f58e1c
76 changed files with 6808 additions and 6170 deletions

View File

@@ -1,71 +1,71 @@
---
name: postgres-patterns
description: PostgreSQL database patterns for query optimization, schema design, indexing, and security. Based on Supabase best practices.
description: PostgreSQL 数据库模式,涵盖查询优化、模式设计、索引和安全性。基于 Supabase 最佳实践。
---
# PostgreSQL Patterns
# PostgreSQL 模式(Patterns
Quick reference for PostgreSQL best practices. For detailed guidance, use the `database-reviewer` agent.
PostgreSQL 最佳实践快速参考。如需详细指导,请使用 `database-reviewer` 智能体Agent)。
## When to Activate
## 何时激活
- Writing SQL queries or migrations
- Designing database schemas
- Troubleshooting slow queries
- Implementing Row Level Security
- Setting up connection pooling
- 编写 SQL 查询或迁移Migrations
- 设计数据库模式Schemas
- 排除慢查询故障
- 实现行级安全性(Row Level Security, RLS
- 设置连接池Connection Pooling
## Quick Reference
## 快速参考
### Index Cheat Sheet
### 索引备忘单(Index Cheat Sheet
| Query Pattern | Index Type | Example |
| 查询模式 | 索引类型 | 示例 |
|--------------|------------|---------|
| `WHERE col = value` | B-tree (default) | `CREATE INDEX idx ON t (col)` |
| `WHERE col = value` | B-tree(默认) | `CREATE INDEX idx ON t (col)` |
| `WHERE col > value` | B-tree | `CREATE INDEX idx ON t (col)` |
| `WHERE a = x AND b > y` | Composite | `CREATE INDEX idx ON t (a, b)` |
| `WHERE a = x AND b > y` | 复合索引(Composite | `CREATE INDEX idx ON t (a, b)` |
| `WHERE jsonb @> '{}'` | GIN | `CREATE INDEX idx ON t USING gin (col)` |
| `WHERE tsv @@ query` | GIN | `CREATE INDEX idx ON t USING gin (col)` |
| Time-series ranges | BRIN | `CREATE INDEX idx ON t USING brin (col)` |
| 时序范围(Time-series ranges | BRIN | `CREATE INDEX idx ON t USING brin (col)` |
### Data Type Quick Reference
### 数据类型快速参考
| Use Case | Correct Type | Avoid |
| 用例 | 正确类型 | 避免使用 |
|----------|-------------|-------|
| IDs | `bigint` | `int`, random UUID |
| Strings | `text` | `varchar(255)` |
| Timestamps | `timestamptz` | `timestamp` |
| Money | `numeric(10,2)` | `float` |
| Flags | `boolean` | `varchar`, `int` |
| ID | `bigint` | `int`, 随机 UUID |
| 字符串 | `text` | `varchar(255)` |
| 时间戳 | `timestamptz` | `timestamp` |
| 金额 | `numeric(10,2)` | `float` |
| 标志位(Flags | `boolean` | `varchar`, `int` |
### Common Patterns
### 常用模式
**Composite Index Order:**
**复合索引顺序:**
```sql
-- Equality columns first, then range columns
-- 等值列(Equality columns在前范围列Range columns)在后
CREATE INDEX idx ON orders (status, created_at);
-- Works for: WHERE status = 'pending' AND created_at > '2024-01-01'
-- 适用于:WHERE status = 'pending' AND created_at > '2024-01-01'
```
**Covering Index:**
**覆盖索引(Covering Index**
```sql
CREATE INDEX idx ON users (email) INCLUDE (name, created_at);
-- Avoids table lookup for SELECT email, name, created_at
-- 避免在执行 SELECT email, name, created_at 时进行表查找Table lookup
```
**Partial Index:**
**部分索引(Partial Index**
```sql
CREATE INDEX idx ON users (email) WHERE deleted_at IS NULL;
-- Smaller index, only includes active users
-- 索引体积更小,仅包含活动用户
```
**RLS Policy (Optimized):**
**RLS 策略(已优化):**
```sql
CREATE POLICY policy ON orders
USING ((SELECT auth.uid()) = user_id); -- Wrap in SELECT!
USING ((SELECT auth.uid()) = user_id); -- 包裹在 SELECT 中!
```
**UPSERT:**
**UPSERT(更新插入):**
```sql
INSERT INTO settings (user_id, key, value)
VALUES (123, 'theme', 'dark')
@@ -73,13 +73,13 @@ ON CONFLICT (user_id, key)
DO UPDATE SET value = EXCLUDED.value;
```
**Cursor Pagination:**
**游标分页(Cursor Pagination**
```sql
SELECT * FROM products WHERE id > $last_id ORDER BY id LIMIT 20;
-- O(1) vs OFFSET which is O(n)
-- O(1) 复杂度,对比 OFFSET O(n) 复杂度
```
**Queue Processing:**
**队列处理:**
```sql
UPDATE jobs SET status = 'processing'
WHERE id = (
@@ -89,10 +89,10 @@ WHERE id = (
) RETURNING *;
```
### Anti-Pattern Detection
### 反模式(Anti-Pattern)检测
```sql
-- Find unindexed foreign keys
-- 查找未建立索引的外键
SELECT conrelid::regclass, a.attname
FROM pg_constraint c
JOIN pg_attribute a ON a.attrelid = c.conrelid AND a.attnum = ANY(c.conkey)
@@ -102,45 +102,45 @@ WHERE c.contype = 'f'
WHERE i.indrelid = c.conrelid AND a.attnum = ANY(i.indkey)
);
-- Find slow queries
-- 查找慢查询
SELECT query, mean_exec_time, calls
FROM pg_stat_statements
WHERE mean_exec_time > 100
ORDER BY mean_exec_time DESC;
-- Check table bloat
-- 检查表膨胀Table bloat
SELECT relname, n_dead_tup, last_vacuum
FROM pg_stat_user_tables
WHERE n_dead_tup > 1000
ORDER BY n_dead_tup DESC;
```
### Configuration Template
### 配置模板
```sql
-- Connection limits (adjust for RAM)
-- 连接限制(根据 RAM 调整)
ALTER SYSTEM SET max_connections = 100;
ALTER SYSTEM SET work_mem = '8MB';
-- Timeouts
-- 超时设置
ALTER SYSTEM SET idle_in_transaction_session_timeout = '30s';
ALTER SYSTEM SET statement_timeout = '30s';
-- Monitoring
-- 监控
CREATE EXTENSION IF NOT EXISTS pg_stat_statements;
-- Security defaults
-- 安全默认设置
REVOKE ALL ON SCHEMA public FROM public;
SELECT pg_reload_conf();
```
## Related
## 相关内容
- Agent: `database-reviewer` - Full database review workflow
- Skill: `clickhouse-io` - ClickHouse analytics patterns
- Skill: `backend-patterns` - API and backend patterns
- 智能体(Agent`database-reviewer` - 完整的数据库审查工作流
- 技能(Skill`clickhouse-io` - ClickHouse 分析模式
- 技能(Skill`backend-patterns` - API 和后端模式
---
*Based on [Supabase Agent Skills](https://github.com/supabase/agent-skills) (MIT License)*
*基于 [Supabase Agent Skills](https://github.com/supabase/agent-skills) (MIT 许可证)*