org.apache.samza.table

Interface AsyncReadWriteUpdateTable<K,V,U>

Type Parameters:

K - the type of the key in this table

V - the type of the value in this table

U - the type of the update applied to this table

All Superinterfaces:

Table

All Known Subinterfaces:

ReadWriteTable<K,V>, ReadWriteUpdateTable<K,V,U>

public interface AsyncReadWriteUpdateTable<K,V,U>
extends Table

A table that supports asynchronous get, put, update and delete by one or more keys

Method Summary

Modifier and Type	Method and Description
void	close() Close the table and release any resources acquired
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteAllAsync(java.util.List<K> keys, java.lang.Object... args) Asynchronously deletes the mappings for the specified keys from this table.
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteAsync(K key, java.lang.Object... args) Asynchronously deletes the mapping for the specified key from this table (if such mapping exists).
void	flush() Flushes the underlying store of this table, if applicable.
java.util.concurrent.CompletableFuture<java.util.Map<K,V>>	getAllAsync(java.util.List<K> keys, java.lang.Object... args) Asynchronously gets the values with which the specified keys are associated.
java.util.concurrent.CompletableFuture<V>	getAsync(K key, java.lang.Object... args) Asynchronously gets the value associated with the specified key.
default void	init(Context context) Initializes the table during container initialization.
java.util.concurrent.CompletableFuture<java.lang.Void>	putAllAsync(java.util.List<Entry<K,V>> entries, java.lang.Object... args) Asynchronously updates the mappings of the specified key-value entries.
java.util.concurrent.CompletableFuture<java.lang.Void>	putAsync(K key, V value, java.lang.Object... args) Asynchronously updates the mapping of the specified key-value pair; Associates the specified key with the specified value.
default <T> java.util.concurrent.CompletableFuture<T>	readAsync(int opId, java.lang.Object... args) Asynchronously executes a read operation.
java.util.concurrent.CompletableFuture<java.lang.Void>	updateAllAsync(java.util.List<Entry<K,U>> updates) Asynchronously updates the existing records for the given keys with their corresponding updates.
java.util.concurrent.CompletableFuture<java.lang.Void>	updateAsync(K key, U update) Asynchronously updates an existing record for a given key with the specified update.
default <T> java.util.concurrent.CompletableFuture<T>	writeAsync(int opId, java.lang.Object... args) Asynchronously executes a write operation.

Method Detail

getAsync

java.util.concurrent.CompletableFuture<V> getAsync(K key,
                                                   java.lang.Object... args)

Asynchronously gets the value associated with the specified key.

Parameters:

key - the key with which the associated value is to be fetched.

args - additional arguments

Returns:

completableFuture for the requested value

Throws:

java.lang.NullPointerException - if the specified key is null.

getAllAsync

java.util.concurrent.CompletableFuture<java.util.Map<K,V>> getAllAsync(java.util.List<K> keys,
                                                                       java.lang.Object... args)

Asynchronously gets the values with which the specified keys are associated.

Parameters:

keys - the keys with which the associated values are to be fetched.

args - additional arguments

Returns:

completableFuture for the requested entries

Throws:

java.lang.NullPointerException - if the specified keys list, or any of the keys, is null.

readAsync

default <T> java.util.concurrent.CompletableFuture<T> readAsync(int opId,
                                                                java.lang.Object... args)

Asynchronously executes a read operation. opId is used to allow tracking of different types of operation.

Type Parameters:

T - return type

Parameters:

opId - operation identifier

args - additional arguments

Returns:

completableFuture for read result

putAsync

java.util.concurrent.CompletableFuture<java.lang.Void> putAsync(K key,
                                                                V value,
                                                                java.lang.Object... args)

Asynchronously updates the mapping of the specified key-value pair; Associates the specified key with the specified value. The key is deleted from the table if value is null.

Parameters:

key - the key with which the specified value is to be associated.

value - the value with which the specified key is to be associated.

args - additional arguments

Returns:

CompletableFuture for the operation

Throws:

java.lang.NullPointerException - if the specified key is null.

putAllAsync

java.util.concurrent.CompletableFuture<java.lang.Void> putAllAsync(java.util.List<Entry<K,V>> entries,
                                                                   java.lang.Object... args)

Asynchronously updates the mappings of the specified key-value entries. A key is deleted from the table if its corresponding value is null.

Parameters:

entries - the updated mappings to put into this table.

args - additional arguments

Returns:

CompletableFuture for the operation

Throws:

java.lang.NullPointerException - if any of the specified entries has null as key.

updateAsync

java.util.concurrent.CompletableFuture<java.lang.Void> updateAsync(K key,
                                                                   U update)

Asynchronously updates an existing record for a given key with the specified update.

Parameters:

key - the key with which the specified value is to be associated.

update - the update applied to the record associated with a given key.

Returns:

CompletableFuture for the operation

Throws:

java.lang.NullPointerException - if the specified key is null.

updateAllAsync

java.util.concurrent.CompletableFuture<java.lang.Void> updateAllAsync(java.util.List<Entry<K,U>> updates)

Asynchronously updates the existing records for the given keys with their corresponding updates.

Parameters:

updates - the key and update mappings.

Returns:

CompletableFuture for the operation

Throws:

java.lang.NullPointerException - if any of the specified entries has null as key.

deleteAsync

java.util.concurrent.CompletableFuture<java.lang.Void> deleteAsync(K key,
                                                                   java.lang.Object... args)

Asynchronously deletes the mapping for the specified key from this table (if such mapping exists).

Parameters:

key - the key for which the mapping is to be deleted.

args - additional arguments

Returns:

CompletableFuture for the operation

Throws:

java.lang.NullPointerException - if the specified key is null.

deleteAllAsync

java.util.concurrent.CompletableFuture<java.lang.Void> deleteAllAsync(java.util.List<K> keys,
                                                                      java.lang.Object... args)

Asynchronously deletes the mappings for the specified keys from this table.

Parameters:

keys - the keys for which the mappings are to be deleted.

args - additional arguments

Returns:

CompletableFuture for the operation

Throws:

java.lang.NullPointerException - if the specified keys list, or any of the keys, is null.

writeAsync

default <T> java.util.concurrent.CompletableFuture<T> writeAsync(int opId,
                                                                 java.lang.Object... args)

Asynchronously executes a write operation. opId is used to allow tracking of different types of operation.

Type Parameters:

T - return type

Parameters:

opId - operation identifier

args - additional arguments

Returns:

completableFuture for write result

init

default void init(Context context)

Initializes the table during container initialization. Guaranteed to be invoked as the first operation on the table.

Parameters:

context - Context corresponding to this table

flush

void flush()

Flushes the underlying store of this table, if applicable.

close

void close()

Close the table and release any resources acquired