org.apache.samza.table.descriptors

Interface TableProvider

@InterfaceStability.Unstable
public interface TableProvider

A table provider provides the implementation for a table. It ensures a table is properly constructed and also manages its lifecycle.

Method Summary

Modifier and Type	Method and Description
void	close() Shutdown the underlying table
java.util.Map<java.lang.String,java.lang.String>	generateConfig(Config jobConfig, java.util.Map<java.lang.String,java.lang.String> generatedConfig) Generate any configuration for this table, the generated configuration is used by Samza container to construct this table and any components necessary.
Table	getTable() Get an instance of the table for read/write operations
void	init(Context context) Initialize TableProvider with container and task context

Method Detail

init

void init(Context context)

Initialize TableProvider with container and task context

Parameters:

context - context for the task

getTable

Table getTable()

Get an instance of the table for read/write operations

Returns:

the underlying table

generateConfig

java.util.Map<java.lang.String,java.lang.String> generateConfig(Config jobConfig,
                                                                java.util.Map<java.lang.String,java.lang.String> generatedConfig)

Generate any configuration for this table, the generated configuration is used by Samza container to construct this table and any components necessary. Instead of manipulating the input parameters, this method should return the generated configuration.

Parameters:

jobConfig - the job config

generatedConfig - config generated by earlier processing, but has not yet been merged to job config

Returns:

configuration for this table

close

void close()

Shutdown the underlying table