jakarta.nosql.keyvalue

Interface BucketManager

All Superinterfaces:

AutoCloseable

public interface BucketManager
extends AutoCloseable

Interface used to interact with the persistence context to KeyValueEntity The BucketManager API is used to create and remove persistent KeyValueEntity.

Method Summary

Modifier and Type	Method and Description
void	close() closes a resource
<K> void	delete(Iterable<K> keys) Removes entities from keys
<K> void	delete(K key) Removes an entity from key
<K> Iterable<Value>	get(Iterable<K> keys) Finds a list of values from keys
<K> Optional<Value>	get(K key) Finds the Value from a key
default KeyValuePreparedStatement	prepare(String query) Executes a query and returns the result, when the operations are put, remove and get command it will return the result of the operation when the command is either remove or put it will return an empty collection.
void	put(Iterable<KeyValueEntity> entities) Saves the Iterable of keys
void	put(Iterable<KeyValueEntity> entities, Duration ttl) Saves the Iterable of keys with a defined time to live
void	put(KeyValueEntity entity) Saves the KeyValueEntity
void	put(KeyValueEntity entity, Duration ttl) Saves the KeyValueEntity with time to live
<K,V> void	put(K key, V value) Associates the specified value with the specified key and than storage
default Stream<Value>	query(String query) Executes a query and returns the result, when the operations are put, remove and get command it will return the result of the operation when the command is remove or put it will return an empty collection.

Method Detail

put

<K,V> void put(K key,
               V value)

Associates the specified value with the specified key and than storage

Type Parameters:

K - the key type

V - the value type

Parameters:

key - the key

value - the value

Throws:

NullPointerException - when either key or value are null

put

void put(KeyValueEntity entity)

Saves the KeyValueEntity

Parameters:

entity - the entity to be insert

Throws:

NullPointerException - when entity is null

put

void put(KeyValueEntity entity,
         Duration ttl)

Saves the KeyValueEntity with time to live

Parameters:

entity - the entity to be insert

ttl - the defined time to live

Throws:

NullPointerException - when entity is null

UnsupportedOperationException - when expired time is not supported

put

void put(Iterable<KeyValueEntity> entities)

Saves the Iterable of keys

Parameters:

entities - keys to be insert

Throws:

NullPointerException - when the iterable is null

put

void put(Iterable<KeyValueEntity> entities,
         Duration ttl)

Saves the Iterable of keys with a defined time to live

Parameters:

entities - keys to be insert

ttl - the time to entity expire

Throws:

NullPointerException - when the iterable is null

UnsupportedOperationException - when expired time is not supported

get

<K> Optional<Value> get(K key)

Finds the Value from a key

Type Parameters:

K - the key type

Parameters:

key - the key

Returns:

the Optional when is not found will return a Optional.empty()

Throws:

NullPointerException - when the key is null

get

<K> Iterable<Value> get(Iterable<K> keys)

Finds a list of values from keys

Type Parameters:

K - the key type

Parameters:

keys - the keys to be used in this query

Returns:

the list of result

Throws:

NullPointerException - when either the keys or the entities values are null

delete

<K> void delete(K key)

Removes an entity from key

Type Parameters:

K - the key type

Parameters:

key - the key bo be used

Throws:

NullPointerException - when the key is null

delete

<K> void delete(Iterable<K> keys)

Removes entities from keys

Type Parameters:

K - the key type

Parameters:

keys - the keys to be used

Throws:

NullPointerException - when the key is null

query

default Stream<Value> query(String query)

Executes a query and returns the result, when the operations are put, remove and get command it will return the result of the operation when the command is remove or put it will return an empty collection.

Parameters:

query - the query as String

Returns:

the result of the operation if delete it will always return an empty list

Throws:

NullPointerException - when there is parameter null

IllegalArgumentException - when the query has value parameters

IllegalStateException - when there is not KeyValueQueryParser

QueryException - when there is error in the syntax

prepare

default KeyValuePreparedStatement prepare(String query)

Executes a query and returns the result, when the operations are put, remove and get command it will return the result of the operation when the command is either remove or put it will return an empty collection.

Parameters:

query - the query as String

Returns:

a KeyValuePreparedStatement instance

Throws:

NullPointerException - when there is parameter null

IllegalStateException - when there is not KeyValuePreparedStatement

QueryException - when there is error in the syntax

close

void close()

closes a resource

Specified by:

close in interface AutoCloseable