io.valkey.commands

Interface DatabasePipelineCommands

All Known Implementing Classes:

Pipeline

public interface DatabasePipelineCommands

Method Summary

Modifier and Type	Method and Description
Response<Boolean>	copy(byte[] srcKey, byte[] dstKey, int db, boolean replace) Binary version of COPY.
Response<Boolean>	copy(String srcKey, String dstKey, int db, boolean replace) Copy the value stored at the source key to the destination key.
Response<Long>	dbSize() Return the number of keys in the currently-selected database.
Response<String>	migrate(String host, int port, byte[] key, int destinationDB, int timeout) Binary version of MIGRATE.
Response<String>	migrate(String host, int port, int destinationDB, int timeout, MigrateParams params, byte[]... keys) Binary version of MIGRATE.
Response<String>	migrate(String host, int port, int destinationDB, int timeout, MigrateParams params, String... keys) Migrate Command Atomically transfer a key from a source Redis instance to a destination Redis instance.
Response<String>	migrate(String host, int port, String key, int destinationDB, int timeout) Migrate Command Atomically transfer a key from a source Redis instance to a destination Redis instance.
Response<Long>	move(byte[] key, int dbIndex) Binary version of MOVE.
Response<Long>	move(String key, int dbIndex) Move the specified key from the currently selected DB to the specified destination DB.
Response<String>	select(int index) Select the DB with having the specified zero-based numeric index.
Response<String>	swapDB(int index1, int index2) This command swaps two Redis databases, so that immediately all the clients connected to a given database will see the data of the other database, and the other way around.

Method Detail

select

Response<String> select(int index)

Select the DB with having the specified zero-based numeric index.

Parameters:

index - the index of db

Returns:

OK

dbSize

Response<Long> dbSize()

Return the number of keys in the currently-selected database.

Returns:

The number of keys

swapDB

Response<String> swapDB(int index1,
                        int index2)

This command swaps two Redis databases, so that immediately all the clients connected to a given database will see the data of the other database, and the other way around.

Parameters:

index1 -

index2 -

Returns:

OK

move

Response<Long> move(String key,
                    int dbIndex)

Move the specified key from the currently selected DB to the specified destination DB. Note that this command returns 1 only if the key was successfully moved, and 0 if the target key was already there or if the source key was not found at all, so it is possible to use MOVE as a locking primitive.

Parameters:

key - The specified key

dbIndex - Specified destination database

Returns:

1 if the key was moved, 0 if the key was not moved because already present on the target DB or was not found in the current DB

move

Response<Long> move(byte[] key,
                    int dbIndex)

Binary version of MOVE.

See Also:

DatabaseCommands.move(String, int)

copy

Response<Boolean> copy(String srcKey,
                       String dstKey,
                       int db,
                       boolean replace)

Copy the value stored at the source key to the destination key.

Parameters:

srcKey - The source key.

dstKey - The destination key.

db - Allows specifying an alternative logical database index for the destination key.

replace - Removes the destination key before copying the value to it, in order to avoid error.

copy

Response<Boolean> copy(byte[] srcKey,
                       byte[] dstKey,
                       int db,
                       boolean replace)

Binary version of COPY.

See Also:

copy(String, String, int, boolean)

migrate

Response<String> migrate(String host,
                         int port,
                         byte[] key,
                         int destinationDB,
                         int timeout)

Binary version of MIGRATE.

See Also:

migrate(String, int, String, int, int)

migrate

Response<String> migrate(String host,
                         int port,
                         int destinationDB,
                         int timeout,
                         MigrateParams params,
                         byte[]... keys)

Binary version of MIGRATE.

See Also:

migrate(String, int, int, int, MigrateParams, String...)

migrate

Response<String> migrate(String host,
                         int port,
                         String key,
                         int destinationDB,
                         int timeout)

Migrate Command Atomically transfer a key from a source Redis instance to a destination Redis instance. On success the key is deleted from the original instance and is guaranteed to exist in the target instance.

Parameters:

host - Target host

port - Target port

key - Migrate key

destinationDB - Target db

timeout - The maximum idle time in any moment of the communication with the destination instance in milliseconds.

Returns:

OK on success, or NOKEY if no keys were found in the source instance

migrate

Response<String> migrate(String host,
                         int port,
                         int destinationDB,
                         int timeout,
                         MigrateParams params,
                         String... keys)

Migrate Command Atomically transfer a key from a source Redis instance to a destination Redis instance. On success the key is deleted from the original instance and is guaranteed to exist in the target instance.

Parameters:

host - Target host

port - Target port

destinationDB - Target db

timeout - The maximum idle time in any moment of the communication with the destination instance in milliseconds.

params - MigrateParams

keys - The keys to migrate

Returns:

OK on success, or NOKEY if no keys were found in the source instance.