io.cdap.cdap.etl.api.engine.sql

Class BatchSQLEngine<KEY_IN,VALUE_IN,KEY_OUT,VALUE_OUT>

java.lang.Object

io.cdap.cdap.etl.api.engine.sql.BatchSQLEngine<KEY_IN,VALUE_IN,KEY_OUT,VALUE_OUT>

Type Parameters:

KEY_IN -

VALUE_IN -

KEY_OUT -

VALUE_OUT -

All Implemented Interfaces:

SQLEngine<KEY_IN,VALUE_IN,KEY_OUT,VALUE_OUT>, PipelineConfigurable, SubmitterLifecycle<RuntimeContext>

public abstract class BatchSQLEngine<KEY_IN,VALUE_IN,KEY_OUT,VALUE_OUT>
extends Object
implements SQLEngine<KEY_IN,VALUE_IN,KEY_OUT,VALUE_OUT>

Base implementation for the SQLEngine interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_TYPE

Constructor Summary

Constructors

Constructor and Description
BatchSQLEngine()

Method Summary

Modifier and Type	Method and Description
void	configurePipeline(PipelineConfigurer pipelineConfigurer) Configure an ETL pipeline, registering datasets and plugins that the stage needs.
void	onRunFinish(boolean succeeded, RuntimeContext context) Invoked after the run finishes.
void	prepareRun(RuntimeContext context) Prepare the run.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.cdap.cdap.etl.api.engine.sql.SQLEngine

canJoin, cleanup, exists, getPullProvider, getPushProvider, join

Field Detail

PLUGIN_TYPE

public static final String PLUGIN_TYPE

See Also:

Constant Field Values

Constructor Detail

BatchSQLEngine

public BatchSQLEngine()

Method Detail

configurePipeline

public void configurePipeline(PipelineConfigurer pipelineConfigurer)

Description copied from interface: PipelineConfigurable

Configure an ETL pipeline, registering datasets and plugins that the stage needs. Validation should be performed in this method, throwing a ValidationException if there are any invalid config properties, or if the input or output schema is not compatible. Output schema should also be set. This method is called many times during the lifecycle of a pipeline so it should not generate any side effects. When the pipeline is being constructed, this is called in order to validate the pipeline and propagate schema. Any datasets registered at this time will be ignored. Config properties that contain macros will not have been evaluated yet. When the pipeline is deployed, this is called in order to validate the pipeline and create any datasets that are registered. Config properties that contain macros will not have been evaluated yet.

Specified by:

configurePipeline in interface PipelineConfigurable

Parameters:

pipelineConfigurer - the configurer used to register required datasets and plugins

prepareRun

public void prepareRun(RuntimeContext context)
                throws Exception

Description copied from interface: SubmitterLifecycle

Prepare the run. Used to configure the job before starting the run.

Specified by:

prepareRun in interface SubmitterLifecycle<RuntimeContext>

Parameters:

context - submitter context

Throws:

Exception - if there's an error during this method invocation

onRunFinish

public void onRunFinish(boolean succeeded,
                        RuntimeContext context)

Description copied from interface: SubmitterLifecycle

Invoked after the run finishes. Used to perform any end of the run logic.

Specified by:

onRunFinish in interface SubmitterLifecycle<RuntimeContext>

Parameters:

succeeded - defines the result of batch execution: true if run succeeded, false otherwise

context - submitter context