Tair (Redis® OSS-Compatible):Roaring

タイプ

コマンド

構文

説明

バージョン変更

書き込み操作

TR.SETBIT

TR.SETBIT key offset value

TairRoaring キーの指定されたビットを 1 または 0 の値に設定し、元のビット値を返します。オフセットは 0 から始まります。

- (N/A)

TR.SETBITS

TR.SETBITS key offset [offset1 offset2 ... offsetN]

TairRoaring キーの指定されたビットの値を 1 に設定します。複数のビット値を指定できます。

V2 で追加

TR.CLEARBITS

TR.CLEARBITS key offset [offset1 offset2 ... offsetN]

TairRoaring キーの指定されたビットの値を 0 に設定します。指定されたビットの値がすでに 0 の場合、操作は実行されません。複数のビット値を指定できます。

V2 で追加

TR.SETRANGE

TR.SETRANGE key start end

TairRoaring キーの指定された範囲内のビットを 1 の値に設定します。範囲は閉区間です。

V2 で更新。V2 でのコマンド更新後、コマンドの出力は 1 に設定されたビット数に変更されます。

TR.APPENDBITARRAY

TR.APPENDBITARRAY key offset bitarray

Roaring Bitmap の指定されたビットの後の位置にビット配列を挿入し、元のデータを上書きします。ビット配列は 0 と 1 で構成されます。

V2 で追加

TR.FLIPRANGE

TR.FLIPRANGE key start end

TairRoaring キーの指定された範囲内のビットの値を 0 から 1 に、または 1 から 0 に切り替えます。範囲は閉区間です。キーが存在しない場合、キーは空のデータセットとして作成され、そのキーに対して操作が実行されます。

V2 で追加

TR.APPENDINTARRAY

TR.APPENDINTARRAY key value [value1 value2 ... valueN]

-

TR.SETINTARRAY

TR.SETINTARRAY key value [value1 value2 ... valueN]

-

TR.SETBITARRAY

TR.SETBITARRAY key value

-

TR.BITOP

TR.BITOP destkey operation key [key1 key2 ... keyN]

-

TR.BITOPCARD

TR.BITOPCARD operation key [key1 key2 ... keyN]

V2 で追加

TR.OPTIMIZE

TR.OPTIMIZE key

TairRoaring キーのストレージを最適化します。キーが比較的に大きく、キーの作成後に主に読み取り操作に使用される場合は、このコマンドを実行できます。

-

読み取り操作

TR.GETBIT

TR.GETBIT key offset

TairRoaring キーから指定されたビットの値を取得します。

-

TR.GETBITS

TR.GETBITS key offset [offset1 offset2 ... offsetN]

TairRoaring キーから指定されたビットの値を取得します。値の取得には複数のビットを指定できます。

V2 で追加

TR.BITCOUNT

TR.BITCOUNT key [start end]

TairRoaring キーの指定された範囲内で値が 1 のビット数をカウントします。範囲は閉区間です。

V2 で更新され、上位互換性があります。

TR.BITPOS

TR.BITPOS <key> <value> [count]

序数が count のビットのオフセットを取得します。ビットの値は 1 または 0 です。count パラメーターはオプションで、デフォルト値は 1 です。値 1 は、左から右へのカウント方法を使用して取得された最初のビットを示します。

V2 で更新され、上位互換性があります。

TR.SCAN

TR.SCAN key start_offset [COUNT count]

V2 で追加

TR.RANGE

TR.RANGE key start end

TairRoaring キーの指定された範囲内で値が 1 のビットのオフセットを返します。範囲は閉区間です。

V1 の TR.RANGEINTARRAY から V2 で TR.RANGE に名前が変更されました。

TR.RANGEBITARRAY

TR.RANGEBITARRAY key start end

TairRoaring キーの指定された範囲内で 0 と 1 のビット値で構成される文字列を取得します。範囲は閉区間です。

V2 で追加

TR.MIN

TR.MIN key

TairRoaring キーで値が 1 の最初のビットのオフセットを取得します。値が 1 のビットがない場合、-1 の値が返されます。

-

TR.MAX

TR.MAX key

Roaring Bitmap で値が 1 の最後のビットのオフセットを取得します。値が 1 のビットがない場合、-1 が返されます。

-

TR.STAT

TR.STAT key [JSON]

指定された TairRoaring キーの統計情報を返します。情報には、コンテナーの数とメモリ使用量が含まれます。

V2 で追加

TR.JACCARD

TR.JACCARD key1 key2

V2.2 で追加

TR.CONTAINS

TR.CONTAINS key1 key2

V2.2 で追加

TR.RANK

TR.RANK key offset

最初のビットから指定されたビットまでの範囲内で値が 1 のビット数を取得します。範囲は閉区間です。

V2.2 で追加

汎用操作

DEL

DEL key [key ...]

1 つ以上の TairRoaring キーを削除します。

-

カテゴリ

説明

構文

TR.SETBIT key offset value

時間計算量

O(1)

コマンドの説明

TairRoaring キーの指定されたビットを 1 または 0 の値に設定し、元のビット値を返します。オフセットは 0 から始まります。

パラメーター

• Key: キー名 (TairRoaring データ構造)。

• offset: 設定するビットのオフセットを表す整数で、値の範囲は 0 ~ 2^32 です。

• value: 設定するビット値で、1 または 0 のいずれかです。

出力

• 操作が成功した場合、0 または 1 のビット値が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.SETBIT foo 0 1

出力例:

(integer) 0

項目

説明

構文

TR.SETBITS key offset [offset1 offset2 ... offsetN]

時間計算量

O(C)

コマンドの説明

TairRoaring キーの指定されたビットの値を 1 に設定します。複数のビット値を指定できます。

オプション

• Key: キー名 (TairRoaring データ構造)。

• offset: 設定するビットのオフセットを表す整数で、値の範囲は 0 ~ 2^32 です。

出力

• 操作が成功した場合、キー内で 1 に設定されているビット数が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.SETBITS foo 9 10

出力例:

(integer) 5

項目

説明

構文

TR.CLEARBITS key offset [offset1 offset2 ... offsetN]

時間計算量

O(C)

コマンドの説明

TairRoaring キーの指定されたビットの値を 0 に設定します。指定されたビットの値がすでに 0 の場合、操作は実行されません。複数のビット値を指定できます。

パラメーター

• Key: キー名 (TairRoaring データ構造)。

• offset: 設定するビットのオフセットを表す整数で、値の範囲は 0 ~ 2^32 です。

出力

• 操作が成功した場合、キー内で 0 に設定されたビット数が返されます。

• キーが存在しない場合、値 0 が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.CLEARBITS foo 9 10

出力例:

(integer) 2

項目

説明

構文

TR.SETRANGE key start end

時間計算量

O(C)

コマンドの説明

TairRoaring キーの指定された範囲内のビットを 1 の値に設定します。範囲は閉区間です。

たとえば、TR.SETRANGE foo 1 3 コマンドを実行すると、システムは 0111 foo キーを作成します。

オプション

• Key: キー名 (TairRoaring データ構造)。

• start: 間隔の開始値。有効な値: 0 から 2^32。

• end: 間隔の終了値。有効な値: 0 から 2^32。

出力

• 操作が成功した場合、キー内で 1 に設定されているビット数が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.SETRANGE foo 1 3

出力例:

(integer) 3

項目

説明

構文

TR.APPENDBITARRAY key offset bitarray

時間計算量

O(C)

コマンドの説明

Roaring Bitmap の指定されたビットの後の位置にビット配列を挿入し、元のデータを上書きします。ビット配列は 0 と 1 で構成されます。

パラメーター

• Key: キー名 (TairRoaring データ構造)。

• offset: 指定された開始オフセット (この値は含まない)。値の範囲は -1 ~ 2^32 です。

• bitarray: 追加するビット配列。既存のデータを上書きします。連続する 0 または 1 で構成され、値の範囲は 0 ~ 2^32 です。

  説明

  指定されたオフセットと追加されたビット配列の合計長は 2^32 を超えることはできません。超えた場合、操作は失敗します。

出力

• 操作が成功した場合、キー内で 1 に設定されているビット数が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

事前に TR.SETBITS foo 0 コマンドを実行します。

コマンド例:

TR.APPENDBITARRAY foo 1 1101

出力例:

(integer) 4

この場合、TairRoaring foo キーは "101101" です。

項目

説明

構文

TR.FLIPRANGE key start end

時間計算量

O(C)

コマンドの説明

TairRoaring キーの指定された範囲内のビットの値を 0 から 1 に、または 1 から 0 に切り替えます。範囲は閉区間です。キーが存在しない場合、キーは空のデータセットとして作成され、そのキーに対して操作が実行されます。

パラメーター

• Key: キー名 (TairRoaring データ構造)。

• start: 開始オフセット (含む)。値の範囲は 0 から 2^32 です。

• end: 終了オフセット (含む)。値の範囲は 0 から 2^32 です。

出力

• 操作が成功した場合、キー内で 1 に設定されたビット数が返されます。

• キーが存在しない場合、キーは空のデータセットとして作成され、そのキーに対して操作が実行されます。操作が成功した場合、キー内で 1 に設定されたビット数が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

事前に TR.SETBITS foo 0 2 3 5 コマンドを実行します。

コマンド例:

TR.FLIPRANGE foo 0 5

出力例:

(integer) 2

この場合、TairRoaring foo キーは "01001" です。

項目

説明

構文

TR.APPENDINTARRAY key value [value1 value2 ... valueN]

時間計算量

O(C)

コマンドの説明

パラメーター

• Key: キー名 (TairRoaring データ構造)。

• value: 処理したいビットの整数オフセット。有効な値: 0 から 4294967296。

出力

• 操作が成功した場合、OK が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.APPENDINTARRAY foo 9 10

出力例:

OK

項目

説明

構文

TR.SETINTARRAY key value [value1 value2 ... valueN]

時間計算量

O(C)

コマンドの説明

パラメーター

• Key: キー名 (TairRoaring データ構造)。

• value: 設定するビット位置を指定する整数。

出力

• 操作が成功した場合、OK が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.SETINTARRAY foo 2 4 5 6

出力例:

OK

項目

説明

構文

TR.SETBITARRAY key value

時間計算量

O(C)

コマンドの説明

パラメーター

• key: このコマンドを実行して管理するキー。

• value: ビット配列を表す 0 と 1 の文字列。

出力

• 操作が成功した場合: OK が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

tr.setbitarray foo 10101001

出力例:

OK 

項目

説明

構文

TR.BITOP destkey operation key [key1 key2 ... keyN]

時間計算量

O(C * M)

コマンドの説明

オプション

• destkey: 結果を保存する宛先キー (TairRoaring データ構造)。

• operation: セット操作のタイプ。有効な値: AND (論理積)、OR (論理和)、XOR (排他的論理和)、NOT (論理否定)、および DIFF (差分)。

  説明

  • NOT 操作は単一のキーに対してのみ実行できます。

  • DIFF 操作は 2 つのキーに対してのみ実行できます。キーの順序に注意してください。たとえば、TR.BITOP result DIFF key1 key2 コマンドは key1 から key2 を減算します (key1 - key2)。

• key: TairRoaring データ構造のキー。複数のキーを指定できます。

出力

• 操作が成功した場合、結果内で 1 に設定されているビットの整数値が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.BITOP result OR foo bar

出力例:

(integer) 6

項目

説明

構文

TR.BITOPCARD operation key [key1 key2 ... keyN]

時間計算量

O(C * M)

コマンドの説明

options

• operation: セット操作のタイプ。有効な値: AND、OR、XOR、NOT、および DIFF。

  説明

  • NOT 操作は単一のキーに対してのみ実行できます。

  • DIFF 操作は 2 つのキーの差のみを計算できます。差を計算するための操作の順序に注意してください。たとえば、TR.BITOP result DIFF key1 key2 コマンドは、key2 に対する key1 の差 (key1 - key2) を計算します。

• key: キー名 (TairRoaring データ構造)。複数のキーを指定できます。

出力

• 操作が成功した場合、結果内で 1 に設定されているビットの整数値が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.BITOPCARD NOT foo

出力例:

(integer) 2

項目

説明

構文

TR.OPTIMIZE key

時間計算量

O(M)

コマンドの説明

TairRoaring キーのストレージを最適化します。キーが比較的に大きく、キーの作成後に主に読み取り操作に使用される場合は、このコマンドを実行できます。

オプション

• Key: キー名 (TairRoaring データ構造)。

出力

• 操作が成功した場合、OK が返されます。

• キーが存在しない場合、nil が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.OPTIMIZE foo

出力例:

OK

項目

説明

構文

TR.GETBIT key offset

時間計算量

O(1)

コマンドの説明

TairRoaring キーから指定されたビットの値を取得します。

オプション

• Key: キー名 (TairRoaring データ構造)。

• offset: クエリするオフセット。

出力

• 操作が成功した場合、0 または 1 の値が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.GETBIT foo 0

出力例:

(integer) 1

項目

説明

構文

TR.GETBITS key offset [offset1 offset2 ... offsetN]

時間計算量

O(C)

コマンドの説明

TairRoaring キーから指定されたビットの値を取得します。値の取得には複数のビットを指定できます。

パラメーター

• Key: キー名 (TairRoaring データ構造)。

• offset: クエリするオフセット。

出力

• 操作が成功した場合、ビット値が返されます。

• キーが存在しない場合、空の配列が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.GETBITS foo 3 4 6 8

出力例:

1) (integer) 1
2) (integer) 1
3) (integer) 1
4) (integer) 0

項目

説明

構文

TR.BITCOUNT key [start end]

時間計算量

O(M)

コマンドの説明

TairRoaring キーの指定された範囲内で値が 1 のビット数をカウントします。範囲は閉区間です。

パラメーター

• Key: キー名 (TairRoaring データ構造)。

• start: 開始オフセット (含む)。値の範囲は 0 から 2^32 です。

• end: 終了オフセット (含む)。値の範囲は 0 から 2^32 です。

出力

• 操作が成功した場合、キー内で 1 に設定されているビットの整数値が返されます。

• キーが存在しない場合、値 0 が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.BITCOUNT foo 4 9

出力例:

(integer) 3

項目

説明

構文

TR.BITPOS <key> <value> [count]

時間計算量

O(C)

コマンドの説明

序数が count のビットのオフセットを取得します。ビットの値は 1 または 0 です。count パラメーターはオプションで、デフォルト値は 1 です。値 1 は、左から右へのカウント方法を使用して取得された最初のビットを示します。

パラメーター

• Key: キー名 (TairRoaring データ構造)。

• value: オフセットを取得したいビットの値。ビット値は 0 または 1 です。

• count: ビットの序数。負の数は、右から左へのカウント方法が使用されることを示します。

出力

• 操作が成功した場合、値が 1 または 0 のビットのオフセットが返されます。

• キーが存在しない場合、値 -1 が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.BITPOS foo 1 -1

出力例:

(integer) 6

項目

説明

構文

TR.SCAN key start_offset [COUNT count]

時間計算量

O(C)

コマンドの説明

パラメーター

• Key: キー名 (TairRoaring データ構造)。

• start_offset: ビットのオフセット。このオフセットに一致するビットがスキャンされます。

• COUNT: クエリするビット数。デフォルト値: 10。

出力

• 操作が成功した場合、2 つの要素を含む配列が返されます:

  • 最初の要素は、次の start_offset 値です。キーがスキャンされた場合、値 0 が返されます。

  • 2 番目の要素: 現在のクエリのターゲットオフセット。

  説明

  キーが存在しない場合、0 と空の要素で構成される配列が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.SCAN foo 0 COUNT 2

出力例:

1) (integer) 3
2) 1) (integer) 0
   2) (integer) 2

カテゴリ

説明

構文

TR.RANGE key start end

時間計算量

O(C)

コマンドの説明

TairRoaring キーの指定された範囲内で値が 1 のビットのオフセットを返します。範囲は閉区間です。

パラメーター

• Key: キー名 (TairRoaring データ構造)。

• start: 間隔の開始値 (含む)。

• end: 間隔の終了値 (含む)。

出力

• 操作が成功した場合、値が 1 のビットのオフセットが返されます。

• キーが存在しない場合、空の配列が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

事前に TR.SETBITS foo 0 2 3 5 コマンドを実行します。

コマンド例:

TR.RANGE foo 0 5

出力例:

1) (integer) 0
2) (integer) 2
3) (integer) 3
4) (integer) 5

項目

説明

構文

TR.RANGEBITARRAY key start end

時間計算量

O(C)

コマンドの説明

TairRoaring キーの指定された範囲内で 0 と 1 のビット値で構成される文字列を取得します。範囲は閉区間です。

パラメーター

• Key: キー名 (TairRoaring データ構造)。

• start: 間隔の開始値 (含む)。

• end: 間隔の終了値 (含む)。

出力

• 操作が成功した場合、値が 1 のビットのオフセットが返されます。

• キーが存在しない場合、nil が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

事前に TR.SETBITS foo 0 2 3 5 コマンドを実行します。

コマンド例:

TR.RANGEBITARRAY foo 0 5

出力例:

"101101"

項目

説明

構文

TR.MIN key

時間計算量

O(1)

コマンドの説明

TairRoaring キーで値が 1 の最初のビットのオフセットを取得します。値が 1 のビットがない場合、-1 の値が返されます。

パラメーター

• Key: キー名 (TairRoaring データ構造)。

出力

• 操作が成功した場合:

  • キーに値が 1 のビットが存在する場合、値が 1 の最初のビットの整数オフセットが返されます。

  • キーに値が 1 のビットが存在しない場合、またはキーが存在しない場合、-1 の値が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.MIN foo

出力例:

4

項目

説明

構文

TR.MAX key

時間計算量

O(1)

コマンドの説明

Roaring Bitmap で値が 1 の最後のビットのオフセットを取得します。値が 1 のビットがない場合、-1 が返されます。

オプション

• Key: キー名 (TairRoaring データ構造)。

出力

• 操作が成功した場合:

  • キーに値が 1 のビットが存在する場合、値が 1 の最後のビットの整数オフセットが返されます。

  • キーに値が 1 のビットが存在しない場合、またはキーが存在しない場合、-1 の値が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.MAX foo

出力例:

6

項目

説明

構文

TR.STAT key [JSON]

時間計算量

O(M)

コマンドの説明

指定された TairRoaring キーの統計情報を返します。情報には、コンテナーの数とメモリ使用量が含まれます。

パラメーター

• Key: キー名 (TairRoaring データ構造)。

• JSON: このパラメーターが指定されている場合、統計情報は JSON 形式で返されます。

出力

• 操作が成功した場合、次の出力が返されます:

  "{\"cardinality\":3,                    # キー内の要素の総数
  \"number_of_containers\":1,             # キー内のコンテナーの総数
  \"max_value\":6,                        # キー内の最大要素値
  \"min_value\":3,                        # キー内の最小要素値
  \"sum_value\":13,
  \"array_container\":{                   # キー内の配列コンテナーの数
      \"number_of_containers\":1,
      \"container_cardinality\":3,
      \"container_allocated_bytes\":6},
  \"bitset_container\":{                  # キー内のビットセットコンテナーの数
      \"number_of_containers\":0,
      \"container_cardinality\":0,
      \"container_allocated_bytes\":0},
  \"run_container\":{                     # キー内のランコンテナーの数
      \"number_of_containers\":0,
      \"container_cardinality\":0,
      \"container_allocated_bytes\":0}}"
  
                                          

• キーが存在しない場合、nil が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.STAT foo JSON

出力例:

"{\"cardinality\":4,\"number_of_containers\":1,\"max_value\":5,\"min_value\":0,\"sum_value\":10,\"array_container\":{\"number_of_containers\":1,\"container_cardinality\":4,\"container_allocated_bytes\":8},\"bitset_container\":{\"number_of_containers\":0,\"container_cardinality\":0,\"container_allocated_bytes\":0},\"run_container\":{\"number_of_containers\":0,\"container_cardinality\":0,\"container_allocated_bytes\":0}}"

項目

説明

構文

TR.JACCARD key1 key2

時間計算量

O(M)

コマンドの説明

パラメーター

• Key: キー名 (TairRoaring データ構造)。

出力

• 操作が成功した場合、double 型のジャカード類似係数が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

コマンド例:

TR.JACCARD foo1 foo2

出力例:

"0.20000000000000001"

カテゴリ

説明

構文

TR.CONTAINS key1 key2

時間計算量

O(M)

コマンドの説明

options

• Key: キー名 (TairRoaring データ構造)。

出力

• 操作が成功した場合:

  • key2 に key1 が含まれている場合、値 1 が返されます。

  • key2 に key1 が含まれていない場合、値 0 が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

事前に TR.SETBITS fooM 1 2 3 10 および TR.SETBITS foom 1 2 コマンドを実行します。

コマンド例:

TR.CONTAINS foom fooM

出力例:

(integer) 1

項目

説明

構文

TR.RANK key offset

時間計算量

O(M)

コマンドの説明

最初のビットから指定されたビットまでの範囲内で値が 1 のビット数を取得します。範囲は閉区間です。

オプション

• Key: キー名 (TairRoaring データ構造)。

• offset: 指定されたビットのオフセット。値は整数である必要があります。

出力

• 操作が成功した場合、値が 1 のビット数が返されます。

• それ以外の場合は、エラーメッセージが返されます。

例

事前に TR.SETBITS fooM 1 2 3 10 コマンドを実行します。

コマンド例:

TR.RANK fooM 10

出力例:

(integer) 4

エラーメッセージ

説明

WRONGTYPE Operation against a key holding the wrong kind of value

不正なオブジェクトタイプ: キーは TairRoaring オブジェクトではありません。

ERR bad arguments, must be unsigned 32-bit integer

不正なパラメータータイプ: パラメーター値を 32 ビット整数に変換できません。

ERR invalid arguments, maybe out of range or illegal

無効なパラメーター:

• オフセットが 32 ビット整数ではありません。

• 開始オフセットと終了オフセットが無効です。

• パラメーター値が TairRoaring キーで許可されている最大要素数を超えています。

ERR key already exist

TairRoaring キーはすでに存在しており、そのデータを上書きすることはできません。

ERR key not found

Roaring Bitmap オブジェクトが存在しません。この操作はサポートされていません。