Redis ZADDコマンドの使い方 – ソート済みセットへの要素の作成と追加

このチュートリアルでは、RedisのZADDコマンドを使って、キーに保存されたソート済みセット(sorted set)の値に要素を作成・追加する方法を解説します。

ZADDコマンドは、指定したキーに格納されたソート済みセットに対して、それぞれのスコアを持つ要素を1つ以上追加するために使用します。すでに同じ要素が存在する場合は、そのスコアが更新され、正しい順序を保てるように適切な位置へ再挿入されます。スコアには倍精度浮動小数点数(double)の文字列表現を指定し、+inf(正の無限大)や-inf(負の無限大)も有効な値として利用できます。

キーがデータストアに存在しない場合は、挿入操作を行う前に新しいソート済みセットが自動的に作成されます。一方、キーは存在するものの、その値がソート済みセット型ではない場合にはエラーが返されます。

ZADDコマンドのオプション引数

RedisのZADDコマンドでは、以下のオプション引数を指定できます。

1. XX: すでにソート済みセットに存在する要素のみを更新し、新しい要素は一切追加しません。
2. NX: 新しい要素のみを追加し、既存の要素は決して更新しません。
3. CH: 戻り値を「新規に追加された要素数」から「変更された要素の総数」に変更します。ここでの「変更された要素」には、新しく追加された要素と、スコアが更新された既存要素が含まれます。コマンドラインで指定された要素のうち、過去と同じスコアだった要素はカウントされません。
4. INCR: このオプションを指定すると、ZADDはZINCRBYコマンドと同じように動作します。このモードでは、スコアと要素のペアは1組しか指定できません。また、キーがすでに存在する場合にのみ値が設定されます。

ソート済みセット内の要素は、スコアの昇順で並べられます。スコアが同一の要素同士については、辞書順(lexicographical order)で整列されます。Redis ZADDコマンドの構文は以下の通りです。

構文

redis host:post> ZADD <key> [XX|NX] [CH] [INCR] <score> <member> [<score> <member>]

出力

- 整数値: ソート済みセットに追加された要素の数
  (すでに存在していた要素は含まれません)
- エラー: キーが存在するが、その値がソート済みセット型でない場合

使用例

参考資料

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

以上が、Redisのデータストア内にあるソート済みセットに要素を作成・追加する方法の解説でした。この記事がお役に立てたなら、ぜひコメント欄でご意見をお聞かせください。また、他の方にもシェアしていただければ幸いです。