org.nuxeo.runtime.kv

Interface KeyValueStoreProvider

All Superinterfaces:

KeyValueStore

All Known Implementing Classes:

AbstractKeyValueStoreProvider, MemKeyValueStore, MongoDBKeyValueStore, RedisKeyValueStore

public interface KeyValueStoreProvider
extends KeyValueStore

Key/Value Store SPI.

Since:

9.1

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the content of this Key/Value store provider.
void	close() Closes this Key/Value store provider.
void	initialize(KeyValueStoreDescriptor descriptor) Initializes this Key/Value store provider.
Stream<String>	keyStream() Returns a Stream of the keys contained in this Key/Value store provider.
Stream<String>	keyStream(String prefix) Returns a Stream of the keys with the given prefix contained in this Key/Value store provider.

Methods inherited from interface org.nuxeo.runtime.kv.KeyValueStore

addAndGet, compareAndSet, compareAndSet, compareAndSet, compareAndSet, get, get, getLong, getLongs, getString, getStrings, put, put, put, put, put, put, setTTL

Method Detail

initialize

void initialize(KeyValueStoreDescriptor descriptor)

Initializes this Key/Value store provider.

Parameters:

descriptor - the store provider descriptor

keyStream

Stream<String> keyStream()

Returns a Stream of the keys contained in this Key/Value store provider.

This operation may be slow and should only be used for management or debug purposes.

Returns:

the stream of keys

Since:

9.3

keyStream

Stream<String> keyStream(String prefix)

Returns a Stream of the keys with the given prefix contained in this Key/Value store provider.

This operation may be slow and should only be used for management or debug purposes.

Returns:

the stream of keys

Since:

10.3

close

void close()

Closes this Key/Value store provider.

clear

void clear()

Clears the content of this Key/Value store provider.