co.cask.hydrator.plugin.db.batch.source

Class DBSource

java.lang.Object

co.cask.cdap.etl.api.batch.BatchConfigurable<co.cask.cdap.etl.api.batch.BatchSourceContext>

co.cask.cdap.etl.api.batch.BatchSource<KEY_IN,VAL_IN,OUT>

co.cask.hydrator.common.ReferenceBatchSource<org.apache.hadoop.io.LongWritable,DBRecord,co.cask.cdap.api.data.format.StructuredRecord>

co.cask.hydrator.plugin.db.batch.source.DBSource

All Implemented Interfaces:

co.cask.cdap.etl.api.Destroyable, co.cask.cdap.etl.api.PipelineConfigurable, co.cask.cdap.etl.api.StageLifecycle<co.cask.cdap.etl.api.batch.BatchRuntimeContext>, co.cask.cdap.etl.api.Transformation<co.cask.cdap.api.dataset.lib.KeyValue<org.apache.hadoop.io.LongWritable,DBRecord>,co.cask.cdap.api.data.format.StructuredRecord>

public class DBSource
extends ReferenceBatchSource<org.apache.hadoop.io.LongWritable,DBRecord,co.cask.cdap.api.data.format.StructuredRecord>

Batch source to read from a DB table

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DBSource.DBSourceConfig PluginConfig for DBSource

Field Summary

Fields inherited from class co.cask.cdap.etl.api.batch.BatchSource

PLUGIN_TYPE

Constructor Summary

Constructors

Constructor and Description
DBSource(DBSource.DBSourceConfig sourceConfig)

Method Summary

Methods

Modifier and Type	Method and Description
void	configurePipeline(co.cask.cdap.etl.api.PipelineConfigurer pipelineConfigurer)
void	destroy()
co.cask.cdap.api.data.schema.Schema	getSchema(co.cask.hydrator.plugin.db.batch.source.DBSource.GetSchemaRequest request, co.cask.cdap.api.plugin.EndpointPluginContext pluginContext) Endpoint method to get the output schema of a query.
void	initialize(co.cask.cdap.etl.api.batch.BatchRuntimeContext context)
void	prepareRun(co.cask.cdap.etl.api.batch.BatchSourceContext context)
void	transform(co.cask.cdap.api.dataset.lib.KeyValue<org.apache.hadoop.io.LongWritable,DBRecord> input, co.cask.cdap.etl.api.Emitter<co.cask.cdap.api.data.format.StructuredRecord> emitter)

Methods inherited from class co.cask.cdap.etl.api.batch.BatchConfigurable

onRunFinish

Methods inherited from class java.lang.Object

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

Constructor Detail

DBSource

public DBSource(DBSource.DBSourceConfig sourceConfig)

Method Detail

configurePipeline

public void configurePipeline(co.cask.cdap.etl.api.PipelineConfigurer pipelineConfigurer)

Specified by:

configurePipeline in interface co.cask.cdap.etl.api.PipelineConfigurable

Overrides:

configurePipeline in class ReferenceBatchSource<org.apache.hadoop.io.LongWritable,DBRecord,co.cask.cdap.api.data.format.StructuredRecord>

getSchema

@Path(value="getSchema")
public co.cask.cdap.api.data.schema.Schema getSchema(co.cask.hydrator.plugin.db.batch.source.DBSource.GetSchemaRequest request,
                                                 co.cask.cdap.api.plugin.EndpointPluginContext pluginContext)
                                              throws IllegalAccessException,
                                                     SQLException,
                                                     InstantiationException

Endpoint method to get the output schema of a query.

Parameters:

request - GetSchemaRequest containing information required for connection and query to execute.

pluginContext - context to create plugins

Returns:

schema of fields

Throws:

SQLException

InstantiationException

IllegalAccessException

prepareRun

public void prepareRun(co.cask.cdap.etl.api.batch.BatchSourceContext context)
                throws Exception

Specified by:

prepareRun in class co.cask.cdap.etl.api.batch.BatchConfigurable<co.cask.cdap.etl.api.batch.BatchSourceContext>

Throws:

Exception

initialize

public void initialize(co.cask.cdap.etl.api.batch.BatchRuntimeContext context)
                throws Exception

Specified by:

initialize in interface co.cask.cdap.etl.api.StageLifecycle<co.cask.cdap.etl.api.batch.BatchRuntimeContext>

Overrides:

initialize in class co.cask.cdap.etl.api.batch.BatchSource<org.apache.hadoop.io.LongWritable,DBRecord,co.cask.cdap.api.data.format.StructuredRecord>

Throws:

Exception

transform

public void transform(co.cask.cdap.api.dataset.lib.KeyValue<org.apache.hadoop.io.LongWritable,DBRecord> input,
             co.cask.cdap.etl.api.Emitter<co.cask.cdap.api.data.format.StructuredRecord> emitter)
               throws Exception

Specified by:

transform in interface co.cask.cdap.etl.api.Transformation<co.cask.cdap.api.dataset.lib.KeyValue<org.apache.hadoop.io.LongWritable,DBRecord>,co.cask.cdap.api.data.format.StructuredRecord>

Overrides:

transform in class co.cask.cdap.etl.api.batch.BatchSource<org.apache.hadoop.io.LongWritable,DBRecord,co.cask.cdap.api.data.format.StructuredRecord>

Throws:

Exception

destroy

public void destroy()

Specified by:

destroy in interface co.cask.cdap.etl.api.Destroyable

Overrides:

destroy in class co.cask.cdap.etl.api.batch.BatchSource<org.apache.hadoop.io.LongWritable,DBRecord,co.cask.cdap.api.data.format.StructuredRecord>