Skip to content

GH-5470: Avoid nested query in JdbcStepExecutionDao.getLastStepExecution #5480

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
arimu1 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

GH-5470: Avoid nested query in JdbcStepExecutionDao.getLastStepExecution #5480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5d8098
GH-5470: Avoid nested query in getLastStepExecution
arimu1 Aug 5, 2026
0aca72f
GH-5470: Complete id query before loading StepExecution
arimu1 Aug 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 32 additions & 20 deletions ...rc/main/java/org/springframework/batch/core/repository/dao/jdbc/JdbcStepExecutionDao.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
import org.apache.commons.logging.LogFactory;

import org.springframework.batch.core.BatchStatus;
import org.springframework.batch.core.ExitStatus;
import org.springframework.batch.core.job.JobExecution;
import org.springframework.batch.core.job.JobInstance;
import org.springframework.batch.core.step.StepExecution;
Expand Down Expand Up @@ -95,7 +94,7 @@ public class JdbcStepExecutionDao extends AbstractJdbcBatchMetadataDao implement
""";

private static final String GET_LAST_STEP_EXECUTION = """
SELECT SE.STEP_EXECUTION_ID, SE.STEP_NAME, SE.START_TIME, SE.END_TIME, SE.STATUS, SE.COMMIT_COUNT, SE.READ_COUNT, SE.FILTER_COUNT, SE.WRITE_COUNT, SE.EXIT_CODE, SE.EXIT_MESSAGE, SE.READ_SKIP_COUNT, SE.WRITE_SKIP_COUNT, SE.PROCESS_SKIP_COUNT, SE.ROLLBACK_COUNT, SE.LAST_UPDATED, SE.VERSION, SE.CREATE_TIME, JE.JOB_EXECUTION_ID, JE.START_TIME, JE.END_TIME, JE.STATUS, JE.EXIT_CODE, JE.EXIT_MESSAGE, JE.CREATE_TIME, JE.LAST_UPDATED, JE.VERSION
SELECT SE.STEP_EXECUTION_ID
FROM %PREFIX%JOB_EXECUTION JE
JOIN %PREFIX%STEP_EXECUTION SE ON SE.JOB_EXECUTION_ID = JE.JOB_EXECUTION_ID
WHERE JE.JOB_INSTANCE_ID = ? AND SE.STEP_NAME = ?
Expand Down Expand Up @@ -326,35 +325,48 @@ public void synchronizeStatus(StepExecution stepExecution) {
}, stepExecution.getId());
}

/**
* Find the most recent {@link StepExecution} for the given job instance and step
* name.
* <p>
* Implementation note (GH-5470): the id is selected with
* {@code ORDER BY SE.CREATE_TIME DESC, SE.STEP_EXECUTION_ID DESC}, only the first row
* is read in Java, the statement is allowed to complete, and only then is
* {@link #getStepExecution(long)} used to load the full entity. JDBC
* {@code setMaxRows(1)} is intentionally not used: with a non-zero max-rows limit,
* some drivers (for example pgjdbc) send a protocol row count that can leave a
* suspended portal after the first row, so a follow-up prepare on the same connection
* fails on databases that disallow multiple active portals (for example CockroachDB).
* Closing the Java {@link ResultSet} is not enough if the portal never reached
* {@code CommandComplete}.
* <p>
* SQL {@code LIMIT} is also avoided for database portability. With the default JDBC
* fetch size, the id query runs to completion and only the first ordered row is
* consumed in application code; subsequent rows are not mapped. This keeps the two
* statements strictly sequential and portable across the databases Spring Batch
* targets.
*/
@Nullable
@Override
public StepExecution getLastStepExecution(JobInstance jobInstance, String stepName) {
return getJdbcTemplate().execute(getQuery(GET_LAST_STEP_EXECUTION),
(PreparedStatementCallback<StepExecution>) statement -> {
statement.setMaxRows(1);
Long stepExecutionId = getJdbcTemplate().execute(getQuery(GET_LAST_STEP_EXECUTION),
(PreparedStatementCallback<Long>) statement -> {
// Do not call setMaxRows(1): a protocol row limit can leave a
// suspended portal; the first ordered row is taken in Java instead.
statement.setLong(1, jobInstance.getInstanceId());
statement.setString(2, stepName);
try (ResultSet rs = statement.executeQuery()) {
if (rs.next()) {
Long jobExecutionId = rs.getLong(19);
JobExecution jobExecution = new JobExecution(jobExecutionId, jobInstance,
jobExecutionDao.getJobParameters(jobExecutionId));
jobExecution.setStartTime(
rs.getTimestamp(20) == null ? null : rs.getTimestamp(20).toLocalDateTime());
jobExecution
.setEndTime(rs.getTimestamp(21) == null ? null : rs.getTimestamp(21).toLocalDateTime());
jobExecution.setStatus(BatchStatus.valueOf(rs.getString(22)));
jobExecution.setExitStatus(new ExitStatus(rs.getString(23), rs.getString(24)));
jobExecution.setCreateTime(
rs.getTimestamp(25) == null ? null : rs.getTimestamp(25).toLocalDateTime());
jobExecution.setLastUpdated(
rs.getTimestamp(26) == null ? null : rs.getTimestamp(26).toLocalDateTime());
jobExecution.setVersion(rs.getInt(27));
return new StepExecutionRowMapper(jobExecution).mapRow(rs, 0);
return rs.getLong(1);
}
return null;
}
});
if (stepExecutionId == null) {
return null;
}
// Id statement is closed by JdbcTemplate; load the full StepExecution next.
return getStepExecution(stepExecutionId);
}

/**
Expand Down
47 changes: 47 additions & 0 deletions ...st/java/org/springframework/batch/core/repository/dao/jdbc/JdbcStepExecutionDaoTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import org.springframework.batch.core.BatchStatus;
import org.springframework.batch.core.ExitStatus;
import org.springframework.batch.core.job.JobExecution;
import org.springframework.batch.core.job.JobInstance;
Expand Down Expand Up @@ -158,4 +159,50 @@ void testDeleteStepExecution() {
Assertions.assertEquals(0, JdbcTestUtils.countRowsInTable(jdbcTemplate, "BATCH_STEP_EXECUTION"));
}

@Test
void testGetLastStepExecution() {
// Given
JobParameters jobParameters = new JobParameters();
JobInstance jobInstance = jdbcJobInstanceDao.createJobInstance("job", jobParameters);
JobExecution jobExecution = jdbcJobExecutionDao.createJobExecution(jobInstance, jobParameters);
jdbcStepExecutionDao.createStepExecution("step1", jobExecution);
StepExecution olderStep2 = jdbcStepExecutionDao.createStepExecution("step2", jobExecution);
StepExecution latestStep2 = jdbcStepExecutionDao.createStepExecution("step2", jobExecution);

// When
StepExecution lastStepExecution = jdbcStepExecutionDao.getLastStepExecution(jobInstance, "step2");

// Then — id-based: latest step2, not the older one or step1
Assertions.assertNotNull(lastStepExecution);
assertEquals(latestStep2.getId(), lastStepExecution.getId());
assertEquals(jobExecution.getId(), lastStepExecution.getJobExecutionId());
assertEquals("step2", lastStepExecution.getStepName());
Assertions.assertNotEquals(olderStep2.getId(), lastStepExecution.getId());
Assertions.assertNull(jdbcStepExecutionDao.getLastStepExecution(jobInstance, "missing"));
}

@Test
void testGetLastStepExecutionAcrossJobExecutions() {
// Given — restart path: a prior step execution exists under the same job instance
JobParameters jobParameters = new JobParameters();
JobInstance jobInstance = jdbcJobInstanceDao.createJobInstance("job", jobParameters);
JobExecution firstJobExecution = jdbcJobExecutionDao.createJobExecution(jobInstance, jobParameters);
StepExecution firstStepExecution = jdbcStepExecutionDao.createStepExecution("step", firstJobExecution);
firstStepExecution.setStatus(BatchStatus.COMPLETED);
jdbcStepExecutionDao.updateStepExecution(firstStepExecution);

JobExecution secondJobExecution = jdbcJobExecutionDao.createJobExecution(jobInstance, jobParameters);
StepExecution secondStepExecution = jdbcStepExecutionDao.createStepExecution("step", secondJobExecution);

// When — id query must complete before getStepExecution (no setMaxRows; GH-5470)
StepExecution lastStepExecution = jdbcStepExecutionDao.getLastStepExecution(jobInstance, "step");

// Then — id-based selection of the latest step across job executions
Assertions.assertNotNull(lastStepExecution);
assertEquals(secondStepExecution.getId(), lastStepExecution.getId());
assertEquals(secondJobExecution.getId(), lastStepExecution.getJobExecutionId());
assertEquals("step", lastStepExecution.getStepName());
Assertions.assertNotEquals(firstStepExecution.getId(), lastStepExecution.getId());
}

}