Querying Spring Batch JobExecution with Batch Param values

Question

Given that there is a Spring batch table that captures all the job execution params by key value:

create table BATCH_JOB_EXECUTION_PARAMS
(
    JOB_EXECUTION_ID BIGINT not null,
    TYPE_CD VARCHAR(6) not null,
    KEY_NAME VARCHAR(100) not null,
    STRING_VAL VARCHAR(250),
    DATE_VAL TIMESTAMP(26,6) default NULL,
    LONG_VAL BIGINT,
    DOUBLE_VAL DOUBLE,
    IDENTIFYING CHAR(1) not null,
    constraint JOB_EXEC_PARAMS_FK
        foreign key (JOB_EXECUTION_ID) references BATCH_JOB_EXECUTION
);

For example:

KEY_NAME correlationId
STRING_VAL eaa81b53-7f7d-4637-9935-b765405756be

I can query to retrieve the JOB_EXECUTION_ID

SELECT JOB_EXECUTION_ID FROM BATCH_JOB_EXECUTION_PARAMS
WHERE KEY_NAME = 'correlationId' AND STRING_VAL = 'eaa81b53-7f7d-4637-9935-b765405756be'

Then I can query the BATCH_JOB_EXECUTION table for full details of the job execution.

I have a rest endpoint where client provided this correlationId from which I need to grab the results of the job execution that includes BatchStatus, ExitStatus etc to build my response object.

My question is, how can I query to grab the JobExecution object from this param value provided? Is there anyway I can do this using JobExplorer?

FYI, the Spring Batch meta data tables seem to have changed over the years. See here. — Woodchuck
– Woodchuck, Commented Apr 17, 2023 at 21:35

Derrops · Accepted Answer · 2020-07-24 01:45:11Z

1

Use the org.springframework.batch.core.explore.JobExplorer to search for job executions. If you have the executionId you can use getJobExecution.

This is a bean defined by SpringBatch so you can simply auto wire it in somewhere @Autowired JobExplorer jobExplorer.

There are also methods such as findRunningJobExecutions to find running jobs.

answered Jul 24, 2020 at 1:45

Derrops

8,2077 gold badges39 silver badges75 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

M06H Over a year ago

I’m aware of this. But I need to lookup execution from one of the ids on the job params. I couldn’t locate any dao methods for job params. Or do I need to write my own queries

Derrops Over a year ago

You probably will need to write your own query, but the easiest will be to save the executionId in another table where you have a row like : myCustomParam : executionId (assuming one-to-one), that will give you a very quick query.

Mahmoud Ben Hassine · Accepted Answer · 2020-07-24 08:19:21Z

0

You can do that using JobRepository#getLastJobExecution(String jobName, JobParameters parameters):

Map<String, JobParameter> parameters = new HashMap<>();
parameters.put("correlationId", new JobParameter("eaa81b53-7f7d-4637-9935-b765405756be", true));
JobParameters jobParameters = new JobParameters(parameters);
JobExecution jobExecution = jobRepository.getLastJobExecution("myJob", jobParameters);

answered Jul 24, 2020 at 8:19

Mahmoud Ben Hassine

32.1k5 gold badges38 silver badges67 bronze badges

5 Comments

M06H Over a year ago

So will provide the job execution that were completed from the batch_job_execution table? So persisted data from dB about historical job executions ?

Mahmoud Ben Hassine Over a year ago

1) yes, you will get the job execution for that parameter from the batch_job_execution table. 2) I don't understand this question. Can you elaborate?

M06H Over a year ago

thanks, it answers my question. Although it needs exact params used to call the job to generate the same job_key or else it trips up and does not return job instance. Can it also be done using JPA? i.e. public interface JobExecutionRepository extends JpaRepository<JobExecution, Long> { and writing a native query ?

Mahmoud Ben Hassine Over a year ago

Yes, you need all to add all identifying parameters so that Spring Batch can identify the job instance you are looking for and return the last execution. If you want to create a custom native query, then yes it's possible as well.

M06H Over a year ago

I'd have to have derive a new JobExecution entity in that case? I'd get Not a managed type: class org.springframework.batch.core.JobExecution if I use Spring JPA

Collectives™ on Stack Overflow

Querying Spring Batch JobExecution with Batch Param values

2 Answers 2

2 Comments

5 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

5 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related