Interface BitMapCommands<K>
- Type Parameters:
K
- the type of the key
- All Superinterfaces:
RedisCommands
- All Known Implementing Classes:
BlockingBitmapCommandsImpl
Allows executing commands from the
bitmap
group.
See the bitmap command list for further information about these
commands.-
Method Summary
Modifier and TypeMethodDescriptionlong
Execute the command BITCOUNT.long
Execute the command BITCOUNT.bitfield
(K key, BitFieldArgs bitFieldArgs) Execute the command BITFIELD.long
Execute the command BITOP.long
Execute the command BITOP.long
Execute the command BITOP.long
Execute the command BITOP.long
Execute the command BITPOS.long
Execute the command BITPOS.long
Execute the command BITPOS.int
Returns the bit value at offset in the string value stored at key.int
Sets or clears the bit at offset in the string value stored at key.Methods inherited from interface io.quarkus.redis.datasource.RedisCommands
getDataSource
-
Method Details
-
bitcount
Execute the command BITCOUNT. Summary: Count set bits in a string Group: bitmap Requires Redis 2.6.0- Parameters:
key
- the key- Returns:
- the number of bits set to 1 in the stored string.
-
bitcount
Execute the command BITCOUNT. Summary: Count set bits in a string Group: bitmap Requires Redis 2.6.0- Parameters:
key
- the keystart
- the start indexend
- the end index- Returns:
- the number of bits set to 1 in the stored string.
-
getbit
Returns the bit value at offset in the string value stored at key.- Parameters:
key
- the key.offset
- the offset- Returns:
- the bit value stored at offset (0 or 1).
-
bitfield
Execute the command BITFIELD. Summary: Perform arbitrary bitfield integer operations on strings Group: bitmap Requires Redis 3.2.0- Parameters:
key
- the key- Returns:
- the results from the bitfield commands as described on https://redis.io/commands/bitfield/.
-
bitpos
Execute the command BITPOS. Summary: Find first bit set or clear in a string Group: bitmap Requires Redis 2.8.7- Parameters:
key
- the keyvalueToLookFor
-1
to look for1
,0
to look for0
- Returns:
- the position of the first bit set to 1 or 0 according to the request. If we look for set bits (the bit argument is 1) and the string is empty or composed of just zero ints, -1 is returned. If we look for clear bits (the bit argument is 0) and the string only contains bit set to 1, the function returns the first bit not part of the string on the right. So if the string is three ints set to the value 0xff the command BITPOS key 0 will return 24, since up to bit 23 all the bits are 1. Basically, the function considers the right of the string as padded with zeros if you look for clear bits and specify no range or the start argument only. However, this behavior changes if you are looking for clear bits and specify a range with both start and end. If no clear bit is found in the specified range, the function returns -1 as the user specified a clear range and there are no 0 bits in that range.
-
bitpos
Execute the command BITPOS. Summary: Find first bit set or clear in a string Group: bitmap Requires Redis 2.8.7- Parameters:
key
- the keybit
-1
to look for1
,0
to look for0
start
- the start position- Returns:
- the position of the first bit set to 1 or 0 according to the request. If we look for set bits (the bit argument is 1) and the string is empty or composed of just zero ints, -1 is returned. If we look for clear bits (the bit argument is 0) and the string only contains bit set to 1, the function returns the first bit not part of the string on the right. So if the string is three ints set to the value 0xff the command BITPOS key 0 will return 24, since up to bit 23 all the bits are 1. Basically, the function considers the right of the string as padded with zeros if you look for clear bits and specify no range or the start argument only. However, this behavior changes if you are looking for clear bits and specify a range with both start and end. If no clear bit is found in the specified range, the function returns -1 as the user specified a clear range and there are no 0 bits in that range.
-
bitpos
Execute the command BITPOS. Summary: Find first bit set or clear in a string Group: bitmap Requires Redis 2.8.7- Parameters:
key
- the keybit
-true
to look for1
,false
to look for0
start
- the start positionend
- the end position- Returns:
- the position of the first bit set to 1 or 0 according to the request. If we look for set bits (the bit argument is 1) and the string is empty or composed of just zero ints, -1 is returned. If we look for clear bits (the bit argument is 0) and the string only contains bit set to 1, the function returns the first bit not part of the string on the right. So if the string is three ints set to the value 0xff the command BITPOS key 0 will return 24, since up to bit 23 all the bits are 1. Basically, the function considers the right of the string as padded with zeros if you look for clear bits and specify no range or the start argument only. However, this behavior changes if you are looking for clear bits and specify a range with both start and end. If no clear bit is found in the specified range, the function returns -1 as the user specified a clear range and there are no 0 bits in that range.
-
bitopAnd
Execute the command BITOP. Summary: Perform a bitwise AND operation between strings Group: bitmap Requires Redis 2.6.0- Parameters:
destination
- the destination keykeys
- the keys- Returns:
- The size of the string stored in the destination key, that is equal to the size of the longest input string.
-
bitopNot
Execute the command BITOP. Summary: Perform a bitwise NOT operation between strings Group: bitmap Requires Redis 2.6.0- Parameters:
destination
- the destination keysource
- the source key- Returns:
- The size of the string stored in the destination key, that is equal to the size of the longest input string.
-
bitopOr
Execute the command BITOP. Summary: Perform a bitwise OR operation between strings Group: bitmap Requires Redis 2.6.0- Parameters:
destination
- the destination keykeys
- the keys- Returns:
- The size of the string stored in the destination key, that is equal to the size of the longest input string.
-
bitopXor
Execute the command BITOP. Summary: Perform a bitwise XOR operation between strings Group: bitmap Requires Redis 2.6.0- Parameters:
destination
- the destination keykeys
- the keys- Returns:
- The size of the string stored in the destination key, that is equal to the size of the longest input string.
-
setbit
Sets or clears the bit at offset in the string value stored at key.- Parameters:
key
- the key.offset
- the offsetvalue
- the value (O or 1)- Returns:
- the original bit value stored at offset, 0 or 1.
-