org.apache.samza.table.remote

Interface TableWriteFunction<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

All Superinterfaces:

ClosableFunction, java.io.Serializable, TableFunction, TablePart

@InterfaceStability.Unstable
public interface TableWriteFunction<K,V,U>
extends TableFunction

A function object to be used with a remote read/write table implementation. It encapsulates the functionality of writing table record(s) for a provided set of key(s) to the store.

Instances of TableWriteFunction are meant to be serializable. ie. any non-serializable state (eg: network sockets) should be marked as transient and recreated inside readObject().

Implementations are expected to be thread-safe.

Method Summary

Modifier and Type	Method and Description
default void	delete(K key) Delete the record with specified key from the remote store.
default void	deleteAll(java.util.Collection<K> keys) Delete all records with the specified keys from the remote store The default implementation calls deleteAllAsync and blocks on the completion afterwards.
default java.util.concurrent.CompletableFuture<java.lang.Void>	deleteAllAsync(java.util.Collection<K> keys) Asynchronously delete all records with the specified keys from the remote store.
default java.util.concurrent.CompletableFuture<java.lang.Void>	deleteAllAsync(java.util.Collection<K> keys, java.lang.Object... args) Asynchronously delete all records with the specified keys and additional arguments from the remote store.
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteAsync(K key) Asynchronously delete the record with specified key from the remote store
default java.util.concurrent.CompletableFuture<java.lang.Void>	deleteAsync(K key, java.lang.Object... args) Asynchronously delete the record with specified key and additional arguments from the remote store
default void	flush() Flush the remote store (optional)
default void	put(K key, V record) Store single table record with specified key.
default void	putAll(java.util.List<Entry<K,V>> records) Store the table records with specified keys.
default java.util.concurrent.CompletableFuture<java.lang.Void>	putAllAsync(java.util.Collection<Entry<K,V>> records) Asynchronously store the table records with specified keys.
default java.util.concurrent.CompletableFuture<java.lang.Void>	putAllAsync(java.util.Collection<Entry<K,V>> records, java.lang.Object... args) Asynchronously store the table records with specified keys and additional arguments.
java.util.concurrent.CompletableFuture<java.lang.Void>	putAsync(K key, V record) Asynchronously store single table record with specified key.
default java.util.concurrent.CompletableFuture<java.lang.Void>	putAsync(K key, V record, java.lang.Object... args) Asynchronously store single table record with specified key and additional arguments.
default java.util.concurrent.CompletableFuture<java.lang.Void>	updateAllAsync(java.util.Collection<Entry<K,U>> updates) Asynchronously updates the table with multiple updates.
java.util.concurrent.CompletableFuture<java.lang.Void>	updateAsync(K key, U update) Asynchronously update the resource for a given key with the update.
default <T> java.util.concurrent.CompletableFuture<T>	writeAsync(int opId, java.lang.Object... args) Asynchronously write data to table for specified opId and additional arguments.

Methods inherited from interface org.apache.samza.table.remote.TableFunction

init, isRetriable

Methods inherited from interface org.apache.samza.table.remote.TablePart

toConfig

Methods inherited from interface org.apache.samza.operators.functions.ClosableFunction

close

Method Detail

put

default void put(K key,
                 V record)

Store single table record with specified key. This method must be thread-safe. The default implementation calls putAsync and blocks on the completion afterwards.

Parameters:

key - key for the table record

record - table record to be written

putAsync

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

Asynchronously store single table record with specified key. This method must be thread-safe.

Parameters:

key - key for the table record

record - table record to be written

Returns:

CompletableFuture for the put request

putAsync

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

Asynchronously store single table record with specified key and additional arguments. This method must be thread-safe.

Parameters:

key - key for the table record

record - table record to be written

args - additional arguments

Returns:

CompletableFuture for the put request

putAll

default void putAll(java.util.List<Entry<K,V>> records)

Store the table records with specified keys. This method must be thread-safe. The default implementation calls putAllAsync and blocks on the completion afterwards.

Parameters:

records - table records to be written

putAllAsync

default java.util.concurrent.CompletableFuture<java.lang.Void> putAllAsync(java.util.Collection<Entry<K,V>> records)

Asynchronously store the table records with specified keys. This method must be thread-safe. The default implementation calls putAsync for each entry and return a combined future.

Parameters:

records - table records to be written

Returns:

CompletableFuture for the put request

putAllAsync

default java.util.concurrent.CompletableFuture<java.lang.Void> putAllAsync(java.util.Collection<Entry<K,V>> records,
                                                                           java.lang.Object... args)

Asynchronously store the table records with specified keys and additional arguments. This method must be thread-safe.

Parameters:

records - table records to be written

args - additional arguments

Returns:

CompletableFuture for the put request

updateAsync

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

Asynchronously update the resource for a given key with the update. This method must be thread-safe. If the update operation failed due to the update being applied to a non-existent resource, the update implementation can return a future completed exceptionally with a RecordNotFoundException. This will allow the MessageStream.sendTo(Table, org.apache.samza.operators.UpdateOptions)} to Put a default resource, if one is provided in the UpdateMessage.

Parameters:

key - key for the table record

update - update record for the given key

Returns:

CompletableFuture for the update request

updateAllAsync

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

Asynchronously updates the table with multiple updates. This method must be thread-safe. The default implementation calls updateAsync for each entry and return a combined future.

Parameters:

updates - updates for the table

Returns:

CompletableFuture for the update request

delete

default void delete(K key)

Delete the record with specified key from the remote store. The default implementation calls deleteAsync and blocks on the completion afterwards.

Parameters:

key - key to the table record to be deleted

deleteAsync

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

Asynchronously delete the record with specified key from the remote store

Parameters:

key - key to the table record to be deleted

Returns:

CompletableFuture for the delete request

deleteAsync

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

Asynchronously delete the record with specified key and additional arguments from the remote store

Parameters:

key - key to the table record to be deleted

args - additional arguments

Returns:

CompletableFuture for the delete request

deleteAll

default void deleteAll(java.util.Collection<K> keys)

Delete all records with the specified keys from the remote store The default implementation calls deleteAllAsync and blocks on the completion afterwards.

Parameters:

keys - keys for the table records to be written

deleteAllAsync

default java.util.concurrent.CompletableFuture<java.lang.Void> deleteAllAsync(java.util.Collection<K> keys)

Asynchronously delete all records with the specified keys from the remote store. The default implementation calls deleteAsync for each key and return a combined future.

Parameters:

keys - keys for the table records to be written

Returns:

CompletableFuture for the deleteAll request

deleteAllAsync

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

Asynchronously delete all records with the specified keys and additional arguments from the remote store.

Parameters:

keys - keys for the table records to be written

args - additional arguments

Returns:

CompletableFuture for the deleteAll request

writeAsync

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

Asynchronously write data to table for specified opId and additional arguments. This method must be thread-safe.

Type Parameters:

T - return type

Parameters:

opId - operation identifier

args - additional arguments

Returns:

CompletableFuture for the write request

flush

default void flush()

Flush the remote store (optional)