com.toolsverse.etl.core.codegen

Class DefaultCodeGen

Object

com.toolsverse.etl.core.codegen.DefaultCodeGen

All Implemented Interfaces:

MergeHandler, CodeGen

public class DefaultCodeGen
extends Object
implements CodeGen, MergeHandler

The default implementation of the CodeGen interface.

Since:

1.0

Version:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_DEBEZIUM_CDC_OP

Fields inherited from interface com.toolsverse.etl.core.engine.CodeGen

CREATED_STATUS, EXECUTED_STATUS, PREPARED_STATUS

Constructor Summary

Constructors

Constructor and Description
DefaultCodeGen() Instantiates a new default code generator.

Method Summary

Modifier and Type	Method and Description
void	addScriptToCleanOnException(String script) Adds the script to clean on exception.
void	addScriptToCleanUpAfter(String script) Adds the script to clean up after.
void	addScriptToCleanUpBefore(String script) Adds the script to clean up before.
void	addScriptToCreate(Destination destination, String script) Adds the script to create.
void	addScriptToInit(Destination destination, String script, boolean cleanUpOnException, String type, boolean ignoreError) Adds the script to init.
void	assembleCode(EtlConfig config, Scenario scenario, Driver driver, int loadIndex, boolean silent) Assembles prepared code.
void	cleanUp(EtlConfig config, Scenario scenario, Driver driver, Connection conn) Clean up after last block of code is executed.
void	cleanUpOnException(EtlConfig config, Scenario scenario, Driver driver, Connection cleanUpConn) Clean up database objects on exception.
void	copy(CodeGen codeGen) Copy parameters from other code generator.
void	execute(EtlConfig config, Scenario scenario, Driver driver, boolean silent, Connection conn, Connection cleanUpConn, Destination destination) Executes code.
List<String>	getScriptsToCleanOnException() Gets the list of scripts which should be executed to clean up database object on exception.
int	getStatus() Gets the status of the code generator.
EtlUnit	getUnit() Gets the current unit.
void	onMerge(OnException onException, Connection conn, String sql, String keyField, long row) Executed when default etl "insert into" action is failed and etl scenario is configured to try update instead.
void	prepare(EtlConfig config, Scenario scenario, Destination destination, boolean silent, boolean onlyInit, boolean isStreaming) Prepares code for the destination using given config and scenario.
void	reorderColumns(Destination destination, DataSetConnector writer, DataSetConnectorParams writerParams) Reorder columns.
void	reset() Resets the status.
void	runRemainingBatch(EtlConfig config, Scenario scenario, Connection conn, Destination destination) Run remaining batch statements.
String	setCurrentCode(Driver driver, String name, int index) Sets the current code.
void	setTransactionMonitor(TransactionMonitor transactionMonitor) Sets the transaction monitor.
void	setUnit(EtlUnit unit) Sets the current unit.

Methods inherited from class Object

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

Field Detail

FIELD_DEBEZIUM_CDC_OP

public static final String FIELD_DEBEZIUM_CDC_OP

See Also:

Constant Field Values

Constructor Detail

DefaultCodeGen

public DefaultCodeGen()

Instantiates a new default code generator.

Method Detail

setTransactionMonitor

public void setTransactionMonitor(TransactionMonitor transactionMonitor)

Description copied from interface: CodeGen

Sets the transaction monitor.

Specified by:

setTransactionMonitor in interface CodeGen

Parameters:

transactionMonitor - the new transaction monitor

addScriptToCleanOnException

public void addScriptToCleanOnException(String script)

Description copied from interface: CodeGen

Adds the script to clean on exception.

Specified by:

addScriptToCleanOnException in interface CodeGen

Parameters:

script - the script

addScriptToCleanUpAfter

public void addScriptToCleanUpAfter(String script)

Adds the script to clean up after.

Specified by:

addScriptToCleanUpAfter in interface CodeGen

Parameters:

script - the script

addScriptToCleanUpBefore

public void addScriptToCleanUpBefore(String script)

Description copied from interface: CodeGen

Adds the script to clean up before.

Specified by:

addScriptToCleanUpBefore in interface CodeGen

Parameters:

script - the script

addScriptToCreate

public void addScriptToCreate(Destination destination,
                              String script)

Description copied from interface: CodeGen

Adds the script to create.

Specified by:

addScriptToCreate in interface CodeGen

Parameters:

destination - the destination

script - the script

addScriptToInit

public void addScriptToInit(Destination destination,
                            String script,
                            boolean cleanUpOnException,
                            String type,
                            boolean ignoreError)

Description copied from interface: CodeGen

Adds the script to init.

Specified by:

addScriptToInit in interface CodeGen

Parameters:

destination - the destination

script - the script

cleanUpOnException - the "clean up on exception" flag

type - the type

ignoreError - if true ignore error when executing script

assembleCode

public void assembleCode(EtlConfig config,
                         Scenario scenario,
                         Driver driver,
                         int loadIndex,
                         boolean silent)
                  throws Exception

Description copied from interface: CodeGen

Assembles prepared code. The idea is the following: prepare(...) is called for each destination. The resulting code saved internally. assembleCode(...) assembles final code by concatenating code for all destinations with added declarations, etc so it can be be executed in the designated database. Also it splits code on chunks if necessary. For example Oracle limits size of the PL\SQL block to approximately 3000 lines. @param config The config @param scenario The scenario @param driver The driver @param loadIndex If equals to 0 this chunk will be executed first.

Specified by:

assembleCode in interface CodeGen

silent - If true logging is disabled for everything but exceptions

Throws:

Exception - in case of any error

cleanUp

public void cleanUp(EtlConfig config,
                    Scenario scenario,
                    Driver driver,
                    Connection conn)
             throws Exception

Description copied from interface: CodeGen

Clean up after last block of code is executed.

Specified by:

cleanUp in interface CodeGen

Parameters:

config - the config

scenario - the scenario

driver - the driver

conn - the connection

Throws:

Exception - the exception in case of any error

cleanUpOnException

public void cleanUpOnException(EtlConfig config,
                               Scenario scenario,
                               Driver driver,
                               Connection cleanUpConn)
                        throws Exception

Description copied from interface: CodeGen

Clean up database objects on exception.

Specified by:

cleanUpOnException in interface CodeGen

Parameters:

config - the config

scenario - the scenario

driver - the driver

cleanUpConn - the clean up connection

Throws:

Exception - the exception

copy

public void copy(CodeGen codeGen)

Description copied from interface: CodeGen

Copy parameters from other code generator.

Specified by:

copy in interface CodeGen

Parameters:

codeGen - the code generator

execute

public void execute(EtlConfig config,
                    Scenario scenario,
                    Driver driver,
                    boolean silent,
                    Connection conn,
                    Connection cleanUpConn,
                    Destination destination)
             throws Exception

Description copied from interface: CodeGen

Executes code. Code for each destination should be already prepared and stored internally.

Specified by:

execute in interface CodeGen

Parameters:

config - The etl config

scenario - The scenario

driver - The driver

silent - If true logging is disabled for everything but exceptions

conn - The JDBC connection

cleanUpConn - the clean up connection

destination - the destination

Throws:

Exception - in case of any error

getScriptsToCleanOnException

public List<String> getScriptsToCleanOnException()

Description copied from interface: CodeGen

Gets the list of scripts which should be executed to clean up database object on exception.

Specified by:

getScriptsToCleanOnException in interface CodeGen

Returns:

the list of scripts to clean up on exception

getStatus

public int getStatus()

Description copied from interface: CodeGen

Gets the status of the code generator.

Specified by:

getStatus in interface CodeGen

Returns:

the status

getUnit

public EtlUnit getUnit()

Description copied from interface: CodeGen

Gets the current unit.

Specified by:

getUnit in interface CodeGen

Returns:

the unit

See Also:

EtlUnit

onMerge

public void onMerge(OnException onException,
                    Connection conn,
                    String sql,
                    String keyField,
                    long row)
             throws Exception

Description copied from interface: MergeHandler

Executed when default etl "insert into" action is failed and etl scenario is configured to try update instead. Usually translates insert sql statement into update and executes it.

Specified by:

onMerge in interface MergeHandler

Parameters:

onException - the OnException object

conn - the connection

sql - the sql (usually insert statement)

keyField - the key field

row - the row

Throws:

Exception - in case of any error

reorderColumns

public void reorderColumns(Destination destination,
                           DataSetConnector writer,
                           DataSetConnectorParams writerParams)

Description copied from interface: CodeGen

Reorder columns.

Specified by:

reorderColumns in interface CodeGen

Parameters:

destination - the destination

prepare

public void prepare(EtlConfig config,
                    Scenario scenario,
                    Destination destination,
                    boolean silent,
                    boolean onlyInit,
                    boolean isStreaming)
             throws Exception

Description copied from interface: CodeGen

Prepares code for the destination using given config and scenario.

Specified by:

prepare in interface CodeGen

Parameters:

config - The etl config

scenario - The scenario

destination - The destination

silent - If true logging is disabled for everything but exceptions

onlyInit - the only init

isStreaming - true if is streaming

Throws:

Exception - in case of any error

reset

public void reset()

Description copied from interface: CodeGen

Resets the status.

Specified by:

reset in interface CodeGen

runRemainingBatch

public void runRemainingBatch(EtlConfig config,
                              Scenario scenario,
                              Connection conn,
                              Destination destination)
                       throws Exception

Description copied from interface: CodeGen

Run remaining batch statements.

Specified by:

runRemainingBatch in interface CodeGen

Parameters:

config - the ETL config

scenario - the scenario

conn - the connection

destination - the destination

Throws:

Exception - in case of any error

setCurrentCode

public String setCurrentCode(Driver driver,
                             String name,
                             int index)

Sets the current code.

Parameters:

driver - the driver

name - the name

index - the index

Returns:

the string

setUnit

public void setUnit(EtlUnit unit)

Description copied from interface: CodeGen

Sets the current unit.

Specified by:

setUnit in interface CodeGen

Parameters:

unit - the new unit

See Also:

EtlUnit