redis-development

Redis のベストプラクティス

Redis Query Engine、ベクトル検索、セマンティックキャッシュを含む、Redis の包括的なパフォーマンス最適化ガイドです。11 のカテゴリにわたる 29 のルールを掲載し、自動最適化とコード生成を支援するため、影響度順に優先順位を付けています。

適用するタイミング

次のような場合に、これらのガイドラインを参照してください。

• Redis のデータモデルとキー構造を設計するとき
• キャッシュ、セッション、リアルタイム機能を実装するとき
• Redis Query Engine（FT.CREATE、FT.SEARCH、FT.AGGREGATE）を使用するとき
• RedisVL を使用してベクトル検索や RAG アプリケーションを構築するとき
• LangCache を使用してセマンティックキャッシュを実装するとき
• Redis のパフォーマンスとメモリ使用量を最適化するとき

優先度別のルールカテゴリ

優先度	カテゴリ	影響度	プレフィックス
1	データ構造とキー	高	data-
2	メモリと有効期限	高	ram-
3	接続とパフォーマンス	高	conn-
4	JSON ドキュメント	中	json-
5	Redis Query Engine	高	rqe-
6	ベクトル検索と RedisVL	高	vector-
7	セマンティックキャッシュ	中	semantic-cache-
8	ストリームと Pub/Sub	中	stream-
9	クラスタリングとレプリケーション	中	cluster-
10	セキュリティ	高	security-
11	可観測性	中	observe-

クイックリファレンス

1. データ構造とキー（高）

• data-choose-structure - 適切なデータ構造を選択する
• data-key-naming - 一貫したキーの命名規則を使用する

2. メモリと有効期限（高）

• ram-limits - メモリ制限とエビクションポリシーを設定する
• ram-ttl - キャッシュキーに TTL を設定する

3. 接続とパフォーマンス（高）

• conn-blocking - 本番環境で時間のかかるコマンドを避ける
• conn-pipelining - 一括操作にパイプライン処理を使用する
• conn-pooling - コネクションプーリングまたは多重化を使用する
• conn-timeouts - 接続タイムアウトを設定する

4. JSON ドキュメント（中）

• json-partial-updates - 部分更新には JSON パスを使用する
• json-vs-hash - JSON と Hash を適切に使い分ける

5. Redis Query Engine（高）

• rqe-dialect - クエリ構文には DIALECT 2 を使用する
• rqe-field-types - 正しいフィールドタイプを選択する
• rqe-index-creation - クエリするフィールドのみをインデックス化する
• rqe-index-management - ダウンタイムなしの更新に向けてインデックスを管理する
• rqe-query-optimization - 効率的なクエリを記述する

6. ベクトル検索と RedisVL（高）

• vector-algorithm-choice - 要件に応じて HNSW と FLAT を選択する
• vector-hybrid-search - より良い結果を得るためにハイブリッド検索を使用する
• vector-index-creation - ベクトルインデックスを適切に設定する
• vector-rag-pattern - RAG パターンを正しく実装する

7. セマンティックキャッシュ（中）

• semantic-cache-best-practices - セマンティックキャッシュを適切に設定する
• semantic-cache-langcache-usage - LLM の応答キャッシュに LangCache を使用する

8. ストリームと Pub/Sub（中）

• stream-choosing-pattern - ストリームと Pub/Sub を適切に使い分ける

9. クラスタリングとレプリケーション（中）

• cluster-hash-tags - 複数キー操作にハッシュタグを使用する
• cluster-read-replicas - 読み取り負荷の高いワークロードにリードレプリカを使用する

10. セキュリティ（高）

• security-acls - きめ細かなアクセス制御に ACL を使用する
• security-auth - 本番環境では必ず認証を使用する
• security-network - ネットワークアクセスを保護する

11. 可観測性（中）

• observe-commands - デバッグに可観測性コマンドを使用する
• observe-metrics - Redis の主要なメトリクスを監視する

使用方法

詳細な説明とコード例については、各ルールファイルを参照してください。

rules/rqe-index-creation.md
rules/vector-rag-pattern.md

各ルールファイルには、次の内容が含まれています。

• 重要である理由の簡単な説明
• 説明付きの適切な例
• （実害をもたらすアンチパターンの場合）「不適切な例」、または（任意の機能の場合）「使用する場合／不要な場合」のガイダンス
• 補足情報と参考資料

完全版ドキュメント

すべてのルールを詳しく説明した完全なガイドについては、AGENTS.md を参照してください。