com.toolsverse.etl.core.task.common

Class SqlTask

Object

com.toolsverse.etl.core.task.common.SqlTask

All Implemented Interfaces:

OnTask, SupportsCodeUpdate, SupportsRecording

Direct Known Subclasses:

CopyIntoDestinationTableTask, CopyIntoRedshiftTableTask, CopyIntoTableTask

public class SqlTask
extends Object
implements OnTask, SupportsRecording, SupportsCodeUpdate

This is Task.PRE and Task.POST task which executes specified sql.

Since:

1.0

Version:

2.0

See Also:

Task

Field Summary

Fields

Modifier and Type	Field and Description
static String	CALLABLE_VAR The CALLABLE variable name.
static String	CONNECTION_ATTR
static String	DRIVER_ATTR
static String	SQL_ATTR
static String	USING_ATTR

Constructor Summary

Constructors

Constructor and Description
SqlTask()

Method Summary

Modifier and Type	Method and Description
TaskResult	executeBeforeEtlTask(EtlConfig config, Task action, Scenario scenario) Executes task before etl process is started.
TaskResult	executeInlineTask(EtlConfig config, Task task, long index, Scenario scenario) Executes task for each row of the data set.
TaskResult	executePostTask(EtlConfig config, Task task, DataSet dataSet, Scenario scenario) Executes task after extract or load finished.
TaskResult	executePreTask(EtlConfig config, Task task, Scenario scenario) Executes task before extract or load started.
String	getCodeLanguage(Task task) Gets the code language.
Map<String,Object>	getDefaultValues(Task task) Gets the default values for the model used to edit task.
String	getResourceName(Task task) Gets the name of the xml file used to create a model for the task editor.
String	getTitle(Task task) Gets the title.
void	init(EtlConfig config, Task task) Initializes task.
boolean	isInlineTask() Checks if this is inline task.
boolean	isPostTask() Checks if it is a post task.
boolean	isPreEtlTask() Checks if it is a pre etl task.
boolean	isPreTask() Checks if it is a pre task.

Methods inherited from class Object

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

Field Detail

CALLABLE_VAR

public static final String CALLABLE_VAR

The CALLABLE variable name.

See Also:

Constant Field Values

SQL_ATTR

public static final String SQL_ATTR

See Also:

Constant Field Values

USING_ATTR

public static final String USING_ATTR

See Also:

Constant Field Values

CONNECTION_ATTR

public static final String CONNECTION_ATTR

See Also:

Constant Field Values

DRIVER_ATTR

public static final String DRIVER_ATTR

See Also:

Constant Field Values

Constructor Detail

SqlTask

public SqlTask()

Method Detail

executeBeforeEtlTask

public TaskResult executeBeforeEtlTask(EtlConfig config,
                                       Task action,
                                       Scenario scenario)
                                throws Exception

Description copied from interface: OnTask

Executes task before etl process is started.

Specified by:

executeBeforeEtlTask in interface OnTask

Parameters:

config - the etl config

action - the task to execute

scenario - the scenario

Returns:

the task result

Throws:

Exception - in case of any error

executeInlineTask

public TaskResult executeInlineTask(EtlConfig config,
                                    Task task,
                                    long index,
                                    Scenario scenario)
                             throws Exception

Description copied from interface: OnTask

Executes task for each row of the data set.

Specified by:

executeInlineTask in interface OnTask

Parameters:

config - the etl config

task - the task to execute

index - the current row number

scenario - the scenario

Returns:

the task result

Throws:

Exception - in case of any error

executePostTask

public TaskResult executePostTask(EtlConfig config,
                                  Task task,
                                  DataSet dataSet,
                                  Scenario scenario)
                           throws Exception

Description copied from interface: OnTask

Executes task after extract or load finished.

Specified by:

executePostTask in interface OnTask

Parameters:

config - the etl config

task - the task to execute

dataSet - the data set

scenario - the scenario

Returns:

the task result

Throws:

Exception - in case of any error

executePreTask

public TaskResult executePreTask(EtlConfig config,
                                 Task task,
                                 Scenario scenario)
                          throws Exception

Description copied from interface: OnTask

Executes task before extract or load started.

Specified by:

executePreTask in interface OnTask

Parameters:

config - the etl config

task - the task to execute

scenario - the scenario

Returns:

the task result

Throws:

Exception - in case of any error

getDefaultValues

public Map<String,Object> getDefaultValues(Task task)

Description copied from interface: OnTask

Gets the default values for the model used to edit task.

Specified by:

getDefaultValues in interface OnTask

Parameters:

task - the task

Returns:

the default values

getResourceName

public String getResourceName(Task task)

Description copied from interface: OnTask

Gets the name of the xml file used to create a model for the task editor.

Specified by:

getResourceName in interface OnTask

Parameters:

task - the task

Returns:

the resource name

init

public void init(EtlConfig config,
                 Task task)
          throws Exception

Description copied from interface: OnTask

Initializes task.

Specified by:

init in interface OnTask

Parameters:

config - the etl config

task - the task to initialize

Throws:

Exception - in case of any error

isInlineTask

public boolean isInlineTask()

Description copied from interface: OnTask

Checks if this is inline task. The inline task is executed for each row of the data set.

Specified by:

isInlineTask in interface OnTask

Returns:

true, if it is inline task

isPostTask

public boolean isPostTask()

Description copied from interface: OnTask

Checks if it is a post task. The post task executed after extract or load finished.

Specified by:

isPostTask in interface OnTask

Returns:

true, if it is a post task

isPreEtlTask

public boolean isPreEtlTask()

Description copied from interface: OnTask

Checks if it is a pre etl task. The pre etl task executed before etl process has started.

Specified by:

isPreEtlTask in interface OnTask

Returns:

true, if it is a pre etl task

isPreTask

public boolean isPreTask()

Description copied from interface: OnTask

Checks if it is a pre task. The pre task executed before extract or load started.

Specified by:

isPreTask in interface OnTask

Returns:

true, if it is a pre task

getTitle

public String getTitle(Task task)

Description copied from interface: OnTask

Gets the title.

Specified by:

getTitle in interface OnTask

Parameters:

task - the task

Returns:

the title

getCodeLanguage

public String getCodeLanguage(Task task)

Description copied from interface: OnTask

Gets the code language.

Specified by:

getCodeLanguage in interface OnTask

Parameters:

task - the task

Returns:

the code language