org.redisson.api

Interface RKeys

All Superinterfaces:

RKeysAsync

All Known Implementing Classes:

RedissonKeys

public interface RKeys
extends RKeysAsync

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method and Description
long	count() Returns the number of keys in the currently-selected database
long	countExists(String... names) Checks if provided keys exist
long	delete(String... keys) Delete multiple objects by name
long	deleteByPattern(String pattern) Delete multiple objects by a key pattern.
Collection<String>	findKeysByPattern(String pattern) Find keys by key search pattern Supported glob-style patterns: h?
void	flushall() Delete all keys of all existing databases
void	flushdb() Delete all keys of currently selected database
Iterable<String>	getKeys() Get all keys using iterator.
Iterable<String>	getKeysByPattern(String pattern) Get all keys by pattern using iterator.
Iterable<String>	getKeysByPattern(String pattern, int count) Get all keys by pattern using iterator.
int	getSlot(String key) Get hash slot identifier for key.
RType	getType(String key) Get Redis object type by key
String	randomKey() Get random key
long	touch(String... names) Update the last access time of an object.

Methods inherited from interface org.redisson.api.RKeysAsync

countAsync, countExistsAsync, deleteAsync, deleteByPatternAsync, findKeysByPatternAsync, flushallAsync, flushdbAsync, getSlotAsync, getTypeAsync, randomKeyAsync, touchAsync

Method Detail

touch

long touch(String... names)

Update the last access time of an object.

Returns:

count of objects were touched

countExists

long countExists(String... names)

Checks if provided keys exist

Parameters:

names - of keys

Returns:

amount of existing keys

getType

RType getType(String key)

Get Redis object type by key

Parameters:

key - - name of key

Returns:

type of key

getSlot

int getSlot(String key)

Get hash slot identifier for key. Available for cluster nodes only

Parameters:

key - - name of key

Returns:

slot number

getKeysByPattern

Iterable<String> getKeysByPattern(String pattern)

Get all keys by pattern using iterator. Keys traversed with SCAN operation. Each SCAN operation loads up to 10 keys per request.

Supported glob-style patterns:

h?llo subscribes to hello, hallo and hxllo

h*llo subscribes to hllo and heeeello

h[ae]llo subscribes to hello and hallo, but not hillo

Parameters:

pattern - - match pattern

Returns:

Iterable object

getKeysByPattern

Iterable<String> getKeysByPattern(String pattern,
                                  int count)

Get all keys by pattern using iterator. Keys traversed with SCAN operation. Each SCAN operation loads up to count keys per request.

Supported glob-style patterns:

h?llo subscribes to hello, hallo and hxllo

h*llo subscribes to hllo and heeeello

h[ae]llo subscribes to hello and hallo, but not hillo

Parameters:

pattern - - match pattern

count - - keys loaded per request to Redis

Returns:

Iterable object

getKeys

Iterable<String> getKeys()

Get all keys using iterator. Keys traversing with SCAN operation

Returns:

Iterable object

randomKey

String randomKey()

Get random key

Returns:

random key

findKeysByPattern

Collection<String> findKeysByPattern(String pattern)

Find keys by key search pattern Supported glob-style patterns: h?llo subscribes to hello, hallo and hxllo h*llo subscribes to hllo and heeeello h[ae]llo subscribes to hello and hallo, but not hillo

Parameters:

pattern - - match pattern

Returns:

collection of keys

deleteByPattern

long deleteByPattern(String pattern)

Delete multiple objects by a key pattern.

Method executes in NON atomic way in cluster mode due to lua script limitations.

Supported glob-style patterns: h?llo subscribes to hello, hallo and hxllo h*llo subscribes to hllo and heeeello h[ae]llo subscribes to hello and hallo, but not hillo

Parameters:

pattern - - match pattern

Returns:

number of removed keys

delete

long delete(String... keys)

Delete multiple objects by name

Parameters:

keys - - object names

Returns:

number of removed keys

count

long count()

Returns the number of keys in the currently-selected database

Returns:

count of keys

flushdb

void flushdb()

Delete all keys of currently selected database

flushall

void flushall()

Delete all keys of all existing databases