org.apache.samza.operators

Interface TableDescriptor<K,V,D extends TableDescriptor<K,V,D>>

Type Parameters:

K - the type of the key in this table

V - the type of the value in this table

D - the type of the concrete table descriptor

@InterfaceStability.Unstable
public interface TableDescriptor<K,V,D extends TableDescriptor<K,V,D>>

User facing class to collect metadata that fully describes a Samza table. This interface should be implemented by concrete table implementations.

Typical user code should look like the following, notice withConfig() is defined in this class and the rest in subclasses.

 
 TableDescriptor<Integer, String, ?> tableDesc = new RocksDbTableDescriptor("tbl")
     .withSerde(KVSerde.of(new IntegerSerde(), new StringSerde("UTF-8")))
     .withBlockSize(1024)
     .withConfig("some-key", "some-value");
 
 

Once constructed, a table descriptor can be registered with the system. Internally, the table descriptor is then converted to a TableSpec, which is used to track tables internally.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTableId() Get the Id of the table
D	withConfig(java.lang.String key, java.lang.String value) Add a configuration entry for the table
D	withSerde(KVSerde<K,V> serde) Set the Serde for this table

Method Detail

getTableId

java.lang.String getTableId()

Get the Id of the table

Returns:

Id of the table

withSerde

D withSerde(KVSerde<K,V> serde)

Set the Serde for this table

Parameters:

serde - the serde

Returns:

this table descriptor instance

Throws:

java.lang.IllegalArgumentException - if null is provided

withConfig

D withConfig(java.lang.String key,
             java.lang.String value)

Add a configuration entry for the table

Parameters:

key - the key

value - the value

Returns:

this table descriptor instance