From 520eb7f425afb66804cb4749bfb100680dc844dd Mon Sep 17 00:00:00 2001 From: Sreekanth Vadigi Date: Mon, 10 Aug 2026 11:47:44 +0000 Subject: [PATCH 1/2] Isolate legacy prepared statement batch execution Keep existing batching behavior behind a dedicated executor so native routing can be added without changing the compatibility fallback. Signed-off-by: Sreekanth Vadigi --- .../LegacyPreparedStatementBatchExecutor.java | 207 +++++++++++++++++ .../impl/PreparedStatementBatchExecutor.java | 184 +-------------- .../PreparedStatementBatchExecutorTest.java | 212 ++++++++++++++++++ 3 files changed, 424 insertions(+), 179 deletions(-) create mode 100644 src/main/java/com/databricks/jdbc/api/impl/LegacyPreparedStatementBatchExecutor.java create mode 100644 src/test/java/com/databricks/jdbc/api/impl/PreparedStatementBatchExecutorTest.java diff --git a/src/main/java/com/databricks/jdbc/api/impl/LegacyPreparedStatementBatchExecutor.java b/src/main/java/com/databricks/jdbc/api/impl/LegacyPreparedStatementBatchExecutor.java new file mode 100644 index 000000000..1ed4eb9fa --- /dev/null +++ b/src/main/java/com/databricks/jdbc/api/impl/LegacyPreparedStatementBatchExecutor.java @@ -0,0 +1,207 @@ +package com.databricks.jdbc.api.impl; + +import com.databricks.jdbc.common.DatabricksJdbcConstants; +import com.databricks.jdbc.common.StatementType; +import com.databricks.jdbc.common.util.InsertStatementParser; +import com.databricks.jdbc.exception.DatabricksBatchUpdateException; +import com.databricks.jdbc.exception.DatabricksSQLException; +import com.databricks.jdbc.log.JdbcLogger; +import com.databricks.jdbc.log.JdbcLoggerFactory; +import com.databricks.jdbc.model.telemetry.enums.DatabricksDriverErrorCode; +import java.sql.Statement; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * Executes prepared-statement batches using the legacy client-side strategies. + * + *

This class intentionally preserves the existing behavior: eligible INSERT statements may be + * rewritten into chunked multi-row INSERTs, while all other statements execute one parameter set at + * a time. + */ +class LegacyPreparedStatementBatchExecutor { + + private static final JdbcLogger LOGGER = + JdbcLoggerFactory.getLogger(LegacyPreparedStatementBatchExecutor.class); + + private final String sql; + private final DatabricksConnection connection; + private final boolean interpolateParameters; + private final PreparedStatementBatchExecutor.StatementExecutor statementExecutor; + + LegacyPreparedStatementBatchExecutor( + String sql, + DatabricksConnection connection, + boolean interpolateParameters, + PreparedStatementBatchExecutor.StatementExecutor statementExecutor) { + this.sql = sql; + this.connection = connection; + this.interpolateParameters = interpolateParameters; + this.statementExecutor = statementExecutor; + } + + long[] executeBatch(List batchParameterMetaData) + throws DatabricksBatchUpdateException { + if (batchParameterMetaData.isEmpty()) { + return new long[0]; + } + + // Try to optimize INSERT statements with multi-row batching + if (canUseBatchedInsert()) { + return executeBatchedInsert(batchParameterMetaData); + } else { + // Fall back to individual execution for non-INSERT or incompatible statements + return executeIndividualStatements(batchParameterMetaData); + } + } + + private boolean canUseBatchedInsert() { + // Check if batched inserts are enabled via connection property + if (!connection.getConnectionContext().isBatchedInsertsEnabled()) { + return false; + } + + // Use strict exception-based parsing for better error handling + try { + InsertStatementParser.parseInsertStrict(sql); + return true; + } catch (Exception e) { + // Not a valid INSERT statement suitable for batching + LOGGER.warn( + "EnableBatchedInserts is enabled but the INSERT statement could not be parsed for" + + " batching, falling back to individual execution: {}", + e.getMessage()); + return false; + } + } + + private long[] executeBatchedInsert(List batchParameterMetaData) + throws DatabricksBatchUpdateException { + LOGGER.debug("Executing batched INSERT with {} rows", batchParameterMetaData.size()); + + try { + InsertStatementParser.InsertInfo insertInfo = InsertStatementParser.parseInsertStrict(sql); + + // Calculate how many rows we can fit in one chunk + int parametersPerRow = insertInfo.getColumnCount(); + int maxRowsPerChunk; + + if (interpolateParameters) { + // When parameter interpolation is enabled (supportManyParameters=1), there is no + // parameter limit since values are interpolated directly into the SQL string. + // Try to execute all rows in a single batch, only limited by configured BatchInsertSize + // which users can set based on their data to avoid exceeding the 16MB statement limit. + int configuredBatchSize = connection.getConnectionContext().getBatchInsertSize(); + if (configuredBatchSize < 1) { + throw new DatabricksSQLException( + "BatchInsertSize must be at least 1, got: " + configuredBatchSize, + DatabricksDriverErrorCode.INVALID_STATE); + } + maxRowsPerChunk = Math.min(configuredBatchSize, batchParameterMetaData.size()); + } else { + // When using parameterized queries, respect the 256 parameter limit from Databricks + // backend + int maxRowsByParameterLimit = + DatabricksJdbcConstants.MAX_QUERY_PARAMETERS / parametersPerRow; + + // Ensure we have at least 1 row per chunk + if (maxRowsByParameterLimit < 1) { + maxRowsPerChunk = 1; + } else { + maxRowsPerChunk = maxRowsByParameterLimit; + } + } + + long[] allUpdateCounts = new long[batchParameterMetaData.size()]; + + // Process batches in chunks + for (int startIndex = 0; + startIndex < batchParameterMetaData.size(); + startIndex += maxRowsPerChunk) { + int endIndex = Math.min(startIndex + maxRowsPerChunk, batchParameterMetaData.size()); + int chunkSize = endIndex - startIndex; + + // Build multi-row INSERT for this chunk + String multiRowSql = InsertStatementParser.generateMultiRowInsert(insertInfo, chunkSize); + Map chunkParams = new HashMap<>(); + int paramIndex = 1; + + for (int i = startIndex; i < endIndex; i++) { + DatabricksParameterMetaData batchParams = batchParameterMetaData.get(i); + Map rowParams = batchParams.getParameterBindings(); + for (int j = 1; j <= rowParams.size(); j++) { + if (rowParams.containsKey(j)) { + chunkParams.put(paramIndex++, rowParams.get(j)); + } + } + } + + // Execute this chunk + String sqlToExecute = + interpolateParameters + ? com.databricks.jdbc.common.util.SQLInterpolator.interpolateSQL( + multiRowSql, chunkParams) + : multiRowSql; + Map paramsToSend = + interpolateParameters ? new HashMap<>() : chunkParams; + statementExecutor.execute(sqlToExecute, paramsToSend, StatementType.UPDATE, false); + + // Set update counts for this chunk (each row typically affects 1 row) + for (int i = startIndex; i < endIndex; i++) { + allUpdateCounts[i] = 1; + } + } + + return allUpdateCounts; + + } catch (DatabricksBatchUpdateException e) { + // Re-throw batch update exceptions (these already have proper update counts) + throw e; + } catch (Exception e) { + // Unexpected exception - mark all as failed + LOGGER.error("Unexpected error executing batched INSERT: {}", e.getMessage(), e); + long[] failedCounts = new long[batchParameterMetaData.size()]; + for (int i = 0; i < failedCounts.length; i++) { + failedCounts[i] = Statement.EXECUTE_FAILED; + } + throw new DatabricksBatchUpdateException( + e.getMessage(), DatabricksDriverErrorCode.BATCH_EXECUTE_EXCEPTION, failedCounts); + } + } + + private long[] executeIndividualStatements( + List batchParameterMetaData) + throws DatabricksBatchUpdateException { + LOGGER.debug("Executing batch individually with {} statements", batchParameterMetaData.size()); + long[] largeUpdateCount = new long[batchParameterMetaData.size()]; + + for (int sqlQueryIndex = 0; sqlQueryIndex < batchParameterMetaData.size(); sqlQueryIndex++) { + DatabricksParameterMetaData databricksParameterMetaData = + batchParameterMetaData.get(sqlQueryIndex); + try { + DatabricksResultSet resultSet = + statementExecutor.execute( + sql, + databricksParameterMetaData.getParameterBindings(), + StatementType.UPDATE, + false); + largeUpdateCount[sqlQueryIndex] = resultSet.getUpdateCount(); + } catch (Exception e) { + LOGGER.error( + "Error executing batch update for index {}: {}", sqlQueryIndex, e.getMessage(), e); + // Set the current failed statement's count + largeUpdateCount[sqlQueryIndex] = Statement.EXECUTE_FAILED; + // Set all remaining statements as failed + for (int i = sqlQueryIndex + 1; i < largeUpdateCount.length; i++) { + largeUpdateCount[i] = Statement.EXECUTE_FAILED; + } + // WARNING: Due to lack of transaction support, any successfully executed statements + // before this failure have already been committed and cannot be rolled back + throw new DatabricksBatchUpdateException( + e.getMessage(), DatabricksDriverErrorCode.BATCH_EXECUTE_EXCEPTION, largeUpdateCount); + } + } + return largeUpdateCount; + } +} diff --git a/src/main/java/com/databricks/jdbc/api/impl/PreparedStatementBatchExecutor.java b/src/main/java/com/databricks/jdbc/api/impl/PreparedStatementBatchExecutor.java index 7387cf67f..cd5a725a9 100644 --- a/src/main/java/com/databricks/jdbc/api/impl/PreparedStatementBatchExecutor.java +++ b/src/main/java/com/databricks/jdbc/api/impl/PreparedStatementBatchExecutor.java @@ -1,28 +1,14 @@ package com.databricks.jdbc.api.impl; -import com.databricks.jdbc.common.DatabricksJdbcConstants; import com.databricks.jdbc.common.StatementType; -import com.databricks.jdbc.common.util.InsertStatementParser; import com.databricks.jdbc.exception.DatabricksBatchUpdateException; -import com.databricks.jdbc.exception.DatabricksSQLException; -import com.databricks.jdbc.log.JdbcLogger; -import com.databricks.jdbc.log.JdbcLoggerFactory; -import com.databricks.jdbc.model.telemetry.enums.DatabricksDriverErrorCode; import java.sql.SQLException; -import java.sql.Statement; -import java.util.HashMap; import java.util.List; import java.util.Map; class PreparedStatementBatchExecutor { - private static final JdbcLogger LOGGER = - JdbcLoggerFactory.getLogger(PreparedStatementBatchExecutor.class); - - private final String sql; - private final DatabricksConnection connection; - private final boolean interpolateParameters; - private final StatementExecutor statementExecutor; + private final LegacyPreparedStatementBatchExecutor legacyExecutor; @FunctionalInterface interface StatementExecutor { @@ -39,173 +25,13 @@ DatabricksResultSet execute( DatabricksConnection connection, boolean interpolateParameters, StatementExecutor statementExecutor) { - this.sql = sql; - this.connection = connection; - this.interpolateParameters = interpolateParameters; - this.statementExecutor = statementExecutor; + this.legacyExecutor = + new LegacyPreparedStatementBatchExecutor( + sql, connection, interpolateParameters, statementExecutor); } long[] executeBatch(List batchParameterMetaData) throws DatabricksBatchUpdateException { - if (batchParameterMetaData.isEmpty()) { - return new long[0]; - } - - // Try to optimize INSERT statements with multi-row batching - if (canUseBatchedInsert()) { - return executeBatchedInsert(batchParameterMetaData); - } else { - // Fall back to individual execution for non-INSERT or incompatible statements - return executeIndividualStatements(batchParameterMetaData); - } - } - - private boolean canUseBatchedInsert() { - // Check if batched inserts are enabled via connection property - if (!connection.getConnectionContext().isBatchedInsertsEnabled()) { - return false; - } - - // Use strict exception-based parsing for better error handling - try { - InsertStatementParser.parseInsertStrict(sql); - return true; - } catch (Exception e) { - // Not a valid INSERT statement suitable for batching - LOGGER.warn( - "EnableBatchedInserts is enabled but the INSERT statement could not be parsed for" - + " batching, falling back to individual execution: {}", - e.getMessage()); - return false; - } - } - - private long[] executeBatchedInsert(List batchParameterMetaData) - throws DatabricksBatchUpdateException { - LOGGER.debug("Executing batched INSERT with {} rows", batchParameterMetaData.size()); - - try { - InsertStatementParser.InsertInfo insertInfo = InsertStatementParser.parseInsertStrict(sql); - - // Calculate how many rows we can fit in one chunk - int parametersPerRow = insertInfo.getColumnCount(); - int maxRowsPerChunk; - - if (interpolateParameters) { - // When parameter interpolation is enabled (supportManyParameters=1), there is no - // parameter limit since values are interpolated directly into the SQL string. - // Try to execute all rows in a single batch, only limited by configured BatchInsertSize - // which users can set based on their data to avoid exceeding the 16MB statement limit. - int configuredBatchSize = connection.getConnectionContext().getBatchInsertSize(); - if (configuredBatchSize < 1) { - throw new DatabricksSQLException( - "BatchInsertSize must be at least 1, got: " + configuredBatchSize, - DatabricksDriverErrorCode.INVALID_STATE); - } - maxRowsPerChunk = Math.min(configuredBatchSize, batchParameterMetaData.size()); - } else { - // When using parameterized queries, respect the 256 parameter limit from Databricks - // backend - int maxRowsByParameterLimit = - DatabricksJdbcConstants.MAX_QUERY_PARAMETERS / parametersPerRow; - - // Ensure we have at least 1 row per chunk - if (maxRowsByParameterLimit < 1) { - maxRowsPerChunk = 1; - } else { - maxRowsPerChunk = maxRowsByParameterLimit; - } - } - - long[] allUpdateCounts = new long[batchParameterMetaData.size()]; - - // Process batches in chunks - for (int startIndex = 0; - startIndex < batchParameterMetaData.size(); - startIndex += maxRowsPerChunk) { - int endIndex = Math.min(startIndex + maxRowsPerChunk, batchParameterMetaData.size()); - int chunkSize = endIndex - startIndex; - - // Build multi-row INSERT for this chunk - String multiRowSql = InsertStatementParser.generateMultiRowInsert(insertInfo, chunkSize); - Map chunkParams = new HashMap<>(); - int paramIndex = 1; - - for (int i = startIndex; i < endIndex; i++) { - DatabricksParameterMetaData batchParams = batchParameterMetaData.get(i); - Map rowParams = batchParams.getParameterBindings(); - for (int j = 1; j <= rowParams.size(); j++) { - if (rowParams.containsKey(j)) { - chunkParams.put(paramIndex++, rowParams.get(j)); - } - } - } - - // Execute this chunk - String sqlToExecute = - interpolateParameters - ? com.databricks.jdbc.common.util.SQLInterpolator.interpolateSQL( - multiRowSql, chunkParams) - : multiRowSql; - Map paramsToSend = - interpolateParameters ? new HashMap<>() : chunkParams; - statementExecutor.execute(sqlToExecute, paramsToSend, StatementType.UPDATE, false); - - // Set update counts for this chunk (each row typically affects 1 row) - for (int i = startIndex; i < endIndex; i++) { - allUpdateCounts[i] = 1; - } - } - - return allUpdateCounts; - - } catch (DatabricksBatchUpdateException e) { - // Re-throw batch update exceptions (these already have proper update counts) - throw e; - } catch (Exception e) { - // Unexpected exception - mark all as failed - LOGGER.error("Unexpected error executing batched INSERT: {}", e.getMessage(), e); - long[] failedCounts = new long[batchParameterMetaData.size()]; - for (int i = 0; i < failedCounts.length; i++) { - failedCounts[i] = Statement.EXECUTE_FAILED; - } - throw new DatabricksBatchUpdateException( - e.getMessage(), DatabricksDriverErrorCode.BATCH_EXECUTE_EXCEPTION, failedCounts); - } - } - - private long[] executeIndividualStatements( - List batchParameterMetaData) - throws DatabricksBatchUpdateException { - LOGGER.debug("Executing batch individually with {} statements", batchParameterMetaData.size()); - long[] largeUpdateCount = new long[batchParameterMetaData.size()]; - - for (int sqlQueryIndex = 0; sqlQueryIndex < batchParameterMetaData.size(); sqlQueryIndex++) { - DatabricksParameterMetaData databricksParameterMetaData = - batchParameterMetaData.get(sqlQueryIndex); - try { - DatabricksResultSet resultSet = - statementExecutor.execute( - sql, - databricksParameterMetaData.getParameterBindings(), - StatementType.UPDATE, - false); - largeUpdateCount[sqlQueryIndex] = resultSet.getUpdateCount(); - } catch (Exception e) { - LOGGER.error( - "Error executing batch update for index {}: {}", sqlQueryIndex, e.getMessage(), e); - // Set the current failed statement's count - largeUpdateCount[sqlQueryIndex] = Statement.EXECUTE_FAILED; - // Set all remaining statements as failed - for (int i = sqlQueryIndex + 1; i < largeUpdateCount.length; i++) { - largeUpdateCount[i] = Statement.EXECUTE_FAILED; - } - // WARNING: Due to lack of transaction support, any successfully executed statements - // before this failure have already been committed and cannot be rolled back - throw new DatabricksBatchUpdateException( - e.getMessage(), DatabricksDriverErrorCode.BATCH_EXECUTE_EXCEPTION, largeUpdateCount); - } - } - return largeUpdateCount; + return legacyExecutor.executeBatch(batchParameterMetaData); } } diff --git a/src/test/java/com/databricks/jdbc/api/impl/PreparedStatementBatchExecutorTest.java b/src/test/java/com/databricks/jdbc/api/impl/PreparedStatementBatchExecutorTest.java new file mode 100644 index 000000000..9d911322f --- /dev/null +++ b/src/test/java/com/databricks/jdbc/api/impl/PreparedStatementBatchExecutorTest.java @@ -0,0 +1,212 @@ +package com.databricks.jdbc.api.impl; + +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.ArgumentMatchers.anyMap; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.verifyNoInteractions; +import static org.mockito.Mockito.when; + +import com.databricks.jdbc.api.internal.IDatabricksConnectionContext; +import com.databricks.jdbc.common.StatementType; +import com.databricks.jdbc.exception.DatabricksBatchUpdateException; +import com.databricks.jdbc.model.core.ColumnInfoTypeName; +import java.sql.SQLException; +import java.sql.Statement; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.ArgumentCaptor; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; + +@ExtendWith(MockitoExtension.class) +class PreparedStatementBatchExecutorTest { + + private static final String INSERT_SQL = "INSERT INTO target (id, name) VALUES (?, ?)"; + private static final String UPDATE_SQL = "UPDATE target SET name = ? WHERE id = ?"; + + @Mock private DatabricksConnection connection; + @Mock private IDatabricksConnectionContext connectionContext; + @Mock private PreparedStatementBatchExecutor.StatementExecutor statementExecutor; + @Mock private DatabricksResultSet firstResultSet; + @Mock private DatabricksResultSet secondResultSet; + + @Test + void emptyBatchDoesNotExecuteStatements() throws Exception { + PreparedStatementBatchExecutor executor = newExecutor(INSERT_SQL, false); + + assertArrayEquals(new long[0], executor.executeBatch(List.of())); + verifyNoInteractions(connection, statementExecutor); + } + + @Test + void disabledBatchedInsertsExecuteEachParameterSetIndividually() throws Exception { + setBatchedInsertsEnabled(false); + List batch = createBatch(2); + when(statementExecutor.execute(eq(INSERT_SQL), anyMap(), eq(StatementType.UPDATE), eq(false))) + .thenReturn(firstResultSet, secondResultSet); + when(firstResultSet.getUpdateCount()).thenReturn(3L); + when(secondResultSet.getUpdateCount()).thenReturn(5L); + + long[] counts = newExecutor(INSERT_SQL, false).executeBatch(batch); + + assertArrayEquals(new long[] {3, 5}, counts); + verify(statementExecutor) + .execute(INSERT_SQL, batch.get(0).getParameterBindings(), StatementType.UPDATE, false); + verify(statementExecutor) + .execute(INSERT_SQL, batch.get(1).getParameterBindings(), StatementType.UPDATE, false); + } + + @Test + void ineligibleSqlFallsBackToIndividualExecution() throws Exception { + setBatchedInsertsEnabled(true); + List batch = createBatch(1); + when(statementExecutor.execute(eq(UPDATE_SQL), anyMap(), eq(StatementType.UPDATE), eq(false))) + .thenReturn(firstResultSet); + when(firstResultSet.getUpdateCount()).thenReturn(7L); + + long[] counts = newExecutor(UPDATE_SQL, false).executeBatch(batch); + + assertArrayEquals(new long[] {7}, counts); + verify(statementExecutor) + .execute(UPDATE_SQL, batch.get(0).getParameterBindings(), StatementType.UPDATE, false); + } + + @Test + void eligibleInsertIsRewrittenWithFlattenedParameters() throws Exception { + setBatchedInsertsEnabled(true); + List batch = createBatch(2); + ArgumentCaptor sqlCaptor = ArgumentCaptor.forClass(String.class); + @SuppressWarnings("unchecked") + ArgumentCaptor> parametersCaptor = + ArgumentCaptor.forClass(Map.class); + when(statementExecutor.execute( + sqlCaptor.capture(), parametersCaptor.capture(), eq(StatementType.UPDATE), eq(false))) + .thenReturn(firstResultSet); + + long[] counts = newExecutor(INSERT_SQL, false).executeBatch(batch); + + assertArrayEquals(new long[] {1, 1}, counts); + assertEquals("INSERT INTO target (`id`, `name`) VALUES (?, ?), (?, ?)", sqlCaptor.getValue()); + assertEquals(4, parametersCaptor.getValue().size()); + assertEquals(1, parametersCaptor.getValue().get(1).cardinal()); + assertEquals(2, parametersCaptor.getValue().get(2).cardinal()); + assertEquals(1, parametersCaptor.getValue().get(3).cardinal()); + assertEquals(2, parametersCaptor.getValue().get(4).cardinal()); + } + + @Test + void parameterizedRewriteUsesTheExisting256ParameterChunkLimit() throws Exception { + setBatchedInsertsEnabled(true); + when(statementExecutor.execute(anyString(), anyMap(), eq(StatementType.UPDATE), eq(false))) + .thenReturn(firstResultSet); + + long[] counts = newExecutor(INSERT_SQL, false).executeBatch(createBatch(129)); + + assertEquals(129, counts.length); + verify(statementExecutor) + .execute(eq(multiRowInsert(128)), anyMap(), eq(StatementType.UPDATE), eq(false)); + verify(statementExecutor) + .execute(eq(multiRowInsert(1)), anyMap(), eq(StatementType.UPDATE), eq(false)); + } + + @Test + void interpolatedRewriteUsesConfiguredBatchInsertSize() throws Exception { + setBatchedInsertsEnabled(true); + when(connectionContext.getBatchInsertSize()).thenReturn(2); + ArgumentCaptor sqlCaptor = ArgumentCaptor.forClass(String.class); + @SuppressWarnings("unchecked") + ArgumentCaptor> parametersCaptor = + ArgumentCaptor.forClass(Map.class); + when(statementExecutor.execute( + sqlCaptor.capture(), parametersCaptor.capture(), eq(StatementType.UPDATE), eq(false))) + .thenReturn(firstResultSet); + + long[] counts = newExecutor(INSERT_SQL, true).executeBatch(createBatch(3)); + + assertArrayEquals(new long[] {1, 1, 1}, counts); + assertEquals(2, sqlCaptor.getAllValues().size()); + assertEquals( + "INSERT INTO target (`id`, `name`) VALUES (1, 'name-1'), (2, 'name-2')", + sqlCaptor.getAllValues().get(0)); + assertEquals( + "INSERT INTO target (`id`, `name`) VALUES (3, 'name-3')", sqlCaptor.getAllValues().get(1)); + assertTrue(parametersCaptor.getAllValues().stream().allMatch(Map::isEmpty)); + } + + @Test + void rewrittenBatchFailureMarksEveryParameterSetFailed() throws Exception { + setBatchedInsertsEnabled(true); + when(statementExecutor.execute(anyString(), anyMap(), eq(StatementType.UPDATE), eq(false))) + .thenThrow(new SQLException("rewrite failed")); + + DatabricksBatchUpdateException exception = + assertThrows( + DatabricksBatchUpdateException.class, + () -> newExecutor(INSERT_SQL, false).executeBatch(createBatch(3))); + + assertArrayEquals( + new long[] {Statement.EXECUTE_FAILED, Statement.EXECUTE_FAILED, Statement.EXECUTE_FAILED}, + exception.getLargeUpdateCounts()); + } + + @Test + void individualFailurePreservesEarlierCountAndMarksRemainingSetsFailed() throws Exception { + setBatchedInsertsEnabled(false); + when(statementExecutor.execute(eq(INSERT_SQL), anyMap(), eq(StatementType.UPDATE), eq(false))) + .thenReturn(firstResultSet) + .thenThrow(new SQLException("individual failed")); + when(firstResultSet.getUpdateCount()).thenReturn(4L); + + DatabricksBatchUpdateException exception = + assertThrows( + DatabricksBatchUpdateException.class, + () -> newExecutor(INSERT_SQL, false).executeBatch(createBatch(3))); + + assertArrayEquals( + new long[] {4, Statement.EXECUTE_FAILED, Statement.EXECUTE_FAILED}, + exception.getLargeUpdateCounts()); + } + + private PreparedStatementBatchExecutor newExecutor(String sql, boolean interpolateParameters) { + return new PreparedStatementBatchExecutor( + sql, connection, interpolateParameters, statementExecutor); + } + + private void setBatchedInsertsEnabled(boolean enabled) { + when(connection.getConnectionContext()).thenReturn(connectionContext); + when(connectionContext.isBatchedInsertsEnabled()).thenReturn(enabled); + } + + private List createBatch(int rowCount) { + List batch = new ArrayList<>(); + for (int row = 1; row <= rowCount; row++) { + DatabricksParameterMetaData parameterMetaData = new DatabricksParameterMetaData(INSERT_SQL); + parameterMetaData.put(1, parameter(1, row, ColumnInfoTypeName.INT)); + parameterMetaData.put(2, parameter(2, "name-" + row, ColumnInfoTypeName.STRING)); + batch.add(parameterMetaData); + } + return batch; + } + + private ImmutableSqlParameter parameter( + int cardinal, Object value, ColumnInfoTypeName columnInfoTypeName) { + return ImmutableSqlParameter.builder() + .cardinal(cardinal) + .value(value) + .type(columnInfoTypeName) + .build(); + } + + private String multiRowInsert(int rows) { + return "INSERT INTO target (`id`, `name`) VALUES " + + String.join(", ", java.util.Collections.nCopies(rows, "(?, ?)")); + } +} From 473a4fba3e88e9293d3740bb2e7a24d9c9c188c0 Mon Sep 17 00:00:00 2001 From: Sreekanth Vadigi Date: Mon, 10 Aug 2026 13:40:01 +0000 Subject: [PATCH 2/2] Add native batching configuration and parameter model Introduce a dormant opt-in and deterministic parameter snapshots so both native transports can share the same ordered payload without changing execution behavior. Signed-off-by: Sreekanth Vadigi --- .../jdbc/api/impl/BatchParameterSet.java | 77 +++++++++++++ .../api/impl/DatabricksConnectionContext.java | 5 + .../IDatabricksConnectionContext.java | 3 + .../jdbc/common/DatabricksJdbcUrlParams.java | 1 + .../jdbc/api/impl/BatchParameterSetTest.java | 106 ++++++++++++++++++ .../impl/DatabricksConnectionContextTest.java | 19 ++++ 6 files changed, 211 insertions(+) create mode 100644 src/main/java/com/databricks/jdbc/api/impl/BatchParameterSet.java create mode 100644 src/test/java/com/databricks/jdbc/api/impl/BatchParameterSetTest.java diff --git a/src/main/java/com/databricks/jdbc/api/impl/BatchParameterSet.java b/src/main/java/com/databricks/jdbc/api/impl/BatchParameterSet.java new file mode 100644 index 000000000..f2fe4dd15 --- /dev/null +++ b/src/main/java/com/databricks/jdbc/api/impl/BatchParameterSet.java @@ -0,0 +1,77 @@ +package com.databricks.jdbc.api.impl; + +import java.sql.Date; +import java.sql.Time; +import java.sql.Timestamp; +import java.util.Comparator; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.stream.Collectors; + +/** + * Immutable, position-ordered snapshot of one prepared-statement parameter set. + * + *

This model normalizes JDBC's one-based parameter indexes to zero-based wire ordinals. It does + * not validate parameter completeness, index continuity, or consistency with other parameter sets; + * those validations remain the backend's responsibility. + */ +public final class BatchParameterSet { + + private final List parameters; + + private BatchParameterSet(List parameters) { + this.parameters = List.copyOf(parameters); + } + + public static BatchParameterSet from(Map parameterBindings) { + Objects.requireNonNull(parameterBindings, "parameterBindings"); + List orderedParameters = + parameterBindings.entrySet().stream() + .sorted(Comparator.comparingInt(Map.Entry::getKey)) + .map(BatchParameterSet::snapshotParameter) + .collect(Collectors.toList()); + return new BatchParameterSet(orderedParameters); + } + + public List getParameters() { + return parameters; + } + + public int size() { + return parameters.size(); + } + + public boolean isEmpty() { + return parameters.isEmpty(); + } + + private static ImmutableSqlParameter snapshotParameter( + Map.Entry entry) { + ImmutableSqlParameter parameter = entry.getValue(); + return ImmutableSqlParameter.builder() + .cardinal(entry.getKey() - 1) + .type(parameter.type()) + .value(snapshotValue(parameter.value())) + .build(); + } + + private static Object snapshotValue(Object value) { + if (value instanceof Timestamp) { + Timestamp timestamp = (Timestamp) value; + Timestamp copy = new Timestamp(timestamp.getTime()); + copy.setNanos(timestamp.getNanos()); + return copy; + } + if (value instanceof Date) { + return new Date(((Date) value).getTime()); + } + if (value instanceof Time) { + return new Time(((Time) value).getTime()); + } + if (value instanceof byte[]) { + return ((byte[]) value).clone(); + } + return value; + } +} diff --git a/src/main/java/com/databricks/jdbc/api/impl/DatabricksConnectionContext.java b/src/main/java/com/databricks/jdbc/api/impl/DatabricksConnectionContext.java index dfa4b70f9..62233e70c 100644 --- a/src/main/java/com/databricks/jdbc/api/impl/DatabricksConnectionContext.java +++ b/src/main/java/com/databricks/jdbc/api/impl/DatabricksConnectionContext.java @@ -1480,6 +1480,11 @@ public boolean isBatchedInsertsEnabled() { return getParameter(DatabricksJdbcUrlParams.ENABLE_BATCHED_INSERTS).equals("1"); } + @Override + public boolean isNativeBatchingEnabled() { + return getParameter(DatabricksJdbcUrlParams.ENABLE_NATIVE_BATCHING).equals("1"); + } + @Override public List getNonRowcountQueryPrefixes() { String prefixesStr = getParameter(DatabricksJdbcUrlParams.NON_ROWCOUNT_QUERY_PREFIXES); diff --git a/src/main/java/com/databricks/jdbc/api/internal/IDatabricksConnectionContext.java b/src/main/java/com/databricks/jdbc/api/internal/IDatabricksConnectionContext.java index fb0d745a7..c3851296c 100644 --- a/src/main/java/com/databricks/jdbc/api/internal/IDatabricksConnectionContext.java +++ b/src/main/java/com/databricks/jdbc/api/internal/IDatabricksConnectionContext.java @@ -426,6 +426,9 @@ default int getHeartbeatIntervalSeconds() { /** Returns whether batched INSERT optimization is enabled */ boolean isBatchedInsertsEnabled(); + /** Returns whether native parameter batch execution is enabled */ + boolean isNativeBatchingEnabled(); + /** Returns whether transaction-related method calls should be ignored */ boolean getIgnoreTransactions(); diff --git a/src/main/java/com/databricks/jdbc/common/DatabricksJdbcUrlParams.java b/src/main/java/com/databricks/jdbc/common/DatabricksJdbcUrlParams.java index 7fea2fe2c..bf6531432 100644 --- a/src/main/java/com/databricks/jdbc/common/DatabricksJdbcUrlParams.java +++ b/src/main/java/com/databricks/jdbc/common/DatabricksJdbcUrlParams.java @@ -194,6 +194,7 @@ public enum DatabricksJdbcUrlParams { "Timeout in seconds for metadata polling operations (e.g. GetTables, GetColumns). 0 means no timeout", "300"), ENABLE_BATCHED_INSERTS("EnableBatchedInserts", "Enable batched INSERT optimization", "0"), + ENABLE_NATIVE_BATCHING("EnableNativeBatching", "Enable native parameter batch execution", "0"), ENABLE_SQL_VALIDATION_FOR_IS_VALID( "EnableSQLValidationForIsValid", "Enable SQL query execution for connection validation in isValid() method", diff --git a/src/test/java/com/databricks/jdbc/api/impl/BatchParameterSetTest.java b/src/test/java/com/databricks/jdbc/api/impl/BatchParameterSetTest.java new file mode 100644 index 000000000..5527324f4 --- /dev/null +++ b/src/test/java/com/databricks/jdbc/api/impl/BatchParameterSetTest.java @@ -0,0 +1,106 @@ +package com.databricks.jdbc.api.impl; + +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import com.databricks.jdbc.model.core.ColumnInfoTypeName; +import java.sql.Timestamp; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import org.junit.jupiter.api.Test; + +class BatchParameterSetTest { + + @Test + void ordersParametersByJdbcIndexAndUsesZeroBasedOrdinals() { + Map bindings = new HashMap<>(); + bindings.put(3, parameter(99, "third", ColumnInfoTypeName.STRING)); + bindings.put(1, parameter(99, "first", ColumnInfoTypeName.STRING)); + bindings.put(2, parameter(99, "second", ColumnInfoTypeName.STRING)); + + BatchParameterSet parameterSet = BatchParameterSet.from(bindings); + + assertEquals(List.of("first", "second", "third"), values(parameterSet)); + assertEquals(List.of(0, 1, 2), ordinals(parameterSet)); + } + + @Test + void preservesSparseIndexesWithoutValidation() { + Map bindings = new HashMap<>(); + bindings.put(3, parameter(3, "third", ColumnInfoTypeName.STRING)); + bindings.put(1, parameter(1, "first", ColumnInfoTypeName.STRING)); + + BatchParameterSet parameterSet = BatchParameterSet.from(bindings); + + assertEquals(List.of("first", "third"), values(parameterSet)); + assertEquals(List.of(0, 2), ordinals(parameterSet)); + } + + @Test + void allowsEmptyParameterSet() { + BatchParameterSet parameterSet = BatchParameterSet.from(Map.of()); + + assertTrue(parameterSet.isEmpty()); + assertEquals(0, parameterSet.size()); + } + + @Test + void snapshotsBindingsAndMutableValues() { + Timestamp timestamp = Timestamp.valueOf("2026-08-10 12:34:56.123456789"); + byte[] bytes = new byte[] {1, 2, 3}; + Map bindings = new HashMap<>(); + bindings.put(1, parameter(1, timestamp, ColumnInfoTypeName.TIMESTAMP)); + bindings.put(2, parameter(2, bytes, ColumnInfoTypeName.BINARY)); + + BatchParameterSet parameterSet = BatchParameterSet.from(bindings); + bindings.clear(); + timestamp.setTime(0); + bytes[0] = 9; + + assertFalse(parameterSet.isEmpty()); + assertEquals( + Timestamp.valueOf("2026-08-10 12:34:56.123456789"), + parameterSet.getParameters().get(0).value()); + assertArrayEquals(new byte[] {1, 2, 3}, (byte[]) parameterSet.getParameters().get(1).value()); + assertThrows( + UnsupportedOperationException.class, + () -> parameterSet.getParameters().add(parameter(3, "extra", ColumnInfoTypeName.STRING))); + } + + @Test + void preservesNullValueAndType() { + BatchParameterSet parameterSet = + BatchParameterSet.from(Map.of(1, parameter(1, null, ColumnInfoTypeName.DECIMAL))); + + ImmutableSqlParameter parameter = parameterSet.getParameters().get(0); + assertNull(parameter.value()); + assertEquals(ColumnInfoTypeName.DECIMAL, parameter.type()); + assertEquals(0, parameter.cardinal()); + } + + private ImmutableSqlParameter parameter( + int cardinal, Object value, ColumnInfoTypeName columnInfoTypeName) { + return ImmutableSqlParameter.builder() + .cardinal(cardinal) + .value(value) + .type(columnInfoTypeName) + .build(); + } + + private List values(BatchParameterSet parameterSet) { + return parameterSet.getParameters().stream() + .map(ImmutableSqlParameter::value) + .collect(java.util.stream.Collectors.toList()); + } + + private List ordinals(BatchParameterSet parameterSet) { + return parameterSet.getParameters().stream() + .map(ImmutableSqlParameter::cardinal) + .collect(java.util.stream.Collectors.toList()); + } +} diff --git a/src/test/java/com/databricks/jdbc/api/impl/DatabricksConnectionContextTest.java b/src/test/java/com/databricks/jdbc/api/impl/DatabricksConnectionContextTest.java index 2d68683de..ef5af0f61 100644 --- a/src/test/java/com/databricks/jdbc/api/impl/DatabricksConnectionContextTest.java +++ b/src/test/java/com/databricks/jdbc/api/impl/DatabricksConnectionContextTest.java @@ -2081,4 +2081,23 @@ public void testRefreshTokenFlowDoesNotReadCredsFromUserPassword() throws Databr assertNull(ctx.getClientSecret()); assertNull(ctx.getNullableClientId()); } + + @Test + public void testNativeBatchingDisabledByDefault() throws DatabricksSQLException { + IDatabricksConnectionContext context = + DatabricksConnectionContext.parse(TestConstants.VALID_URL_1, new Properties()); + + assertFalse(context.isNativeBatchingEnabled()); + } + + @ParameterizedTest + @CsvSource({"0, false", "1, true", "true, false"}) + public void testNativeBatchingConnectionProperty(String value, boolean expected) + throws DatabricksSQLException { + String url = TestConstants.VALID_URL_1 + ";EnableNativeBatching=" + value; + + IDatabricksConnectionContext context = DatabricksConnectionContext.parse(url, new Properties()); + + assertEquals(expected, context.isNativeBatchingEnabled()); + } }