org.apache.samza.table

Interface ReadWriteUpdateTable<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 records in this table

All Superinterfaces:

AsyncReadWriteUpdateTable<K,V,U>, Table

All Known Subinterfaces:

ReadWriteTable<K,V>

@InterfaceStability.Unstable
public interface ReadWriteUpdateTable<K,V,U>
extends AsyncReadWriteUpdateTable<K,V,U>

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

Method Summary

Modifier and Type	Method and Description
void	delete(K key, java.lang.Object... args) Deletes the mapping for the specified key from this table (if such mapping exists).
void	deleteAll(java.util.List<K> keys, java.lang.Object... args) Deletes the mappings for the specified keys from this table.
V	get(K key, java.lang.Object... args) Gets the value associated with the specified key.
java.util.Map<K,V>	getAll(java.util.List<K> keys, java.lang.Object... args) Gets the values with which the specified keys are associated.
void	put(K key, V value, java.lang.Object... args) Updates the mapping of the specified key-value pair; Associates the specified key with the specified value.
void	putAll(java.util.List<Entry<K,V>> entries, java.lang.Object... args) Updates the mappings of the specified key-value entries.
default <T> T	read(int opId, java.lang.Object... args) Executes a read operation.
void	update(K key, U update) Updates the record associated with a given key with the specified update.
void	updateAll(java.util.List<Entry<K,U>> updates) Updates the mappings of the given keys with the corresponding updates.
default <T> T	write(int opId, java.lang.Object... args) Executes a write operation.

Methods inherited from interface org.apache.samza.table.AsyncReadWriteUpdateTable

close, deleteAllAsync, deleteAsync, flush, getAllAsync, getAsync, init, putAllAsync, putAsync, readAsync, updateAllAsync, updateAsync, writeAsync

Method Detail

get

V get(K key,
      java.lang.Object... args)

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:

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

Throws:

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

getAll

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

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:

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.

read

default <T> T read(int opId,
                   java.lang.Object... args)

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:

read result

update

void update(K key,
            U update)

Updates the record associated with a given key with the specified update.

Parameters:

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

update - the update to be applied to the record specified by key.

Throws:

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

updateAll

void updateAll(java.util.List<Entry<K,U>> updates)

Updates the mappings of the given keys with the corresponding updates.

Parameters:

updates - the updates for the given keys

Throws:

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

put

void put(K key,
         V value,
         java.lang.Object... args)

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

Throws:

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

putAll

void putAll(java.util.List<Entry<K,V>> entries,
            java.lang.Object... args)

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

Throws:

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

delete

void delete(K key,
            java.lang.Object... args)

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

Throws:

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

deleteAll

void deleteAll(java.util.List<K> keys,
               java.lang.Object... args)

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

Throws:

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

write

default <T> T write(int opId,
                    java.lang.Object... args)

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:

write result