Table Of Contents

Previous topic

ケーススタディ

Next topic

リクエスト/レスポンス プロトコルと往復遅延時間

This Page

コマンドリファレンス

すべてのコマンド名にあるリンクは各コマンドごとの紹介ページとなっています。

接続処理

コマンド パラメータ 内容
QUIT 接続を閉じる
AUTH password 有効な場合、簡単なパスワード認証が行われます

全データ型対応の操作

コマンド パラメータ 内容
EXISTS key キー key が存在するか確認します
DEL key キー key を削除します
TYPE key あるキー key で格納されている値の型を返す
KEYS pattern 与えられたパターン pattern にマッチするすべてのキーを返す
RANDOMKEY return a random key from the key space
RENAME oldname newname 古いキー oldname を新しいキー newname にリネームする。もし新しいキーがすでに存在する場合、上書きする。
RENAMENX oldname newname 古いキー oldname を新しいキー newname にリネームする。新しいキーが存在しない場合のみ有効。
DBSIZE その時点でのデータベース内におけるキーの数を返す
EXPIRE key seconds キー key の有効期限を seconds 秒に設定する
PERSIST key キー key の有効期限を破棄する
TTL key キー key の存命時間を取得する
SELECT index 与えられたインデックス index のデータベースを選択する
MOVE key dbindex あるキー key を現在のデータベースから dbindex のDBへ移す
FLUSHDB 現在選択されているデータベースのすべてのキーを削除する
FLUSHALL すべてのデータベースからすべてのキーを削除する

文字列型の操作

コマンド パラメータ 内容
SET key value 文字列 value にキー key をセットする
GET key あるキー key に対応する文字列を返す
GETSET key value あるキー key に文字列 value をセットして、そのキーに紐づいていた古い文字列を返す
MGET key1 key2 ... keyN Multi-get, 与えた複数のキー keyN に対応する文字列を返す
SETNX key value そのキー key が存在しない場合、文字列 value にキーをセットする
SETEX key time value Set+Expireの合わせ技
MSET key1 value1 key2 value2 ... keyN valueN 単一アトミック操作で複数のキー keyN と文字列 valueN のペアをセットする
MSETNX key1 value1 key2 value2 ... keyN valueN 単一アトミック操作で複数のキー keyN と文字烈 valueN のペアをセットする。ただし与えられたキーのすべてが存在しない場合のみ有効。
INCR key キー key に対応する整数値をインクリメントする
INCRBY key integer キー key に対応する整数値を integer だけインクリメントする
DECR key キー key に対応する整数値ををデクリメントする
DECRBY key integer キー key に対応する整数値を integer だけデクリメントする
APPEND key value キー key に対応する文字列に value の文字列を追加する
SUBSTR key start end キー key に対応する文字列の start から end の部分文字列を返す

リストの操作

コマンド パラメータ 内容
RPUSH key value キー key に対応するリストの末尾に要素 value を追加する
LPUSH key value キー key に対応するリストの先頭に要素 value を追加する
LLEN key キー key に対応するリストの長さを返す
LRANGE key start end キー key に対応するリストから start 番目から end 番目までの部分リストを返す
LTRIM key start end キー key に対応するリストを start 番目から end 番目の部分リストに変更する
LINDEX key index キー key に対応するリストの index 番目の要素を返す
LSET key index value キー key に対応するリストの index 番目の要素を新しい値 value に変更する
LREM key count value 最初の count 個だけ value にマッチする要素を key に対応するリストから削除する。 count が負数の場合は最後から count 個だけ削除する。
LPOP key キー key に対応するリストの先頭の要素を返してリストから削除する
RPOP key キー key に対応するリストの末尾の要素を返してリストから削除する
BLPOP key1 key2 ... keyN timeout 複数のキー keyN に対応するリストを LPOP から timeout 秒ブロックする
BRPOP key1 key2 ... keyN timeout 複数のキー keyN に対応するリストを POP から timeout 秒ブロックする
RPOPLPUSH srckey dstkey キー srckey のリストの末尾の要素を返してそのリストから削除し、キー dstkey に対応するリストの先頭にその値を追加する。

セットの操作

コマンド パラメータ 内容
SADD key member キー key に対応するセットにメンバ member を追加する
SREM key member キー key に対応するセットからメンバ member を削除する
SPOP key キー key に対応するセットからランダムに一つ選んだ要素を返し、セットから削除する
SMOVE srckey dstkey member キー srckey に対応するセットからキー dstkey に対応するセットにメンバ member を移動する
SCARD key キー key に対応するセットの要素数(濃度)を返します
SISMEMBER key member キー key に対応するセットの中にメンバ member があるか確認します
SINTER key1 key2 ... keyN 複数のキー keyN に対応する複数のセットの共通セットを返します
SINTERSTORE dstkey key1 key2 ... keyN 複数のキー keyN に対応する複数のセットの共通セットを作成し、その結果をキー dstkey に紐付ける
SUNION key1 key2 ... keyN 複数のキー keyN に対応する複数のセットの結合を返す
SUNIONSTORE dstkey key1 key2 ... keyN 複数のキー keyN に対応する複数のセットの結合を作成し、その結果をキー dstkey に紐付ける
SDIFF key1 key2 ... keyN 複数のキー keyN に対応する複数のセットの差分を返す
SDIFFSTORE dstkey key1 key2 ... keyN 複数のキー kenN に対応する複数のセットの差分を作成し、その結果をキー dstkey に紐付ける
SMEMBERS key キー key に対応するセットのすべてのメンバを返す
SRANDMEMBER key キー key に対応するセットの中からランダムに一つのメンバを選んで返す

ソート済みセットの操作

コマンド パラメータ 内容
ZADD key score member キー key に対応するソート済みセットにメンバ member を追加する。 member が存在する場合はそのスコアを score に上書きする。
ZREM key member キー key に対応するソート済みセットからメンバ member を削除する
ZINCRBY key increment member もしキー key に対応するソート済みセットにメンバ member が存在する場合はスコアを値 increment だけインクリメントする。無ければ increment のスコアを持つメンバを追加する。
ZRANK key member キー key に対応するソート済みセット内にメンバ member が存在する場合はその順位(インデックス)を、存在しない場合は member を返す。メンバはスコアの昇順に並べるものとする。
ZREVRANK key member キー key に対応するソート済みセット内のメンバ member の順位(インデックス)を返す。メンバはスコアの降順に並べるものとする。
ZRANGE key start end キー key に対応するセットをメンバのスコアの昇順でソートした場合の、 start 番目から end 番目のメンバで作られたソート済みセットを返す。
ZREVRANGE key start end キー key に対応するセットをメンバのスコアの降順でソートした場合の、 start 番目から end 番目のメンバで作られたソート済みセットを返す。
ZRANGEBYSCORE key min max キー key に対応するソート済みセットの中からスコアが min 以上 max 以下の要素で作られたソート済みセットを返す
ZCOUNT key min max キー key に対応するソート済みセットの中でスコアが min 以上 max 以下の要素の数を返す
ZCARD key キー key に対応するソート済みセットのメンバ数(濃度)を返す
ZSCORE key element キー key に対応するソート済みセットの特定の要素のスコアを返す
ZREMRANGEBYRANK key min max キー key に対応するソート済みセットから min 以上 max 以下の順位のメンバをすべて削除する
ZREMRANGEBYSCORE key min max キー key に対応するソート済みセットから min 以上 max 以下のスコアを持つメンバをすべて削除する
ZUNIONSTORE / ZINTERSTORE dstkey N key1 ... keyN WEIGHTS w1 ... wN AGGREGATE SUM|MIN|MAX 複数のキー keyN に対応する複数のソート済みセットの結合または共通セットを、重みとアグリゲーションに関するオプションを元に作成し、結果をキー dstkey に紐付ける

ハッシュの操作

コマンド パラメータ 内容
HSET key field value キー key に対応するハッシュ表にフィールド field に値 value のセットする。必要であれば作成する。
HGET key field キー key に対応するハッシュ表でフィールド field に紐づいている値を取得する
HMGET key field1 ... fieldN キー key に対応するハッシュ表から複数のフィールド fieldN に紐づいている複数のハッシュ値を取得する
HMSET key field1 value1 ... fieldN valueN キー key に対応するハッシュ表に複数のフィールド fieldN と値 valueN のペアをセットする
HINCRBY key field integer キー key に対応するハッシュ表のフィールド field に対応する値を integer だけインクリメントする
HEXISTS key field キー key に対応するハッシュ表にフィールド field が存在するか確認する
HDEL key field キー key に対応するハッシュ表からフィールド field を削除する
HLEN key キー key に対応するハッシュ表の要素数を返す
HKEYS key キー key に対応するハッシュ表のすべてのフィールドを返す
HVALS key キー key に対応するハッシュ表のすべての値を返す
HGETALL key キー key に対応するハッシュ表のすべてのフィールドと値のペアを返す

ソート

コマンド パラメータ 内容
SORT key BY pattern LIMIT start end GET pattern ASC|DESC ALPHA セットまたはリストを与えられたパラメータに基づきソートする

トランザクション

コマンド パラメータ 内容
MULTI / EXEC / DISCARD / WATCH / UNWATCH Redisアトミックトランザクション

パブリッシュ/サブスクライブ

コマンド パラメータ 内容
SUBSCRIBE / UNSUBSCRIBE / PUBLISH Redisパブリッシュ/サブスクライブ メッセージング・パラダイムの実装

永続化処理コマンド

コマンド パラメータ 内容
SAVE 同期的にデータベースをディスクに保存する
BGSAVE 非同期的にデータベースをディスクに保存する
LASTSAVE 最後にデータベースをディスク上に保存したUNIX時間を返す
SHUTDOWN 同期的にデータベースをディスク上に保存し、サーバを落とす
BGREWRITEAOF 追記専用ファイルが大きくなりすぎたときはバックグラウンドで再書き込みする

リモートサーバ制御コマンド

コマンド パラメータ 内容
INFO サーバ情報やサーバの統計情報を提供する
MONITOR 受信したリクエストをリアルタイムですべてダンプする
SLAVEOF レプリケーションの設定を変更する
CONFIG 起動中にRedisサーバの設定を行う