Class BlockingKeyCommandsImpl<K>
java.lang.Object
io.quarkus.redis.runtime.datasource.AbstractRedisCommandGroup
io.quarkus.redis.runtime.datasource.BlockingKeyCommandsImpl<K>
- All Implemented Interfaces:
KeyCommands<K>
,RedisCommands
-
Field Summary
Fields inherited from class io.quarkus.redis.runtime.datasource.AbstractRedisCommandGroup
ds, timeout
-
Constructor Summary
ConstructorDescriptionBlockingKeyCommandsImpl
(RedisDataSource ds, ReactiveKeyCommands<K> reactive, Duration timeout) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Execute the command COPY.boolean
Execute the command COPY.int
Execute the command DEL.Execute the command DUMP.boolean
Execute the command EXISTS.int
Execute the command EXISTS.boolean
Execute the command EXPIRE.boolean
expire
(K key, long seconds, ExpireArgs expireArgs) Execute the command EXPIRE.boolean
Execute the command EXPIRE.boolean
expire
(K key, Duration duration, ExpireArgs expireArgs) Execute the command EXPIRE.boolean
Execute the command EXPIREAT.boolean
expireat
(K key, long timestamp, ExpireArgs expireArgs) Execute the command EXPIREAT.boolean
Execute the command EXPIREAT.boolean
expireat
(K key, Instant timestamp, ExpireArgs expireArgs) Execute the command EXPIREAT.long
expiretime
(K key) Execute the command EXPIRETIME.Execute the command KEYS.boolean
Execute the command MOVE.boolean
Execute the command PERSIST.boolean
Execute the command PEXPIRE.boolean
pexpire
(K key, long seconds, ExpireArgs pexpireArgs) Execute the command PEXPIRE.boolean
Execute the command PEXPIRE.boolean
pexpire
(K key, Duration duration, ExpireArgs pexpireArgs) Execute the command PEXPIRE.boolean
Execute the command PEXPIREAT.boolean
pexpireat
(K key, long timestamp, ExpireArgs pexpireArgs) Execute the command PEXPIREAT.boolean
Execute the command PEXPIREAT.boolean
pexpireat
(K key, Instant timestamp, ExpireArgs pexpireArgs) Execute the command PEXPIREAT.long
pexpiretime
(K key) Execute the command PEXPIRETIME.long
Execute the command PTTL.Execute the command RANDOMKEY.void
Execute the command RENAME.boolean
Execute the command RENAMENX.scan()
Execute the command SCAN.scan
(KeyScanArgs args) Execute the command SCAN.int
Execute the command TOUCH.long
Execute the command TTL.Execute the command TYPE.int
Execute the command UNLINK.Methods inherited from class io.quarkus.redis.runtime.datasource.AbstractRedisCommandGroup
getDataSource
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface io.quarkus.redis.datasource.RedisCommands
getDataSource
-
Constructor Details
-
BlockingKeyCommandsImpl
public BlockingKeyCommandsImpl(RedisDataSource ds, ReactiveKeyCommands<K> reactive, Duration timeout)
-
-
Method Details
-
copy
Description copied from interface:KeyCommands
Execute the command COPY. Summary: Copy a key Group: generic Requires Redis 6.2.0- Specified by:
copy
in interfaceKeyCommands<K>
- Parameters:
source
- the keydestination
- the key- Returns:
true
source was copied.false
source was not copied.
-
copy
Description copied from interface:KeyCommands
Execute the command COPY. Summary: Copy a key Group: generic Requires Redis 6.2.0- Specified by:
copy
in interfaceKeyCommands<K>
- Parameters:
source
- the keydestination
- the keycopyArgs
- the additional arguments- Returns:
true
source was copied.false
source was not copied.
-
del
Description copied from interface:KeyCommands
Execute the command DEL. Summary: Delete one or multiple keys Group: generic Requires Redis 1.0.0- Specified by:
del
in interfaceKeyCommands<K>
- Parameters:
keys
- the keys.- Returns:
- The number of keys that were removed.
-
dump
Description copied from interface:KeyCommands
Execute the command DUMP. Summary: Return a serialized version of the value stored at the specified key. Group: generic Requires Redis 2.6.0- Specified by:
dump
in interfaceKeyCommands<K>
- Parameters:
key
- the key- Returns:
- the serialized value.
-
exists
Description copied from interface:KeyCommands
Execute the command EXISTS. Summary: Determine if a key exists Group: generic Requires Redis 1.0.0- Specified by:
exists
in interfaceKeyCommands<K>
- Parameters:
key
- the key to check- Returns:
true
if the key exists,false
otherwise
-
exists
Description copied from interface:KeyCommands
Execute the command EXISTS. Summary: Determine if a key exists Group: generic Requires Redis 1.0.0- Specified by:
exists
in interfaceKeyCommands<K>
- Parameters:
keys
- the keys to check- Returns:
- the number of keys that exist from those specified as arguments.
-
expire
Description copied from interface:KeyCommands
Execute the command EXPIRE. Summary: Set a key's time to live in seconds Group: generic Requires Redis 1.0.0- Specified by:
expire
in interfaceKeyCommands<K>
- Parameters:
key
- the keyseconds
- the new TTLexpireArgs
- theEXPIRE
command extra-arguments- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist, or operation skipped due to the provided arguments.
-
expire
Description copied from interface:KeyCommands
Execute the command EXPIRE. Summary: Set a key's time to live in seconds Group: generic Requires Redis 1.0.0- Specified by:
expire
in interfaceKeyCommands<K>
- Parameters:
key
- the keyduration
- the new TTLexpireArgs
- theEXPIRE
command extra-arguments- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist, or operation skipped due to the provided arguments.
-
expire
Description copied from interface:KeyCommands
Execute the command EXPIRE. Summary: Set a key's time to live in seconds Group: generic Requires Redis 1.0.0- Specified by:
expire
in interfaceKeyCommands<K>
- Parameters:
key
- the keyseconds
- the new TTL- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist.
-
expire
Description copied from interface:KeyCommands
Execute the command EXPIRE. Summary: Set a key's time to live in seconds Group: generic Requires Redis 1.0.0- Specified by:
expire
in interfaceKeyCommands<K>
- Parameters:
key
- the keyduration
- the new TTL- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist.
-
expireat
Description copied from interface:KeyCommands
Execute the command EXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 1.2.0- Specified by:
expireat
in interfaceKeyCommands<K>
- Parameters:
key
- the keytimestamp
- the timestamp- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist.
-
expireat
Description copied from interface:KeyCommands
Execute the command EXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 1.2.0- Specified by:
expireat
in interfaceKeyCommands<K>
- Parameters:
key
- the keytimestamp
- the timestamp- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist.
-
expireat
Description copied from interface:KeyCommands
Execute the command EXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 1.2.0- Specified by:
expireat
in interfaceKeyCommands<K>
- Parameters:
key
- the keytimestamp
- the timestampexpireArgs
- theEXPIREAT
command extra-arguments- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist, or operation skipped due to the provided arguments.
-
expireat
Description copied from interface:KeyCommands
Execute the command EXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 1.2.0- Specified by:
expireat
in interfaceKeyCommands<K>
- Parameters:
key
- the keytimestamp
- the timestampexpireArgs
- theEXPIREAT
command extra-arguments- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist, or operation skipped due to the provided arguments.
-
expiretime
Description copied from interface:KeyCommands
Execute the command EXPIRETIME. Summary: Get the expiration Unix timestamp for a key Group: generic Requires Redis 7.0.0- Specified by:
expiretime
in interfaceKeyCommands<K>
- Parameters:
key
- the key- Returns:
- the expiration Unix timestamp in seconds,
-1
if the key exists but has no associated expiration time.
-
keys
Description copied from interface:KeyCommands
Execute the command KEYS. Summary: Find all keys matching the given pattern Group: generic Requires Redis 1.0.0- Specified by:
keys
in interfaceKeyCommands<K>
- Parameters:
pattern
- the glob-style pattern- Returns:
- the list of keys matching pattern.
-
move
Description copied from interface:KeyCommands
Execute the command MOVE. Summary: Move a key to another database Group: generic Requires Redis 1.0.0- Specified by:
move
in interfaceKeyCommands<K>
- Parameters:
key
- the key- Returns:
true
key was moved.false
key was not moved.
-
persist
Description copied from interface:KeyCommands
Execute the command PERSIST. Summary: Remove the expiration from a key Group: generic Requires Redis 2.2.0- Specified by:
persist
in interfaceKeyCommands<K>
- Parameters:
key
- the key- Returns:
true
the timeout was removed.false
key does not exist or does not have an associated timeout.
-
pexpire
Description copied from interface:KeyCommands
Execute the command PEXPIRE. Summary: Set a key's time to live in milliseconds Group: generic Requires Redis 2.6.0- Specified by:
pexpire
in interfaceKeyCommands<K>
- Parameters:
key
- the keyseconds
- the new TTLpexpireArgs
- thePEXPIRE
command extra-arguments- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist.
-
pexpire
Description copied from interface:KeyCommands
Execute the command PEXPIRE. Summary: Set a key's time to live in milliseconds Group: generic Requires Redis 2.6.0- Specified by:
pexpire
in interfaceKeyCommands<K>
- Parameters:
key
- the keyduration
- the new TTLpexpireArgs
- thePEXPIRE
command extra-arguments- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist, or operation skipped due to the provided arguments.
-
pexpire
Description copied from interface:KeyCommands
Execute the command PEXPIRE. Summary: Set a key's time to live in milliseconds Group: generic Requires Redis 2.6.0- Specified by:
pexpire
in interfaceKeyCommands<K>
- Parameters:
key
- the keyms
- the new TTL- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist.
-
pexpire
Description copied from interface:KeyCommands
Execute the command PEXPIRE. Summary: Set a key's time to live in milliseconds Group: generic Requires Redis 2.6.0- Specified by:
pexpire
in interfaceKeyCommands<K>
- Parameters:
key
- the keyduration
- the new TTL- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist.
-
pexpireat
Description copied from interface:KeyCommands
Execute the command PEXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 2.6.0- Specified by:
pexpireat
in interfaceKeyCommands<K>
- Parameters:
key
- the keytimestamp
- the timestamp- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist.
-
pexpireat
Description copied from interface:KeyCommands
Execute the command PEXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 2.6.0- Specified by:
pexpireat
in interfaceKeyCommands<K>
- Parameters:
key
- the keytimestamp
- the timestamp- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist.
-
pexpireat
Description copied from interface:KeyCommands
Execute the command PEXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 2.6.0- Specified by:
pexpireat
in interfaceKeyCommands<K>
- Parameters:
key
- the keytimestamp
- the timestamppexpireArgs
- theEXPIREAT
command extra-arguments- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist, or operation skipped due to the provided arguments.
-
pexpireat
Description copied from interface:KeyCommands
Execute the command PEXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 2.6.0- Specified by:
pexpireat
in interfaceKeyCommands<K>
- Parameters:
key
- the keytimestamp
- the timestamppexpireArgs
- theEXPIREAT
command extra-arguments- Returns:
true
the timeout was set.false
the timeout was not set. e.g. key doesn't exist, or operation skipped due to the provided arguments.
-
pexpiretime
Description copied from interface:KeyCommands
Execute the command PEXPIRETIME. Summary: Get the expiration Unix timestamp for a key Group: generic Requires Redis 2.6.0- Specified by:
pexpiretime
in interfaceKeyCommands<K>
- Parameters:
key
- the key- Returns:
- the expiration Unix timestamp in milliseconds;
-1
if the key exists but has no associated expiration time.
-
pttl
Description copied from interface:KeyCommands
Execute the command PTTL. Summary: Get the time to live for a key in milliseconds Group: generic Requires Redis 2.6.0- Specified by:
pttl
in interfaceKeyCommands<K>
- Parameters:
key
- the key- Returns:
- TTL in milliseconds. The command returns
-1
if the key exists but has no associated expire.
-
randomkey
Description copied from interface:KeyCommands
Execute the command RANDOMKEY. Summary: Return a random key from the keyspace Group: generic Requires Redis 1.0.0- Specified by:
randomkey
in interfaceKeyCommands<K>
- Returns:
- the random key, or
null
when the database is empty.
-
rename
Description copied from interface:KeyCommands
Execute the command RENAME. Summary: Rename a key Group: generic Requires Redis 1.0.0- Specified by:
rename
in interfaceKeyCommands<K>
- Parameters:
key
- the keynewkey
- the new key
-
renamenx
Description copied from interface:KeyCommands
Execute the command RENAMENX. Summary: Rename a key, only if the new key does not exist Group: generic Requires Redis 1.0.0- Specified by:
renamenx
in interfaceKeyCommands<K>
- Parameters:
key
- the keynewkey
- the new key- Returns:
true
ifkey
was renamed tonewkey
.false
ifnewkey
already exists.
-
scan
Description copied from interface:KeyCommands
Execute the command SCAN. Summary: Incrementally iterate the keys space Group: generic Requires Redis 2.8.0- Specified by:
scan
in interfaceKeyCommands<K>
- Returns:
- the cursor.
-
scan
Description copied from interface:KeyCommands
Execute the command SCAN. Summary: Incrementally iterate the keys space Group: generic Requires Redis 2.8.0- Specified by:
scan
in interfaceKeyCommands<K>
- Parameters:
args
- the extra arguments- Returns:
- the cursor.
-
touch
Description copied from interface:KeyCommands
Execute the command TOUCH. Summary: Alters the last access time of a key(s). Returns the number of existing keys specified. Group: generic Requires Redis 3.2.1- Specified by:
touch
in interfaceKeyCommands<K>
- Parameters:
keys
- the keys- Returns:
- The number of keys that were touched.
-
ttl
Description copied from interface:KeyCommands
Execute the command TTL. Summary: Get the time to live for a key in seconds Group: generic Requires Redis 1.0.0- Specified by:
ttl
in interfaceKeyCommands<K>
- Parameters:
key
- the key- Returns:
- TTL in seconds,
-1
if the key exists but has no associated expire.
-
type
Description copied from interface:KeyCommands
Execute the command TYPE. Summary: Determine the type stored at key Group: generic Requires Redis 1.0.0- Specified by:
type
in interfaceKeyCommands<K>
- Parameters:
key
- the key- Returns:
- type of key, or
NONE
when key does not exist.
-
unlink
Description copied from interface:KeyCommands
Execute the command UNLINK. Summary: Delete a key asynchronously in another thread. Otherwise, it is just asDEL
, but non-blocking. Group: generic Requires Redis 4.0.0- Specified by:
unlink
in interfaceKeyCommands<K>
- Parameters:
keys
- the keys- Returns:
- The number of keys that were unlinked.
-