Back to Details

redis-development

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Redis Best Practices

Redis 最佳实践

Comprehensive performance optimization guide for Redis, including Redis Query Engine, vector search, and semantic caching. Contains 29 rules across 11 categories, prioritized by impact to guide automated optimization and code generation.
一份全面的Redis性能优化指南，涵盖Redis Query Engine、向量搜索和语义缓存。包含11个类别下的29条规则，按影响优先级排序，可指导自动化优化与代码生成。

When to Apply

适用场景

Reference these guidelines when:
  • Designing Redis data models and key structures
  • Implementing caching, sessions, or real-time features
  • Using Redis Query Engine (FT.CREATE, FT.SEARCH, FT.AGGREGATE)
  • Building vector search or RAG applications with RedisVL
  • Implementing semantic caching with LangCache
  • Optimizing Redis performance and memory usage
在以下场景中参考本指南：
  • 设计Redis数据模型与键结构
  • 实现缓存、会话或实时功能
  • 使用Redis Query Engine（FT.CREATE、FT.SEARCH、FT.AGGREGATE）
  • 借助RedisVL构建向量搜索或RAG应用
  • 使用LangCache实现语义缓存
  • 优化Redis性能与内存使用

Rule Categories by Priority

按优先级划分的规则类别

PriorityCategoryImpactPrefix
1Data Structures & KeysHIGH
data-
2Memory & ExpirationHIGH
ram-
3Connection & PerformanceHIGH
conn-
4JSON DocumentsMEDIUM
json-
5Redis Query EngineHIGH
rqe-
6Vector Search & RedisVLHIGH
vector-
7Semantic CachingMEDIUM
semantic-cache-
8Streams & Pub/SubMEDIUM
stream-
9Clustering & ReplicationMEDIUM
cluster-
10SecurityHIGH
security-
11ObservabilityMEDIUM
observe-
优先级类别影响程度前缀
1数据结构与键高
data-
2内存与过期策略高
ram-
3连接与性能高
conn-
4JSON文档中
json-
5Redis Query Engine高
rqe-
6向量搜索与RedisVL高
vector-
7语义缓存中
semantic-cache-
8流与发布/订阅中
stream-
9集群与复制中
cluster-
10安全高
security-
11可观测性中
observe-

Quick Reference

快速参考

1. Data Structures & Keys (HIGH)

1. 数据结构与键（高优先级）

  • data-choose-structure
    - Choose the Right Data Structure
  • data-key-naming
    - Use Consistent Key Naming Conventions
  • data-choose-structure
    - 选择合适的数据结构
  • data-key-naming
    - 使用一致的键命名规范

2. Memory & Expiration (HIGH)

2. 内存与过期策略（高优先级）

  • ram-limits
    - Configure Memory Limits and Eviction Policies
  • ram-ttl
    - Set TTL on Cache Keys
  • ram-limits
    - 配置内存限制与淘汰策略
  • ram-ttl
    - 为缓存键设置TTL

3. Connection & Performance (HIGH)

3. 连接与性能（高优先级）

  • conn-blocking
    - Avoid Slow Commands in Production
  • conn-pipelining
    - Use Pipelining for Bulk Operations
  • conn-pooling
    - Use Connection Pooling or Multiplexing
  • conn-timeouts
    - Configure Connection Timeouts
  • conn-blocking
    - 生产环境中避免使用慢命令
  • conn-pipelining
    - 批量操作使用流水线技术
  • conn-pooling
    - 使用连接池或多路复用
  • conn-timeouts
    - 配置连接超时

4. JSON Documents (MEDIUM)

4. JSON文档（中优先级）

  • json-partial-updates
    - Use JSON Paths for Partial Updates
  • json-vs-hash
    - Choose JSON vs Hash Appropriately
  • json-partial-updates
    - 使用JSON路径进行部分更新
  • json-vs-hash
    - 合理选择JSON与哈希结构

5. Redis Query Engine (HIGH)

5. Redis Query Engine（高优先级）

  • rqe-dialect
    - Use DIALECT 2 for Query Syntax
  • rqe-field-types
    - Choose the Correct Field Type
  • rqe-index-creation
    - Index Only Fields You Query
  • rqe-index-management
    - Manage Indexes for Zero-Downtime Updates
  • rqe-query-optimization
    - Write Efficient Queries
  • rqe-dialect
    - 使用DIALECT 2查询语法
  • rqe-field-types
    - 选择正确的字段类型
  • rqe-index-creation
    - 仅为查询字段创建索引
  • rqe-index-management
    - 管理索引以实现零停机更新
  • rqe-query-optimization
    - 编写高效查询语句

6. Vector Search & RedisVL (HIGH)

6. 向量搜索与RedisVL（高优先级）

  • vector-algorithm-choice
    - Choose HNSW vs FLAT Based on Requirements
  • vector-hybrid-search
    - Use Hybrid Search for Better Results
  • vector-index-creation
    - Configure Vector Indexes Properly
  • vector-rag-pattern
    - Implement RAG Pattern Correctly
  • vector-algorithm-choice
    - 根据需求选择HNSW或FLAT算法
  • vector-hybrid-search
    - 使用混合搜索提升结果质量
  • vector-index-creation
    - 正确配置向量索引
  • vector-rag-pattern
    - 正确实现RAG模式

7. Semantic Caching (MEDIUM)

7. 语义缓存（中优先级）

  • semantic-cache-best-practices
    - Configure Semantic Cache Properly
  • semantic-cache-langcache-usage
    - Use LangCache for LLM Response Caching
  • semantic-cache-best-practices
    - 正确配置语义缓存
  • semantic-cache-langcache-usage
    - 使用LangCache缓存LLM响应

8. Streams & Pub/Sub (MEDIUM)

8. 流与发布/订阅（中优先级）

  • stream-choosing-pattern
    - Choose Streams vs Pub/Sub Appropriately
  • stream-choosing-pattern
    - 合理选择流或发布/订阅模式

9. Clustering & Replication (MEDIUM)

9. 集群与复制（中优先级）

  • cluster-hash-tags
    - Use Hash Tags for Multi-Key Operations
  • cluster-read-replicas
    - Use Read Replicas for Read-Heavy Workloads
  • cluster-hash-tags
    - 多键操作使用哈希标签
  • cluster-read-replicas
    - 读密集型工作负载使用只读副本

10. Security (HIGH)

10. 安全（高优先级）

  • security-acls
    - Use ACLs for Fine-Grained Access Control
  • security-auth
    - Always Use Authentication in Production
  • security-network
    - Secure Network Access
  • security-acls
    - 使用ACLs实现细粒度访问控制
  • security-auth
    - 生产环境中始终启用认证
  • security-network
    - 保障网络访问安全

11. Observability (MEDIUM)

11. 可观测性（中优先级）

  • observe-commands
    - Use Observability Commands for Debugging
  • observe-metrics
    - Monitor Key Redis Metrics
  • observe-commands
    - 使用可观测性命令进行调试
  • observe-metrics
    - 监控关键Redis指标

How to Use

使用方法

Read individual rule files for detailed explanations and code examples:
rules/rqe-index-creation.md
rules/vector-rag-pattern.md
Each rule file contains:
  • Brief explanation of why it matters
  • Incorrect example with explanation
  • Correct example with explanation
  • Additional context and references
阅读单个规则文件获取详细说明与代码示例：
rules/rqe-index-creation.md
rules/vector-rag-pattern.md
每个规则文件包含：
  • 规则重要性的简要说明
  • 错误示例及解释
  • 正确示例及解释
  • 额外背景信息与参考资料

Full Compiled Document

完整编译文档

For the complete guide with all rules expanded: 
AGENTS.md
如需查看包含所有扩展规则的完整指南，请参考：
AGENTS.md