org.springframework.data.redis.connection

Interface RedisServerCommands

All Known Subinterfaces:

RedisClusterConnection, RedisCommands, RedisConnection, StringRedisConnection

All Known Implementing Classes:

AbstractRedisConnection, DefaultStringRedisConnection, JedisClusterConnection, JedisConnection, LettuceClusterConnection, LettuceConnection

public interface RedisServerCommands

Server-specific commands supported by Redis.

Author:

Costin Leau, Christoph Strobl, Thomas Darimont

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RedisServerCommands.MigrateOption
static class	RedisServerCommands.ShutdownOption

Method Summary

Modifier and Type	Method and Description
void	bgReWriteAof() Start an Append Only File rewrite process on server.
void	bgSave() Start background saving of db on server.
void	bgWriteAof() Deprecated. As of 1.3, use bgReWriteAof().
Long	dbSize() Get the total number of available keys in currently selected database.
void	flushAll() Delete all all keys from all databases.
void	flushDb() Delete all keys of the currently selected database.
List<RedisClientInfo>	getClientList() Request information and statistics about connected clients.
String	getClientName() Returns the name of the current connection.
List<String>	getConfig(String pattern) Load configuration parameters for given pattern from server.
Properties	info() Load default server information like mempory cpu utilization replication See http://redis.io/commands/info
Properties	info(String section) Load server information for given selection.
void	killClient(String host, int port) Closes a given client connection identified by host:port.
Long	lastSave() Get time of last bgSave() operation in seconds.
void	migrate(byte[] key, RedisNode target, int dbIndex, RedisServerCommands.MigrateOption option)
void	migrate(byte[] key, RedisNode target, int dbIndex, RedisServerCommands.MigrateOption option, long timeout)
void	resetConfigStats() Reset statistic counters on server.
void	save() Synchronous save current db snapshot on server.
void	setClientName(byte[] name) Assign given name to current connection.
void	setConfig(String param, String value) Set server configuration for param to value.
void	shutdown() Shutdown server.
void	shutdown(RedisServerCommands.ShutdownOption option) Shutdown server.
void	slaveOf(String host, int port) Change redis replication setting to new master.
void	slaveOfNoOne() Change server into master.
Long	time() Request server timestamp using TIME command.

Method Detail

bgWriteAof

@Deprecated
void bgWriteAof()

Deprecated. As of 1.3, use bgReWriteAof().

Start an Append Only File rewrite process on server.

See http://redis.io/commands/bgrewriteaof

bgReWriteAof

void bgReWriteAof()

Start an Append Only File rewrite process on server.

See http://redis.io/commands/bgrewriteaof

Since:

1.3

bgSave

void bgSave()

Start background saving of db on server.

See http://redis.io/commands/bgsave

lastSave

Long lastSave()

Get time of last bgSave() operation in seconds.

See http://redis.io/commands/lastsave

Returns:

save

void save()

Synchronous save current db snapshot on server.

See http://redis.io/commands/save

dbSize

Long dbSize()

Get the total number of available keys in currently selected database.

See http://redis.io/commands/dbsize

Returns:

flushDb

void flushDb()

Delete all keys of the currently selected database.

See http://redis.io/commands/flushdb

flushAll

void flushAll()

Delete all all keys from all databases.

See http://redis.io/commands/flushall

info

Properties info()

Load default server information like

• mempory
• cpu utilization
• replication

See http://redis.io/commands/info

Returns:

info

Properties info(String section)

Load server information for given selection.

See http://redis.io/commands/info

Returns:

shutdown

void shutdown()

Shutdown server.

See http://redis.io/commands/shutdown

shutdown

void shutdown(RedisServerCommands.ShutdownOption option)

Shutdown server.

See http://redis.io/commands/shutdown

Since:

1.3

getConfig

List<String> getConfig(String pattern)

Load configuration parameters for given pattern from server.

See http://redis.io/commands/config-get

Parameters:

pattern -

Returns:

setConfig

void setConfig(String param,
               String value)

Set server configuration for param to value.

See http://redis.io/commands/config-set

Parameters:

param -

value -

resetConfigStats

void resetConfigStats()

Reset statistic counters on server.
Counters can be retrieved using info().

See http://redis.io/commands/config-resetstat

time

Long time()

Request server timestamp using TIME command.

Returns:

current server time in milliseconds.

Since:

1.1

killClient

void killClient(String host,
                int port)

Closes a given client connection identified by host:port.

Parameters:

host - of connection to close.

port - of connection to close

Since:

1.3

setClientName

void setClientName(byte[] name)

Assign given name to current connection.

Parameters:

name -

Since:

1.3

getClientName

String getClientName()

Returns the name of the current connection.

See http://redis.io/commands/client-getname

Returns:

Since:

1.3

getClientList

List<RedisClientInfo> getClientList()

Request information and statistics about connected clients.

See http://redis.io/commands/client-list

Returns:

List of RedisClientInfo objects.

Since:

1.3

slaveOf

void slaveOf(String host,
             int port)

Change redis replication setting to new master.

See http://redis.io/commands/slaveof

Parameters:

host -

port -

Since:

1.3

slaveOfNoOne

void slaveOfNoOne()

Change server into master.

See http://redis.io/commands/slaveof

Since:

1.3

migrate

void migrate(byte[] key,
             RedisNode target,
             int dbIndex,
             RedisServerCommands.MigrateOption option)

Parameters:

key - must not be null.

target - must not be null.

dbIndex -

option - can be null. Defaulted to RedisServerCommands.MigrateOption.COPY.

Since:

1.7

migrate

void migrate(byte[] key,
             RedisNode target,
             int dbIndex,
             RedisServerCommands.MigrateOption option,
             long timeout)

Parameters:

key - must not be null.

target - must not be null.

dbIndex -

option - can be null. Defaulted to RedisServerCommands.MigrateOption.COPY.

timeout -

Since:

1.7