io.cdap.delta.api

Interface DeltaSource

All Superinterfaces:

TableAssessorSupplier<TableDetail>

public interface DeltaSource
extends TableAssessorSupplier<TableDetail>

Pluggable interface for reading change events

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_TYPE

Method Summary

Modifier and Type	Method and Description
void	configure(Configurer configurer) Configure the source.
EventReader	createReader(EventReaderDefinition definition, DeltaSourceContext context, EventEmitter eventEmitter) Create an event reader used to read change events.
TableRegistry	createTableRegistry(Configurer configurer) Create a table registry that is used to fetch information about tables in databases.

Methods inherited from interface io.cdap.delta.api.assessment.TableAssessorSupplier

createTableAssessor

Field Detail

PLUGIN_TYPE

static final String PLUGIN_TYPE

See Also:

Constant Field Values

Method Detail

configure

void configure(Configurer configurer)

Configure the source. This is called when the application is deployed.

Parameters:

configurer - configurer used to set configuration settings and register plugins

createReader

EventReader createReader(EventReaderDefinition definition,
                         DeltaSourceContext context,
                         EventEmitter eventEmitter)
                  throws Exception

Create an event reader used to read change events. This is called after the application is deployed, whenever the program is started. If an exception is thrown, the pipeline run will fail.

Parameters:

definition - defines what type of information the reader should read

context - program context

eventEmitter - emits events that need to be replicated

Returns:

an event reader used to read change events

Throws:

Exception - if there was an error creating the event reader

createTableRegistry

TableRegistry createTableRegistry(Configurer configurer)
                           throws Exception

Create a table registry that is used to fetch information about tables in databases. This is called when the pipeline is being configured, before it is deployed.

Parameters:

configurer - configurer used to instantiate plugins

Returns:

table registry used to fetch information about tables in databases.

Throws:

Exception - if there was an error creating the table registry