org.apache.samza.table

Interface ReadableTable<K,V>

Type Parameters:

K - the type of the record key in this table

V - the type of the record value in this table

All Superinterfaces:

Table<KV<K,V>>

All Known Subinterfaces:

ReadWriteTable<K,V>

@InterfaceStability.Unstable
public interface ReadableTable<K,V>
extends Table<KV<K,V>>

A table that supports get by one or more keys

Method Summary

Modifier and Type	Method and Description
void	close() Close the table and release any resources acquired
V	get(K key) Gets the value associated with the specified key.
java.util.Map<K,V>	getAll(java.util.List<K> keys) Gets the values with which the specified keys are associated.
java.util.concurrent.CompletableFuture<java.util.Map<K,V>>	getAllAsync(java.util.List<K> keys) Asynchronously gets the values with which the specified keys are associated.
java.util.concurrent.CompletableFuture<V>	getAsync(K key) Asynchronously gets the value associated with the specified key.
default void	init(Context context) Initializes the table during container initialization.

Method Detail

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

get

V get(K key)

Gets the value associated with the specified key.

Parameters:

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

Returns:

if found, the value associated with the specified key; otherwise, null.

Throws:

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

getAsync

java.util.concurrent.CompletableFuture<V> getAsync(K key)

Asynchronously gets the value associated with the specified key.

Parameters:

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

Returns:

completableFuture for the requested value

Throws:

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

getAll

java.util.Map<K,V> getAll(java.util.List<K> keys)

Gets the values with which the specified keys are associated.

Parameters:

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

Returns:

a map of the keys that were found and their respective values.

Throws:

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

getAllAsync

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

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

Parameters:

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

Returns:

completableFuture for the requested entries

Throws:

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

close

void close()

Close the table and release any resources acquired