io.cdap.delta.app.service

Class Assessor

java.lang.Object

io.cdap.delta.app.service.Assessor

public class Assessor
extends Object

Handles logic around assessment of delta config.

Constructor Summary

Constructors

Constructor and Description
Assessor()

Method Summary

Modifier and Type	Method and Description
PipelineAssessment	assessPipeline(String namespace, DeltaConfig deltaConfig, Configurer configurer) Assess the entire pipeline based on the tables the source will read and the capabilities of the target.
TableAssessmentResponse	assessTable(String namespace, DeltaConfig deltaConfig, Configurer configurer, DBTable dbTable) Assess the given table detail using the plugins from the given Delta Config.
TableDetail	describeTable(String namespace, DeltaConfig config, Configurer configurer, DBTable dbTable) Describe the given database table using the source from the given delta config.
TableList	listTables(String namespace, DeltaConfig config, Configurer configurer) List the database tables readable by the source in the given delta config.

Methods inherited from class java.lang.Object

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

Constructor Detail

Assessor

public Assessor()

Method Detail

listTables

public TableList listTables(String namespace,
                            DeltaConfig config,
                            Configurer configurer)
                     throws Exception

List the database tables readable by the source in the given delta config. An instance of the plugin will be instantiated in order to generate this list. This is an expensive operation.

If the plugin cannot be instantiated, or if the table list cannot be generated due to missing information in the draft, an InvalidDraftException will be thrown.

Parameters:

namespace - namespace

config - DeltaConfig

configurer - configurer used to instantiate plugins

Returns:

list of tables readable by the source in the draft

Throws:

DraftNotFoundException - if the draft does not exist

InvalidDraftException - if the table list cannot be fetched because the delta config is invalid

IOException - if the was an IO error fetching the table list

Exception - if there was an error creating the table registry

describeTable

public TableDetail describeTable(String namespace,
                                 DeltaConfig config,
                                 Configurer configurer,
                                 DBTable dbTable)
                          throws Exception

Describe the given database table using the source from the given delta config. An instance of the plugin will be instantiated in order to generate this list. This is an expensive operation.

If the plugin cannot be instantiated, or if the table cannot be described to missing information in the draft, an InvalidDraftException will be thrown.

Parameters:

namespace - namespace

config - DeltaConfig

configurer - configurer used to instantiate plugins

dbTable - the dbTable

Returns:

list of tables readable by the source in the draft

Throws:

DraftNotFoundException - if the draft does not exist

InvalidDraftException - if the table list cannot be fetched because the deltaconfig is invalid

TableNotFoundException - if the table does not exist

IOException - if the was an IO error fetching the table detail

Exception - if there was an error creating the table registry

assessTable

public TableAssessmentResponse assessTable(String namespace,
                                           DeltaConfig deltaConfig,
                                           Configurer configurer,
                                           DBTable dbTable)
                                    throws Exception

Assess the given table detail using the plugins from the given Delta Config. Plugins will be instantiated in order to generate this assessment. This is an expensive operation.

Parameters:

namespace - namespace to look for macros

deltaConfig - : delta config to assess

dbTable - : the selected table to assess

configurer - configurer used to instantiate plugins

Returns:

list of tables readable by the source in the draft

Throws:

IOException - if the table detail could not be read

Exception - if there was an error creating the table registry

IllegalArgumentException - if the number of tables is not equal to one.

assessPipeline

public PipelineAssessment assessPipeline(String namespace,
                                         DeltaConfig deltaConfig,
                                         Configurer configurer)
                                  throws Exception

Assess the entire pipeline based on the tables the source will read and the capabilities of the target. An instance of the target plugin will be instantiated in order to generate this list. This is an expensive operation.

If the plugin cannot be instantiated due to missing properties in delta config, an InvalidDraftException will be thrown.

Parameters:

namespace - id of the draft

deltaConfig - : delta config object to assess

configurer - configurer used to instantiate plugins

Returns:

list of tables readable by the source in the draft

Throws:

DraftNotFoundException - if the draft does not exist

InvalidDraftException - if the table list cannot be fetched because the draft is invalid

IOException - if there was an IO error getting the list of source tables

Exception - if there was an error creating the table registry