org.springframework.cloud.dataflow.aggregate.task.impl

Class AggregateDataFlowTaskExecutionQueryDao

java.lang.Object

org.springframework.cloud.dataflow.aggregate.task.impl.AggregateDataFlowTaskExecutionQueryDao

All Implemented Interfaces:

DataflowTaskExecutionQueryDao

public class AggregateDataFlowTaskExecutionQueryDao
extends Object
implements DataflowTaskExecutionQueryDao

Provide aggregate data for Boot 3 and Boot <=2 TaskExecutions.

Author:

Corneil du Plessis

Field Summary

Fields

Modifier and Type	Field and Description
static String	FROM_CLAUSE FROM clause for task execution.
static String	RUNNING_TASK_WHERE_CLAUSE WHERE clause for running task.
static String	SELECT_CLAUSE SELECT clause for task execution.
static String	TASK_NAME_WHERE_CLAUSE WHERE clause for task name.

Constructor Summary

Constructors

Constructor and Description
AggregateDataFlowTaskExecutionQueryDao(DataSource dataSource, SchemaService schemaService) Initializes the AggregateDataFlowJobExecutionDao.

Method Summary

Modifier and Type	Method and Description
org.springframework.data.domain.Page<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	findAll(org.springframework.data.domain.Pageable pageable) Retrieves all the task executions within the pageable constraints.
org.springframework.data.domain.Page<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	findAll(org.springframework.data.domain.Pageable pageable, boolean thinResults) Retrieves all the task executions within the pageable constraints.
List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	findChildTaskExecutions(Collection<Long> parentIds, String schemaTarget) Retrieves a list of task executions where the provided execution ids and schemaTarget represents the parents of task executions.
List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	findChildTaskExecutions(long executionId, String schemaTarget) Retrieves a list of task executions where the provided execution id and schemaTarget represents the parent of task execution.
org.springframework.data.domain.Page<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	findRunningTaskExecutions(String taskName, org.springframework.data.domain.Pageable pageable) Retrieves a set of task executions that are running for a taskName.
List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	findTaskExecutions(String taskName, boolean completed) Find task executions by task name and completion status.
List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	findTaskExecutionsBeforeEndTime(String taskName, Date endTime) Find task executions by task name whose end date is before the specified date.
org.springframework.data.domain.Page<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	findTaskExecutionsByName(String taskName, org.springframework.data.domain.Pageable pageable) Retrieves a subset of task executions by task name, start location and size.
org.springframework.cloud.dataflow.schema.AggregateTaskExecution	geTaskExecutionByExecutionId(String externalExecutionId, String taskName)
long	getCompletedTaskExecutionCountByTaskName(String taskName) Retrieves current number of task executions for a taskName and with a non-null endTime.
long	getCompletedTaskExecutionCountByTaskNameAndBeforeDate(String taskName, Date endTime) Retrieves current number of task executions for a taskName and with a non-null endTime before the specified date.
org.springframework.cloud.dataflow.schema.AggregateTaskExecution	getLatestTaskExecutionForTaskName(String taskName) Returns the latest task execution for a given task name.
List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	getLatestTaskExecutionsByTaskNames(String... taskNames) Returns a List of the latest TaskExecution for 1 or more task names.
long	getRunningTaskExecutionCount() Retrieves current number of task executions with an endTime of null.
long	getRunningTaskExecutionCountByTaskName(String taskName) Retrieves current number of task executions for a taskName and with an endTime of null.
org.springframework.cloud.dataflow.schema.AggregateTaskExecution	getTaskExecution(long executionId, String schemaTarget) Retrieves a task execution from the task repository.
long	getTaskExecutionCount() Retrieves current number of task executions.
long	getTaskExecutionCountByTaskName(String taskName) Retrieves current number of task executions for a taskName.
List<String>	getTaskNames() Retrieves a sorted list of distinct task names for the task executions.

Methods inherited from class java.lang.Object

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

Field Detail

SELECT_CLAUSE

public static final String SELECT_CLAUSE

SELECT clause for task execution.

See Also:

Constant Field Values

FROM_CLAUSE

public static final String FROM_CLAUSE

FROM clause for task execution.

See Also:

Constant Field Values

RUNNING_TASK_WHERE_CLAUSE

public static final String RUNNING_TASK_WHERE_CLAUSE

WHERE clause for running task.

See Also:

Constant Field Values

TASK_NAME_WHERE_CLAUSE

public static final String TASK_NAME_WHERE_CLAUSE

WHERE clause for task name.

See Also:

Constant Field Values

Constructor Detail

AggregateDataFlowTaskExecutionQueryDao

public AggregateDataFlowTaskExecutionQueryDao(DataSource dataSource,
                                              SchemaService schemaService)

Initializes the AggregateDataFlowJobExecutionDao.

Parameters:

dataSource - used by the dao to execute queries and update the tables.

schemaService - used the find schema target information

Method Detail

geTaskExecutionByExecutionId

public org.springframework.cloud.dataflow.schema.AggregateTaskExecution geTaskExecutionByExecutionId(String externalExecutionId,
                                                                                                     String taskName)

Specified by:

geTaskExecutionByExecutionId in interface DataflowTaskExecutionQueryDao

getTaskExecution

public org.springframework.cloud.dataflow.schema.AggregateTaskExecution getTaskExecution(long executionId,
                                                                                         String schemaTarget)

Description copied from interface: DataflowTaskExecutionQueryDao

Retrieves a task execution from the task repository.

Specified by:

getTaskExecution in interface DataflowTaskExecutionQueryDao

Parameters:

executionId - the id associated with the task execution.

schemaTarget - the schema target.

Returns:

a fully qualified TaskExecution instance.

findChildTaskExecutions

public List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> findChildTaskExecutions(long executionId,
                                                                                                      String schemaTarget)

Description copied from interface: DataflowTaskExecutionQueryDao

Retrieves a list of task executions where the provided execution id and schemaTarget represents the parent of task execution.

Specified by:

findChildTaskExecutions in interface DataflowTaskExecutionQueryDao

Parameters:

executionId - parent task execution id

schemaTarget - parent task schema target

Returns:

the task executions

findChildTaskExecutions

public List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> findChildTaskExecutions(Collection<Long> parentIds,
                                                                                                      String schemaTarget)

Description copied from interface: DataflowTaskExecutionQueryDao

Retrieves a list of task executions where the provided execution ids and schemaTarget represents the parents of task executions.

Specified by:

findChildTaskExecutions in interface DataflowTaskExecutionQueryDao

Parameters:

parentIds - parent task execution ids

schemaTarget - parent task schema target

Returns:

the task executions

findTaskExecutions

public List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> findTaskExecutions(String taskName,
                                                                                                 boolean completed)

Description copied from interface: DataflowTaskExecutionQueryDao

Find task executions by task name and completion status.

Specified by:

findTaskExecutions in interface DataflowTaskExecutionQueryDao

Parameters:

taskName - the name of the task to search for in the repository.

completed - whether to include only completed task executions.

Returns:

list of task executions

findTaskExecutionsBeforeEndTime

public List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> findTaskExecutionsBeforeEndTime(String taskName,
                                                                                                              @NonNull
                                                                                                              Date endTime)

Description copied from interface: DataflowTaskExecutionQueryDao

Find task executions by task name whose end date is before the specified date.

Specified by:

findTaskExecutionsBeforeEndTime in interface DataflowTaskExecutionQueryDao

Parameters:

taskName - the name of the task to search for in the repository.

endTime - the time before the task ended.

Returns:

list of task executions.

getTaskExecutionCountByTaskName

public long getTaskExecutionCountByTaskName(String taskName)

Description copied from interface: DataflowTaskExecutionQueryDao

Retrieves current number of task executions for a taskName.

Specified by:

getTaskExecutionCountByTaskName in interface DataflowTaskExecutionQueryDao

Parameters:

taskName - the name of the task

Returns:

current number of task executions for the taskName.

getCompletedTaskExecutionCountByTaskName

public long getCompletedTaskExecutionCountByTaskName(String taskName)

Description copied from interface: DataflowTaskExecutionQueryDao

Retrieves current number of task executions for a taskName and with a non-null endTime.

Specified by:

getCompletedTaskExecutionCountByTaskName in interface DataflowTaskExecutionQueryDao

Parameters:

taskName - the name of the task

Returns:

the number of completed task executions

getCompletedTaskExecutionCountByTaskNameAndBeforeDate

public long getCompletedTaskExecutionCountByTaskNameAndBeforeDate(String taskName,
                                                                  @NonNull
                                                                  Date endTime)

Description copied from interface: DataflowTaskExecutionQueryDao

Retrieves current number of task executions for a taskName and with a non-null endTime before the specified date.

Specified by:

getCompletedTaskExecutionCountByTaskNameAndBeforeDate in interface DataflowTaskExecutionQueryDao

Parameters:

taskName - the name of the task

endTime - the time before task ended

Returns:

the number of completed task executions

getRunningTaskExecutionCountByTaskName

public long getRunningTaskExecutionCountByTaskName(String taskName)

Description copied from interface: DataflowTaskExecutionQueryDao

Retrieves current number of task executions for a taskName and with an endTime of null.

Specified by:

getRunningTaskExecutionCountByTaskName in interface DataflowTaskExecutionQueryDao

Parameters:

taskName - the name of the task to search for in the repository.

Returns:

the number of running task executions

getRunningTaskExecutionCount

public long getRunningTaskExecutionCount()

Description copied from interface: DataflowTaskExecutionQueryDao

Retrieves current number of task executions with an endTime of null.

Specified by:

getRunningTaskExecutionCount in interface DataflowTaskExecutionQueryDao

Returns:

current number of task executions.

getLatestTaskExecutionsByTaskNames

public List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> getLatestTaskExecutionsByTaskNames(String... taskNames)

Description copied from interface: DataflowTaskExecutionQueryDao

Returns a List of the latest TaskExecution for 1 or more task names.

Latest is defined by the most recent start time. A TaskExecution does not have to be finished (The results may including pending TaskExecutions).

It is theoretically possible that a TaskExecution with the same name to have more than 1 TaskExecution for the exact same start time. In that case the TaskExecution with the highest Task Execution ID is returned.

This method will not consider end times in its calculations. Thus, when a task execution A starts after task execution B but finishes BEFORE task execution A, then task execution B is being returned.

Specified by:

getLatestTaskExecutionsByTaskNames in interface DataflowTaskExecutionQueryDao

Parameters:

taskNames - At least 1 task name must be provided

Returns:

List of TaskExecutions. May be empty but never null.

getLatestTaskExecutionForTaskName

public org.springframework.cloud.dataflow.schema.AggregateTaskExecution getLatestTaskExecutionForTaskName(String taskName)

Description copied from interface: DataflowTaskExecutionQueryDao

Returns the latest task execution for a given task name. Will ultimately apply the same algorithm underneath as DataflowTaskExecutionQueryDao.getLatestTaskExecutionsByTaskNames(String...) but will only return a single result.

Specified by:

getLatestTaskExecutionForTaskName in interface DataflowTaskExecutionQueryDao

Parameters:

taskName - Must not be null or empty

Returns:

The latest Task Execution or null

See Also:

DataflowTaskExecutionQueryDao.getLatestTaskExecutionsByTaskNames(String...)

getTaskExecutionCount

public long getTaskExecutionCount()

Description copied from interface: DataflowTaskExecutionQueryDao

Retrieves current number of task executions.

Specified by:

getTaskExecutionCount in interface DataflowTaskExecutionQueryDao

Returns:

current number of task executions.

findRunningTaskExecutions

public org.springframework.data.domain.Page<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> findRunningTaskExecutions(String taskName,
                                                                                                                                        org.springframework.data.domain.Pageable pageable)

Description copied from interface: DataflowTaskExecutionQueryDao

Retrieves a set of task executions that are running for a taskName.

Specified by:

findRunningTaskExecutions in interface DataflowTaskExecutionQueryDao

Parameters:

taskName - the name of the task to search for in the repository.

pageable - the constraints for the search.

Returns:

set of running task executions.

findTaskExecutionsByName

public org.springframework.data.domain.Page<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> findTaskExecutionsByName(String taskName,
                                                                                                                                       org.springframework.data.domain.Pageable pageable)

Description copied from interface: DataflowTaskExecutionQueryDao

Retrieves a subset of task executions by task name, start location and size.

Specified by:

findTaskExecutionsByName in interface DataflowTaskExecutionQueryDao

Parameters:

taskName - the name of the task to search for in the repository.

pageable - the constraints for the search.

Returns:

a list that contains task executions from the query bound by the start position and count specified by the user.

getTaskNames

public List<String> getTaskNames()

Description copied from interface: DataflowTaskExecutionQueryDao

Retrieves a sorted list of distinct task names for the task executions.

Specified by:

getTaskNames in interface DataflowTaskExecutionQueryDao

Returns:

a list of distinct task names from the task repository..

findAll

public org.springframework.data.domain.Page<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> findAll(org.springframework.data.domain.Pageable pageable)

Description copied from interface: DataflowTaskExecutionQueryDao

Retrieves all the task executions within the pageable constraints.

Specified by:

findAll in interface DataflowTaskExecutionQueryDao

Parameters:

pageable - the constraints for the search

Returns:

page containing the results from the search

findAll

public org.springframework.data.domain.Page<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> findAll(org.springframework.data.domain.Pageable pageable,
                                                                                                                      boolean thinResults)

Description copied from interface: DataflowTaskExecutionQueryDao

Retrieves all the task executions within the pageable constraints.

Specified by:

findAll in interface DataflowTaskExecutionQueryDao

Parameters:

pageable - the constraints for the search

thinResults - Indicated if arguments will be populated

Returns:

page containing the results from the search