ApsaraDB for Redis:TairRoaring

Sets the specified bit in a TairRoaring key to a value of 1 or 0 and returns the original bit value. The offset starts from 0.

Sets the value of the specified bit in a TairRoaring key to 1. You can set multiple bits to a value of 1.

Sets the value of the specified bit in a TairRoaring key to 0. If the specified bit already has a value of 0, the operation is not performed. You can set multiple bits to a value of 0.

Sets the bits within the specified range in a TairRoaring key to a value of 1. The range is a closed interval.

Inserts a bit array into a position right behind the specified bit in a TairRoaring key and overwrites the original data. The bit array consists of 0 and 1.

Changes the values for bits within the specified range in a TairRoaring key from 0 to 1 or from 1 to 0. The range is a closed interval. If the key does not exist, the key is created as an empty data set and the operation is performed on the key.

Optimizes the storage of a TairRoaring key. If the key is relatively large and is used mainly for read operations after the key is created, you can run this command.

Retrieves the value of the specified bit from a TairRoaring key.

Retrieves the value of the specified bit from a TairRoaring key. You can specify multiple bit values.

Counts the number of bits that have a value of 1 within the specified range in a TairRoaring key. The range is a closed interval.

Retrieves the offset of the bit that has an ordinal number of count. A bit can have a value of 1 or 0. The count parameter is optional and has a default value of 1. A value of 1 indicates the first bit retrieved by using the left-right counting approach.

Retrieves the offsets of the bits that have a value of 1 within the specified range in a TairRoaring key. The range is a closed interval.

Retrieves a string that consists of bit values of 0 and 1 within the specified range in a TairRoaring key. The range is a closed interval.

Retrieves the offset of the first bit that has a value of 1 in a TairRoaring key. If no bits have a value of 1, a value of -1 is returned.

Retrieves the offset of the last bit that has a value of 1 in a TairRoaring key. If no bits have a value of 1, -1 is returned.

Returns the statistical information of the specified TairRoaring key. The information includes the number of containers and the memory usage.

Retrieves the number of bits that have a value of 1 within the range from the first bit to the specified bit. The range is a closed interval.

Sets the specified bit in a TairRoaring key to a value of 1 or 0 and returns the original bit value. The offset starts from 0.

• Key: the key that you want to manage by running this command.
• offset: the integer offset of the bit that you want to process. Valid values: 0 to 2^32.
• value: the value that you want to set for the bit. The value can be set to 1 or 0.

• If the operation is successful, a bit value of 0 or 1 is returned.
• Otherwise, an error message is returned.

Sample command:

TR.SETBIT foo 0 1

Sample output:

(integer) 0

Sets the value of the specified bit in a TairRoaring key to 1. You can set multiple bits to a value of 1.

• Key: the key that you want to manage by running this command.
• offset: the integer offset of the bit that you want to process. Valid values: 0 to 2^32.

• If the operation is successful, the number of bits in the key that have a value of 1 is returned.
• Otherwise, an error message is returned.

Sample command:

TR.SETBITS foo 9 10

Sample output:

(integer) 5

Sets the value of the specified bit in a TairRoaring key to 0. If the specified bit already has a value of 0, the operation is not performed. You can set multiple bits to a value of 0.

• Key: the key that you want to manage by running this command.
• offset: the integer offset of the bit that you want to process. Valid values: 0 to 2^32.

• If the operation is successful, the number of bits in the key that have been set to 0 is returned.
• If the key does not exist, a value of 0 is returned.
• Otherwise, an error message is returned.

Sample command:

TR.CLEARBITS foo 9 10

Sample output:

(integer) 2

Sets the bits within the specified range in a TairRoaring key to a value of 1. The range is a closed interval.

For example, if you run the TR.SETRANGE foo 1 3 command, the system creates the 0111 foo key.

• Key: the key that you want to manage by running this command.
• start: the start value of the interval. Valid values: 0 to 2 ^ 32.
• end: the end value of the interval. Valid values: 0 to 2 ^ 32.

• If the operation is successful, the number of bits in the key that have been set to 1 is returned.
• Otherwise, an error message is returned.

Sample command:

TR.SETRANGE foo 1 3

Sample output:

(integer) 3

Inserts a bit array into a position right behind the specified bit in a TairRoaring key and overwrites the original data. The bit array consists of 0 and 1.

• Key: the key that you want to manage by running this command.
• offset: the offset of the specified bit. Valid values: -1 to 2 ^ 32.
• bitarray: the bit array that you want to insert. The bit array consists of 0 and 1 and overwrites the original data. Valid values: 0 to 2 ^ 32.
  Note The offset and bit array that you specify cannot have a combined length longer than 2 ^ 32. Otherwise, the operation cannot be performed.

• If the operation is successful, the number of bits in the key that have been set to 1 is returned.
• Otherwise, an error message is returned.

The TR.SETBITS foo 0 command is run in advance.

Sample command:

TR.APPENDBITARRAY foo 1 1101

Sample output:

(integer) 4

In this case, the TairRoaring foo key is 101101.

Changes the values for bits within the specified range in a TairRoaring key from 0 to 1 or from 1 to 0. The range is a closed interval. If the key does not exist, the key is created as an empty data set and the operation is performed on the key.

• Key: the key that you want to manage by running this command.
• start: the start value of the interval. Valid values: 0 to 2 ^ 32.
• end: the end value of the interval. Valid values: 0 to 2 ^ 32.

• If the operation is successful, the number of bits in the key that have been set to 1 is returned.
• If the key does not exist, the key is created as an empty data set and the operation is performed on the key. If the operation is successful, the number of bits in the key that have been set to 1 is returned.
• Otherwise, an error message is returned.

The TR.SETBITS foo 0 2 3 5 command is run in advance.

Sample command:

TR.FLIPRANGE foo 0 5

Sample output:

(integer) 2

In this case, the TairRoaring foo key is 01001.

• Key: the key that you want to manage by running this command.
• value: the integer offset of the bit that you want to process. Valid values: 0 to 4294967296.

• If the operation is successful, OK is returned.
• Otherwise, an error message is returned.

Sample command:

TR.APPENDINTARRAY foo 9 10

Sample output:

OK

• Key: the key that you want to manage by running this command.
• value: the integer offset of the bit that you want to process.

• If the operation is successful, OK is returned.
• Otherwise, an error message is returned.

Sample command:

TR.SETINTARRAY foo 2 4 5 6

Sample output:

OK

• key: the key that you want to manage by running this command.
• value: the bit array string that consists of 0 and 1.

• If the operation is successful, OK is returned.
• Otherwise, an error message is returned.

Sample command:

tr.setbitarray foo 10101001

Sample output:

OK 

• key: the key that you want to manage by running this command. Multiple keys can be specified.
• operation: the type of the bitwise operation. Valid values: AND, OR, XOR, NOT, and DIFF.
  Note

  • NOT operations can be performed only on a single key.
  • DIFF operations calculate the difference only between two keys. Take note of the order of operations for calculating the difference. For example, the TR.BITOP result DIFF key1 key2 command subtracts the key2 value from the key1 value.
• destkey: the destination key that stores the result.

• If the operation is successful, the integer number of bits in the result that have a value of 1 is returned.
• Otherwise, an error message is returned.

Sample command:

TR.BITOP result OR foo bar

Sample output:

(integer) 6

• key: the key that you want to manage by running this command. Multiple keys can be specified.
• operation: the type of the bitwise operation. Valid values: AND, OR, XOR, NOT, and DIFF.
  Note

  • NOT operations can be performed only on a single key.
  • DIFF operations calculate the difference between two keys only. Take note of the order of operations for calculating the difference. For example, the TR.BITOP result DIFF key1 key2 command subtracts the key2 value from the key1 value.

• If the operation is successful, the integer number of bits in the result that have a value of 1 is returned.
• Otherwise, an error message is returned.

Sample command:

TR.BITOPCARD NOT foo

Sample output:

(integer) 2

Optimizes the storage of a TairRoaring key. If the key is relatively large and is used mainly for read operations after the key is created, you can run this command.

• Key: the key that you want to manage by running this command.

• If the operation is successful, the number of bits in the key that have a value of 1 is returned.
• If the key does not exist, nil is returned.
• Otherwise, an error message is returned.

Sample command:

TR.OPTIMIZE foo

Sample output:

OK

Retrieves the value of the specified bit from a TairRoaring key.

• Key: the key that you want to manage by running this command.
• offset: the offset of the bit whose value you want to retrieve.

• If the operation is successful, a value of 0 or 1 is returned.
• Otherwise, an error message is returned.

Sample command:

TR.GETBIT foo 0

Sample output:

(integer) 1

Retrieves the value of the specified bit from a TairRoaring key. You can specify multiple bit values.

• Key: the key that you want to manage by running this command.
• offset: the offset of the bit whose value you want to retrieve.

• If the operation is successful, the bit value is returned.
• If the key does not exist, an empty array is returned.
• Otherwise, an error message is returned.

Sample command:

TR.GETBITS foo 3 4 6 8

Sample output:

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

Counts the number of bits that have a value of 1 within the specified range in a TairRoaring key. The range is a closed interval.

• Key: the key that you want to manage by running this command.
• start: the start value of the interval. Valid values: 0 to 2 ^ 32.
• end: the end value of the interval. Valid values: 0 to 2 ^ 32.

• If the operation is successful, the integer number of bits that have a value of 1 within the specified range in the key is returned.
• If the key does not exist, a value of 0 is returned.
• Otherwise, an error message is returned.

Sample command:

TR.BITCOUNT foo 4 9

Sample output:

(integer) 3

Retrieves the offset of the bit that has an ordinal number of count. A bit can have a value of 1 or 0. The count parameter is optional and has a default value of 1. A value of 1 indicates the first bit retrieved by using the left-right counting approach.

• Key: the key that you want to manage by running this command.
• value: the value of the bit that you want to retrieve. The bit value can be 0 or 1.
• count: the ordinal number of the bit. A negative number indicates that the right-left counting approach is used.

• If the operation is successful, the offset of the bit that has a value of 1 or 0 is returned.
• If the key does not exist, a value of -1 is returned.
• Otherwise, an error message is returned.

Sample command:

TR.BITPOS foo 1 -1

Sample output:

(integer) 6

• Key: the key that you want to manage by running this command.
• start_offset: the offset of the bit. The bit that matches this offset is scanned.
• COUNT: the number of bits that you want to query. Default value: 10.

• If the operation is successful, an array that contains two elements is returned:
  • The first element is the next start_offset value. If the key is scanned, a value of 0 is returned.
  • The second element is the next offset that you specify.
  Note If the key does not exist, an array that consists of 0 and empty elements is returned.
• Otherwise, an error message is returned.

Sample command:

TR.SCAN foo 0 COUNT 2

Sample output:

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

Retrieves the offsets of the bits that have a value of 1 within the specified range in a TairRoaring key. The range is a closed interval.

• Key: the key that you want to manage by running this command.
• start: the start value of the interval.
• end: the end value of the interval.

• If the operation is successful, the offsets of the bits that have a value of 1 are returned.
• If the key does not exist, an empty array is returned.
• Otherwise, an error message is returned.

The TR.SETBITS foo 0 2 3 5 command is run in advance.

Sample command:

TR.RANGE foo 0 5

Sample output:

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

Retrieves a string that consists of bit values of 0 and 1 within the specified range in a TairRoaring key. The range is a closed interval.

• Key: the key that you want to manage by running this command.
• start: the start value of the interval.
• end: the end value of the interval.

• If the operation is successful, the offsets of the bits that have a value of 1 are returned.
• If the key does not exist, nil is returned.
• Otherwise, an error message is returned.

The TR.SETBITS foo 0 2 3 5 command is run in advance.

Sample command:

TR.RANGEBITARRAY foo 0 5

Sample output:

"101101"

Retrieves the offset of the first bit that has a value of 1 in a TairRoaring key. If no bits have a value of 1, a value of -1 is returned.

• Key: the key that you want to manage by running this command.

• • If the operation is successful, the integer offset of the first bit that has a value of 1 is returned.
  • If the operation is successful and no bits have a value of 1 or if the operation is successful and the key does not exist, a value of -1 is returned.
• Otherwise, an error message is returned.

Sample command:

TR.MIN foo

Sample output:

4

Retrieves the offset of the last bit that has a value of 1 in a TairRoaring key. If no bits have a value of 1, -1 is returned.

• Key: the key that you want to manage by running this command.

• • If the operation is successful, the integer offset of the last bit that has a value of 1 is returned.
  • If the operation is successful and no bits have a value of 1 or if the operation is successful and the key does not exist, a value of -1 is returned.
• Otherwise, an error message is returned.

Sample command:

TR.MAX foo

Sample output:

6

Returns the statistical information of the specified TairRoaring key. The information includes the number of containers and the memory usage.

• Key: the key that you want to manage by running this command.
• JSON: If this parameter is specified, the statistical information is returned in the JSON format.

• If the operation is successful, the following output is returned:

  "{\"cardinality\":3, # Total number of elements in the key
  "number_of_containers":1, # Total number of containers in the key
  "max_value":6, # Maximum element value in the key
  \"min_value\":3, # Minimum element value in the key
  \"sum_value\":13,
  \"array_container\" :{# Number of array containers in the key
      \"number_of_containers\":1,
      \"container_cardinality\":3,
      \"container_allocated_bytes\":6},
  \"bitset_container\" :{# Number of bitset containers in the key
      \"number_of_containers\":0,
      \"container_cardinality\":0,
      \"container_allocated_bytes\":0},
  \"run_container\" :{# Number of run containers in the key
      \"number_of_containers\":0,
      \"container_cardinality\":0,
      \"container_allocated_bytes\":0}}"
  
                                          

• If the key does not exist, nil is returned.
• Otherwise, an error message is returned.

Sample command:

TR.STAT foo JSON

Sample output:

"{\"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}}"

• Key: the key that you want to manage by running this command.

• If the operation is successful, a double-typed Jaccard similarity coefficient is returned.
• Otherwise, an error message is returned.

Sample command:

TR.JACCARD foo1 foo2

Sample output:

"0.20000000000000001"

• Key: the key that you want to manage by running this command.

• • If the operation is successful and key2 contains key1, a value of 1 is returned.
  • If the operation is successful and key2 does not contain key1, a value of 0 is returned.
• Otherwise, an error message is returned.

The TR.SETBITS fooM 1 2 3 10 and TR.SETBITS foom 1 2 commands are run in advance.

Sample command:

TR.CONTAINS foom fooM

Sample output:

(integer) 1

Retrieves the number of bits that have a value of 1 within the range from the first bit to the specified bit. The range is a closed interval.

• Key: the key that you want to manage by running this command.
• offset: the offset of the specified bit. The value must be an integer.

• If the operation is successful, the number of bits that have a value of 1 is returned.
• Otherwise, an error message is returned.

The TR.SETBITS fooM 1 2 3 10 command is run in advance.

Sample command:

TR.RANK fooM 10

Sample output:

(integer) 4

• The offset is not a 32-bit integer.
• The start and end offsets are invalid.
• The parameter value exceeds the maximum number of elements allowed for a TairRoaring key.