Package io.quarkus.redis.datasource.keys

Interface TransactionalKeyCommands<K>

All Superinterfaces:

TransactionalRedisCommands

All Known Implementing Classes:

BlockingTransactionalKeyCommandsImpl

public interface TransactionalKeyCommands<K>
extends TransactionalRedisCommands

Method Summary

Modifier and Type	Method	Description
void	copy(K source, K destination)	Execute the command COPY.
void	copy(K source, K destination, CopyArgs copyArgs)	Execute the command COPY.
void	del(K... keys)	Execute the command DEL.
void	dump(K key)	Execute the command DUMP.
void	exists(K key)	Execute the command EXISTS.
void	exists(K... keys)	Execute the command EXISTS.
void	expire(K key, long seconds)	Execute the command EXPIRE.
void	expire(K key, long seconds, ExpireArgs expireArgs)	Execute the command EXPIRE.
void	expire(K key, Duration duration)	Execute the command EXPIRE.
void	expire(K key, Duration duration, ExpireArgs expireArgs)	Execute the command EXPIRE.
void	expireat(K key, long timestamp)	Execute the command EXPIREAT.
void	expireat(K key, long timestamp, ExpireArgs expireArgs)	Execute the command EXPIREAT.
void	expireat(K key, Instant timestamp)	Execute the command EXPIREAT.
void	expireat(K key, Instant timestamp, ExpireArgs expireArgs)	Execute the command EXPIREAT.
void	expiretime(K key)	Execute the command EXPIRETIME.
void	keys(String pattern)	Execute the command KEYS.
void	move(K key, long db)	Execute the command MOVE.
void	persist(K key)	Execute the command PERSIST.
void	pexpire(K key, long ms)	Execute the command PEXPIRE.
void	pexpire(K key, long milliseconds, ExpireArgs expireArgs)	Execute the command PEXPIRE.
void	pexpire(K key, Duration duration)	Execute the command PEXPIRE.
void	pexpire(K key, Duration duration, ExpireArgs expireArgs)	Execute the command PEXPIRE.
void	pexpireat(K key, long timestamp)	Execute the command PEXPIREAT.
void	pexpireat(K key, long timestamp, ExpireArgs expireArgs)	Execute the command PEXPIREAT.
void	pexpireat(K key, Instant timestamp)	Execute the command PEXPIREAT.
void	pexpireat(K key, Instant timestamp, ExpireArgs expireArgs)	Execute the command PEXPIREAT.
void	pexpiretime(K key)	Execute the command PEXPIRETIME.
void	pttl(K key)	Execute the command PTTL.
void	randomkey()	Execute the command RANDOMKEY.
void	rename(K key, K newkey)	Execute the command RENAME.
void	renamenx(K key, K newkey)	Execute the command RENAMENX.
void	touch(K... keys)	Execute the command TOUCH.
void	ttl(K key)	Execute the command TTL.
void	type(K key)	Execute the command TYPE.
void	unlink(K... keys)	Execute the command UNLINK.

Methods inherited from interface io.quarkus.redis.datasource.TransactionalRedisCommands

getDataSource

Method Detail

copy

void copy(K source,
          K destination)

Execute the command COPY. Summary: Copy a key Group: generic Requires Redis 6.2.0

Parameters:

source - the key

destination - the key

copy

void copy(K source,
          K destination,
          CopyArgs copyArgs)

Execute the command COPY. Summary: Copy a key Group: generic Requires Redis 6.2.0

Parameters:

source - the key

destination - the key

copyArgs - the additional arguments

del

void del(K... keys)

Execute the command DEL. Summary: Delete one or multiple keys Group: generic Requires Redis 1.0.0

Parameters:

keys - the keys.

dump

void dump(K key)

Execute the command DUMP. Summary: Return a serialized version of the value stored at the specified key. Group: generic Requires Redis 2.6.0

Parameters:

key - the key

exists

void exists(K key)

Execute the command EXISTS. Summary: Determine if a key exists Group: generic Requires Redis 1.0.0

Parameters:

key - the key to check

exists

void exists(K... keys)

Execute the command EXISTS. Summary: Determine if a key exists Group: generic Requires Redis 1.0.0

Parameters:

keys - the keys to check

expire

void expire(K key,
            long seconds,
            ExpireArgs expireArgs)

Execute the command EXPIRE. Summary: Set a key's time to live in seconds Group: generic Requires Redis 1.0.0

Parameters:

key - the key

seconds - the new TTL

expireArgs - the EXPIRE command extra-arguments

expire

void expire(K key,
            Duration duration,
            ExpireArgs expireArgs)

Execute the command EXPIRE. Summary: Set a key's time to live in seconds Group: generic Requires Redis 1.0.0

Parameters:

key - the key

duration - the new TTL

expireArgs - the EXPIRE command extra-arguments

expire

void expire(K key,
            long seconds)

Execute the command EXPIRE. Summary: Set a key's time to live in seconds Group: generic Requires Redis 1.0.0

Parameters:

key - the key

seconds - the new TTL

expire

void expire(K key,
            Duration duration)

Execute the command EXPIRE. Summary: Set a key's time to live in seconds Group: generic Requires Redis 1.0.0

Parameters:

key - the key

duration - the new TTL

expireat

void expireat(K key,
              long timestamp)

Execute the command EXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 1.2.0

Parameters:

key - the key

timestamp - the timestamp

expireat

void expireat(K key,
              Instant timestamp)

Execute the command EXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 1.2.0

Parameters:

key - the key

timestamp - the timestamp

expireat

void expireat(K key,
              long timestamp,
              ExpireArgs expireArgs)

Execute the command EXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 1.2.0

Parameters:

key - the key

timestamp - the timestamp

expireArgs - the EXPIREAT command extra-arguments

expireat

void expireat(K key,
              Instant timestamp,
              ExpireArgs expireArgs)

Execute the command EXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 1.2.0

Parameters:

key - the key

timestamp - the timestamp

expireArgs - the EXPIREAT command extra-arguments

expiretime

void expiretime(K key)

Execute the command EXPIRETIME. Summary: Get the expiration Unix timestamp for a key Group: generic Requires Redis 7.0.0

Parameters:

key - the key

Throws:

RedisKeyNotFoundException - if the key does not exist

keys

void keys(String pattern)

Execute the command KEYS. Summary: Find all keys matching the given pattern Group: generic Requires Redis 1.0.0

Parameters:

pattern - the glob-style pattern

move

void move(K key,
          long db)

Execute the command MOVE. Summary: Move a key to another database Group: generic Requires Redis 1.0.0

Parameters:

key - the key

persist

void persist(K key)

Execute the command PERSIST. Summary: Remove the expiration from a key Group: generic Requires Redis 2.2.0

Parameters:

key - the key

pexpire

void pexpire(K key,
             Duration duration,
             ExpireArgs expireArgs)

Execute the command PEXPIRE. Summary: Set a key's time to live in milliseconds Group: generic Requires Redis 2.6.0

Parameters:

key - the key

duration - the new TTL

expireArgs - the PEXPIRE command extra-arguments

pexpire

void pexpire(K key,
             long ms)

Execute the command PEXPIRE. Summary: Set a key's time to live in milliseconds Group: generic Requires Redis 2.6.0

Parameters:

key - the key

ms - the new TTL

pexpire

void pexpire(K key,
             Duration duration)

Execute the command PEXPIRE. Summary: Set a key's time to live in milliseconds Group: generic Requires Redis 2.6.0

Parameters:

key - the key

duration - the new TTL

pexpire

void pexpire(K key,
             long milliseconds,
             ExpireArgs expireArgs)

Execute the command PEXPIRE. Summary: Set a key's time to live in milliseconds Group: generic Requires Redis 2.6.0

Parameters:

key - the key

milliseconds - the new TTL

expireArgs - the PEXPIRE command extra-arguments

pexpireat

void pexpireat(K key,
               long timestamp)

Execute the command PEXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 2.6.0

Parameters:

key - the key

timestamp - the timestamp

pexpireat

void pexpireat(K key,
               Instant timestamp)

Execute the command PEXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 2.6.0

Parameters:

key - the key

timestamp - the timestamp

pexpireat

void pexpireat(K key,
               long timestamp,
               ExpireArgs expireArgs)

Execute the command PEXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 2.6.0

Parameters:

key - the key

timestamp - the timestamp

expireArgs - the EXPIREAT command extra-arguments

pexpireat

void pexpireat(K key,
               Instant timestamp,
               ExpireArgs expireArgs)

Execute the command PEXPIREAT. Summary: Set the expiration for a key as a UNIX timestamp Group: generic Requires Redis 2.6.0

Parameters:

key - the key

timestamp - the timestamp

expireArgs - the EXPIREAT command extra-arguments

pexpiretime

void pexpiretime(K key)

Execute the command PEXPIRETIME. Summary: Get the expiration Unix timestamp for a key Group: generic Requires Redis 2.6.0

Parameters:

key - the key

Throws:

RedisKeyNotFoundException - if the key does not exist

pttl

void pttl(K key)
   throws RedisKeyNotFoundException

Execute the command PTTL. Summary: Get the time to live for a key in milliseconds Group: generic Requires Redis 2.6.0

Parameters:

key - the key

Throws:

RedisKeyNotFoundException - if the key does not exist

randomkey

void randomkey()

Execute the command RANDOMKEY. Summary: Return a random key from the keyspace Group: generic Requires Redis 1.0.0

rename

void rename(K key,
            K newkey)

Execute the command RENAME. Summary: Rename a key Group: generic Requires Redis 1.0.0

Parameters:

key - the key

newkey - the new key

renamenx

void renamenx(K key,
              K newkey)

Execute the command RENAMENX. Summary: Rename a key, only if the new key does not exist Group: generic Requires Redis 1.0.0

Parameters:

key - the key

newkey - the new key

touch

void touch(K... keys)

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

Parameters:

keys - the keys

ttl

void ttl(K key)
  throws RedisKeyNotFoundException

Execute the command TTL. Summary: Get the time to live for a key in seconds Group: generic Requires Redis 1.0.0

Parameters:

key - the key

Throws:

RedisKeyNotFoundException - if the key does not exist

type

void type(K key)

Execute the command TYPE. Summary: Determine the type stored at key Group: generic Requires Redis 1.0.0

Parameters:

key - the key

unlink

void unlink(K... keys)

Execute the command UNLINK. Summary: Delete a key asynchronously in another thread. Otherwise, it is just as DEL, but non-blocking. Group: generic Requires Redis 4.0.0

Parameters:

keys - the keys