io.cdap.delta.store

Class DraftService

java.lang.Object

io.cdap.delta.store.DraftService

public class DraftService
extends Object

Handles logic around storage, retrieval, and assessment of drafts.

Constructor Summary

Constructors

Constructor and Description
DraftService(io.cdap.cdap.spi.data.transaction.TransactionRunner transactionRunner, PropertyEvaluator propertyEvaluator)

Method Summary

Modifier and Type	Method and Description
PipelineAssessment	assessPipeline(DraftId draftId, Configurer configurer) Assess the entire pipeline based on the tables the source will read and the capabilities of the target.
PipelineAssessment	assessPipeline(Namespace 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(DraftId draftId, Configurer configurer, DBTable dbTable) Assess the given table detail using the plugins from the given draft.
TableAssessmentResponse	assessTable(Namespace namespace, DeltaConfig deltaConfig, Configurer configurer, DBTable dbTable) Assess the given table detail using the plugins from the given Delta Config.
void	deleteDraft(DraftId draftId) Delete the given draft.
TableDetail	describeDraftTable(DraftId draftId, Configurer configurer, String database, String schema, String table) Describe the given database table using the source from the given draft id.
Draft	getDraft(DraftId draftId) Get the draft for the given id, or throw an exception if it does not exist.
List<Draft>	listDrafts(Namespace namespace) List all drafts in the given namespace.
TableList	listDraftTables(DraftId draftId, Configurer configurer) List the database tables readable by the source in the given draft id.
void	saveDraft(DraftId draftId, DraftRequest draft) Store the contents of a pipeline config as a draft.

Methods inherited from class java.lang.Object

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

Constructor Detail

DraftService

public DraftService(io.cdap.cdap.spi.data.transaction.TransactionRunner transactionRunner,
                    PropertyEvaluator propertyEvaluator)

Method Detail

listDrafts

public List<Draft> listDrafts(Namespace namespace)

List all drafts in the given namespace. If no drafts exist, an empty list is returned.

Parameters:

namespace - namespace to list drafts in

Returns:

list of drafts in the namespace

getDraft

public Draft getDraft(DraftId draftId)

Get the draft for the given id, or throw an exception if it does not exist.

Parameters:

draftId - the id of the draft

Returns:

draft information

Throws:

DraftNotFoundException - if the draft does not exist

saveDraft

public void saveDraft(DraftId draftId,
                      DraftRequest draft)

Store the contents of a pipeline config as a draft. If a draft already exists, it's modified time is updated and the config is overwritten. If none exists, a new draft is created. Throws an InvalidDraftException if the given DeltaConfig is invalid.

Parameters:

draftId - if of the draft to save

draft - draft to save

Throws:

InvalidDraftException - if the draft is invalid

deleteDraft

public void deleteDraft(DraftId draftId)

Delete the given draft.

Parameters:

draftId - id of the draft to delete

listDraftTables

public TableList listDraftTables(DraftId draftId,
                                 Configurer configurer)
                          throws Exception

List the database tables readable by the source in the given draft id. 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:

draftId - id of the draft

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 the was an IO error fetching the table list

Exception - if there was an error creating the table registry

describeDraftTable

public TableDetail describeDraftTable(DraftId draftId,
                                      Configurer configurer,
                                      String database,
                                      @Nullable
                                      String schema,
                                      String table)
                               throws Exception

Describe the given database table using the source from the given draft id. 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:

draftId - id of the draft

configurer - configurer used to instantiate plugins

database - the table database

schema - the table schema, only required for some databases (e.g. Oracle)

table - the table name

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

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(DraftId draftId,
                                           Configurer configurer,
                                           DBTable dbTable)
                                    throws Exception

Assess the given table detail using the plugins from the given draft. Plugins will be instantiated in order to generate this assessment. This is an expensive operation. If a plugin cannot be instantiated due to missing draft information, an InvalidDraftException will be thrown.

Parameters:

draftId - id of the draft

dbTable - the database, the schema, the table to be assessed

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

TableNotFoundException - if the table does not exist

IOException - if the table detail could not be read

Exception - if there was an error creating the table registry

IllegalArgumentException - if the table is not selected in the draft

assessTable

public TableAssessmentResponse assessTable(Namespace 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(DraftId draftId,
                                         Configurer configurer)
                                  throws Exception

Assess the entire pipeline based on the tables the source will read and the capabilities of the target. This will fetch draft from the store.

Throws:

Exception

assessPipeline

public PipelineAssessment assessPipeline(Namespace 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 draft information, 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