com.yahoo.bard.webservice.data.dimension

Class RedisStore

java.lang.Object

com.yahoo.bard.webservice.data.dimension.RedisStore

All Implemented Interfaces:

KeyValueStore, Closeable, AutoCloseable

public class RedisStore
extends Object
implements KeyValueStore

A Redis-based implementation of KeyValueStore.

Constructor Summary

Constructors

Constructor and Description
RedisStore(String storeName, redis.clients.jedis.JedisPool pool, String redisNamespace) Build a connection to a Redis provider.

Method Summary

Modifier and Type	Method and Description
void	close() Close the store.
String	get(String key) Get the value for a key from store.
boolean	isHealthy() Get the health status of the store.
boolean	isOpen() Get the open / closed status of the store.
void	open() Open the store.
String	put(String key, String value) Set a value for the key.
Map<String,String>	putAll(Map<String,String> entries) Set a multiple key/value pairs.
String	remove(String key) Remove a key from store.
void	removeAllKeys() Remove all keys associated with the store.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.yahoo.bard.webservice.data.dimension.KeyValueStore

getOrDefault, replaceStore

Constructor Detail

RedisStore

public RedisStore(String storeName,
                  redis.clients.jedis.JedisPool pool,
                  String redisNamespace)

Build a connection to a Redis provider.

Parameters:

storeName - The second part of the prefix to keyspace names for this store

pool - A pool of Jedis connection instances

redisNamespace - The first part of the prefix to the keyspace names for this store

Method Detail

open

public void open()

Description copied from interface: KeyValueStore

Open the store.

Specified by:

open in interface KeyValueStore

close

public void close()

Description copied from interface: KeyValueStore

Close the store.

Specified by:

close in interface KeyValueStore

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

isOpen

public boolean isOpen()

Description copied from interface: KeyValueStore

Get the open / closed status of the store.

Specified by:

isOpen in interface KeyValueStore

Returns:

true if the store is open

removeAllKeys

public void removeAllKeys()

Remove all keys associated with the store.

This is mainly used for tests; the Redis command used to get the associated keys (KEYS) is rather expensive and shouldn't be run frequently.

remove

public String remove(@NotNull
                     String key)

Description copied from interface: KeyValueStore

Remove a key from store.

Specified by:

remove in interface KeyValueStore

Parameters:

key - Key to remove

Returns:

The previous value for the key, or null if the key was not set

get

public String get(@NotNull
                  String key)

Description copied from interface: KeyValueStore

Get the value for a key from store.

Specified by:

get in interface KeyValueStore

Parameters:

key - Key to get the value for

Returns:

the value for corresponding key

isHealthy

public boolean isHealthy()

Description copied from interface: KeyValueStore

Get the health status of the store.

Specified by:

isHealthy in interface KeyValueStore

Returns:

true if store is healthy

put

public String put(@NotNull
                  String key,
                  String value)

Description copied from interface: KeyValueStore

Set a value for the key.

Also removes the key if the value is null.

Specified by:

put in interface KeyValueStore

Parameters:

key - Key to set

value - Value to set for the given key

Returns:

The previous value for the key, or null if the key was not set

putAll

public Map<String,String> putAll(@NotNull
                                 Map<String,String> entries)

Description copied from interface: KeyValueStore

Set a multiple key/value pairs.

Removes any keys with a null value.

Specified by:

putAll in interface KeyValueStore

Parameters:

entries - Map of key/value pairs to put

Returns:

The previous values for the keys