Redisでキーに有効期限（TTL）を設定する方法 – EXPIRE・PEXPIRE・EXPIREAT・PEXPIREATコマンド徹底解説

このチュートリアルでは、Redisのキーに有効期限（タイムアウト）を設定する方法を、EXPIRE、PEXPIRE、EXPIREAT、PEXPIREATの4つのコマンドを使って詳しく解説します。用途に応じて秒単位・ミリ秒単位、あるいはUnixタイムスタンプでの指定が可能です。

秒単位で有効期限を設定する（EXPIRE）

キーに秒単位の有効期限を設定するには、redis-cliでEXPIREコマンドを使用します。指定した秒数はTTL（Time To Live：生存時間）として扱われます。なお、秒数に0以下の値を指定した場合、キーは即座に削除されるので注意してください。

構文

redis host:post> EXPIRE <key name> <seconds>

戻り値

1 : 有効期限が正常に設定された場合
0 : 指定したキーが存在しない場合

実行例

ミリ秒単位で有効期限を設定する（PEXPIRE）

より細かい単位で有効期限を制御したい場合は、ミリ秒単位で期限を設定できるPEXPIREコマンドを使用します。キャッシュの精密な制御などに便利です。

構文

redis host:post> PEXPIRE <key name> <milliseconds>

戻り値

1 : 有効期限が正常に設定された場合
0 : 指定したキーが存在しない場合

実行例

Unixタイムスタンプ（秒）で有効期限を設定する（EXPIREAT）

有効期限を相対時間ではなく絶対的な日時で指定したい場合は、EXPIREATコマンドを使用します。Unixタイムスタンプとは、1970年1月1日0時0分0秒（UTC）からの経過秒数を表す値です。過去の日時を指定すると、キーは即座に削除されます。

構文

redis host:post> EXPIREAT <key name> <unix timestamp in seconds>

戻り値

1 : 有効期限が正常に設定された場合
0 : 指定したキーが存在しない場合

実行例

Unixタイムスタンプ（ミリ秒）で有効期限を設定する（PEXPIREAT）

ミリ秒精度のUnixタイムスタンプで有効期限を指定したい場合は、PEXPIREATコマンドを使用します。EXPIREATとの違いはタイムスタンプの単位のみで、EXPIREATが秒単位であるのに対し、PEXPIREATはミリ秒単位で指定する点です。

構文

redis host:post> PEXPIREAT <key name> <unix timestamp in milliseconds>

戻り値

1 : 有効期限が正常に設定された場合
0 : 指定したキーが存在しない場合

実行例

4つのコマンドの使い分けまとめ

参考ドキュメント

1. EXPIRE コマンド公式ドキュメント
2. PEXPIRE コマンド公式ドキュメント
3. EXPIREAT コマンド公式ドキュメント
4. PEXPIREAT コマンド公式ドキュメント

以上が、Redisデータストアでキーに有効期限を設定する4つのコマンドの解説でした。この記事が役に立った場合は、ぜひコメントで感想をお聞かせください。また、周囲の方へのシェアもお待ちしています。