RedisのKEYSコマンド徹底解説 – パターンに一致するキーを取得する方法

このチュートリアルでは、redis-cliで使えるKEYSコマンドを使って、Redisデータストアに保存されている1つ以上のキーを取得する方法を解説します。

KEYSコマンドは、指定したパターンに一致するキーをすべて返すコマンドです。パターンはglobスタイル（グロブ形式）で指定します。

globスタイルのパターン一覧

1. * （アスタリスク）： スペースを含む任意の0文字以上に一致します。例えば foo* は fooccc、foo、fooq などにマッチします。
2. ? （クエスチョンマーク）： スペースを含む任意の1文字に一致します。例えば f?o は fao、fbo、fco などにマッチします。
3. [list] ： リスト内のいずれか1文字に一致します。例えば f[abc]o は fao、fbo、fco にはマッチしますが、fdo、feo にはマッチしません。
4. [^list] ： リストに含まれない1文字に一致します。例えば f[^abc]o は fdo、feo にはマッチしますが、fao、fbo にはマッチしません。
5. [a-z] ： aからzまでのいずれか1文字に一致します。同様に [A-Z] はAからZまで、[0-9] は0から9までの1文字にそれぞれマッチします。

特殊文字をエスケープしたい場合は、\（バックスラッシュ）を使用してください。

KEYSコマンドの構文

redis host:port> KEYS <pattern>

戻り値

- (array) reply：指定したパターンに一致するキーのリストを返します。

使用例

実際にredis-cliでKEYSコマンドを実行すると、以下のようにパターンに一致するキーが配列として表示されます。

注意点

KEYSコマンドはデータベース全体をスキャンするため、大量のキーが存在する本番環境での実行は避けましょう。パフォーマンスへの影響が大きいため、実運用では SCAN コマンドの利用が推奨されています。

参考資料

1. KEYSコマンド公式ドキュメント

以上が、Redisデータストアからパターンに一致するキーを取得する方法でした。この記事が役に立った場合は、ぜひコメント欄で感想を共有したり、他の方にもシェアしてみてください。