Introduce new prepareMethod exec for PreparedStatement #2844

divang · 2025-11-18T04:23:50Z

Objective
Introduce a new way to execute prepared statements using a single batch execution method.

Solution
Added a new prepareMethod option value: exec. When selected, this method substitutes parameters directly into the SQL and executes the statement as a single batch, rather than preparing and executing in separate steps.

Testing
Unit and integration tests have been added to validate the correct behavior of the exec prepare method. The tests ensure that statements execute successfully and that parameters are substituted as expected.

- Add EXEC enum value to PrepareMethod for direct execution without preparation - Implement Sybase DYNAMIC_PREPARE=false equivalent functionality - Update reuseCachedHandle to disable caching for exec method - Modify doPrepExec to bypass statement preparation when using exec method - Add comprehensive tests for temp table persistence and parameter binding - Update resource strings for proper documentation This enables seamless migration from Sybase applications by providing direct statement execution without preparation, ensuring temp tables persist across executions as expected by legacy Sybase applications. Connection usage: String url = "jdbc:sqlserver://server:1433;databaseName=mydb;prepareMethod=exec"; DataSource usage: SQLServerDataSource ds = new SQLServerDataSource(); ds.setPrepareMethod("exec");

This reverts commit f8811ea.

- Implemented SqlServerPreparedStatementExpander utility class for expanding prepared statement placeholders with actual parameter values - Added support for prepareMethod=exec to enable direct execution mode similar to Sybase's DYNAMIC_PREPARE=false - Handles proper SQL syntax parsing to avoid replacing placeholders inside strings, comments, or delimited identifiers - Implements smart NULL handling with operator rewrites (= ? -> IS NULL, <> ? -> IS NOT NULL, != ? -> IS NOT NULL, IS ? -> IS NULL, IS NOT ? -> IS NOT NULL) - Formats various data types: strings (with single quote escaping), numbers, booleans (as 1/0), dates/times, byte arrays (as hex), CLOBs, BLOBs - Added comprehensive JUnit test suite (23 test cases) covering all scenarios - Added demo class for manual testing and verification - Updated SQLServerConnection to use the new expander when useDirectValues=true in replaceParameterMarkers

- Fix operator detection to check for two-char operators (!=, <>) before single-char - Fix spacing issues when replacing operators with IS NULL/IS NOT NULL - Fix string literal parsing to properly handle escaped quotes ('') - All 23 tests now pass successfully

…ev/divang/sybase-migration-dynamic-prepare

* Add comprehensive test coverage for EXEC prepare method * commented testFourPartSyntaxCallEscapeSyntax due to linked server error

divang · 2025-11-21T07:07:44Z

/azp run

azure-pipelines · 2025-11-21T07:07:59Z

Azure Pipelines successfully started running 3 pipeline(s).

src/main/java/com/microsoft/sqlserver/jdbc/SqlServerPreparedStatementExpander.java

src/test/SybaseConnection.java

src/test/PreparedStatementExecMethodE2ETest.java

machavan · 2025-11-26T11:32:50Z

.../java/com/microsoft/sqlserver/jdbc/preparedStatement/PreparedStatementExecMethodE2ETest.java

+        createTempTable(tableName);
+
+        // Insert test data with NULL
+        try (PreparedStatement pstmt = execMethodConnection.prepareStatement(


Need to have tests which use addBatch and preapreMethod exec and cause constrain voilations in the middle of the batch e.g. 5th batch out of a 10 record batch causing PK violation. Post that, how do the update counts look like.

The bahavior should be same as prepareMethod prepare for update counts.

The test can do both mode executions and compare update counts here.

src/main/java/com/microsoft/sqlserver/jdbc/SqlServerPreparedStatementExpander.java

- Moved expandSQLWithParameters() and helper methods from SqlServerPreparedStatementExpander to SQLServerConnection - Converted from static utility class pattern to instance methods - Deleted obsolete SqlServerPreparedStatementExpander class and associated test files - Simplified replaceParameterMarkers() to call expandSQLWithParameters() directly - Reduced code duplication by ~280 lines

…improve numeric formatting - Check sendStringParametersAsUnicode config before adding N prefix to string literals - Improve Float/Double formatting using BigDecimal to avoid precision loss - Separate integer type handling from floating-point types for better precision control

…g formatting - Updated Clob value formatting to respect sendStringParametersAsUnicode setting - Updated fallback case (toString) to respect sendStringParametersAsUnicode setting

- Simplified replaceParameterMarkers when useDirectValues=true by directly iterating paramPositions array instead of complex SQL parsing - Removed expandSQLWithParameters() method which is no longer needed - Uses existing paramPositions array to replace ? markers with formatted values

…rely after encountering a single statement error, instead of marking the failed statement with EXECUTE_FAILED (-3) and continuing with remaining statements.

codecov · 2025-12-02T15:51:16Z

Codecov Report

❌ Patch coverage is 71.54812% with 68 lines in your changes missing coverage. Please review.
✅ Project coverage is 56.49%. Comparing base (caef383) to head (d01859f).
⚠️ Report is 6 commits behind head on main.

Files with missing lines	Patch %	Lines
...oft/sqlserver/jdbc/SQLServerPreparedStatement.java	60.25%	39 Missing and 23 partials ⚠️
.../microsoft/sqlserver/jdbc/SQLServerConnection.java	92.50%	2 Missing and 4 partials ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #2844      +/-   ##
============================================
+ Coverage     56.36%   56.49%   +0.13%     
- Complexity     4523     4613      +90     
============================================
  Files           151      151              
  Lines         34442    34793     +351     
  Branches       5738     5845     +107     
============================================
+ Hits          19412    19656     +244     
- Misses        12408    12484      +76     
- Partials       2622     2653      +31

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

divang · 2025-12-05T03:50:21Z

/azp run

azure-pipelines · 2025-12-05T03:50:36Z

Azure Pipelines successfully started running 3 pipeline(s).

machavan · 2025-12-05T09:32:57Z

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerConnection.java

    private static final int ENGINE_EDITION_SQL_AZURE_SYNAPSE_SERVERLESS_SQL_POOL = 11;

+    // --- SQL Parameter Expansion Methods ---
+    private static final SimpleDateFormat DATE_FMT = new SimpleDateFormat("yyyy-MM-dd");


Did we confirm if client-side formatting is really needed or can SQL Server's cast can handle formats automatically?

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerConnection.java

machavan · 2025-12-05T10:18:51Z

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerConnection.java

+        // notation
+        if (value instanceof Float) {
+            // Convert Float to BigDecimal for precise representation
+            return new java.math.BigDecimal(value.toString()).toPlainString();


We should test cases for MIN and MAX values of decimal, BigDecimal, Float, Double, Integer, BigInteger.

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerConnection.java

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerPreparedStatement.java

machavan · 2025-12-05T10:29:50Z

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerPreparedStatement.java

+     * 
+     * @return true if optimization can be applied
+     */
+    private boolean canUseOptimizedBatchExecution() {


What is optimizedbatchexecutiion and why do we need it for EXEC method ?

machavan · 2025-12-05T10:31:08Z

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerPreparedStatement.java

                        // assert null != tdsWriter;
-                        tdsWriter.writeByte((byte) NBATCH_STATEMENT_DELIMITER);
+                        if (isPrepareMethodExec) {
+                            // For EXEC method with batching, each statement must be sent separately


This seems unnecessary. For EXEC mode, we intend to prepare a semicolon separate sql string sequence one stmt per param row.

machavan · 2025-12-05T10:31:33Z

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerPreparedStatement.java

                        continue;
                    } else {
+                        // Check if this is a timeout during batch preparation for exec method
+                        String sqlState = e.getSQLState();


Why do we need this differential treatment for EXEC mode

…tion

divang and others added 10 commits October 24, 2025 16:08

Revert "Implement Sybase migration support with dynamicPrepare property"

7dac544

This reverts commit f8811ea.

Add 7 new E2E test cases for various SQL Server data types

b5f2299

Added Sybase test code

9acdfc8

Merge branch 'main' of https://github.com/microsoft/mssql-jdbc into d…

c49e2d3

…ev/divang/sybase-migration-dynamic-prepare

Add comprehensive test coverage for EXEC prepare method (#2834)

47009b3

* Add comprehensive test coverage for EXEC prepare method * commented testFourPartSyntaxCallEscapeSyntax due to linked server error

Fixed PrepareMethod - EXEC method related test cases

70d8b30

Fixed pom.xml typo

6f5de5c

machavan self-assigned this Nov 25, 2025

machavan added this to the 13.3.1 milestone Nov 25, 2025

machavan reviewed Nov 26, 2025

View reviewed changes

divang added 4 commits November 27, 2025 10:49

Remove Sybase-related test files

0615022

Apply sendStringParametersAsUnicode config to Clob and fallback strin…

caf775c

…g formatting - Updated Clob value formatting to respect sendStringParametersAsUnicode setting - Updated fallback case (toString) to respect sendStringParametersAsUnicode setting

machavan changed the title ~~Enabling Sybase Migration with DynamicPrepare~~ Introduce new prepareMethod exec for PreparedStatement Nov 27, 2025

divang added 4 commits November 28, 2025 11:20

Fixed batch update count issue and cleaned the code

ba3b584

When prepareMethod is set to 'exec', batch execution was failing enti…

37ebc5c

…rely after encountering a single statement error, instead of marking the failed statement with EXECUTE_FAILED (-3) and continuing with remaining statements.

Update count in case of batch related sql statements

c7712a9

Batching of SQL statement in case of exec preparedmethod

ed847f5

machavan reviewed Dec 5, 2025

View reviewed changes

Added replaceParameterMarkersWithValues() method and propogated execp…

d01859f

…tion

Introduce new prepareMethod exec for PreparedStatement #2844

Are you sure you want to change the base?

Introduce new prepareMethod exec for PreparedStatement #2844

Uh oh!

Conversation

divang commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

divang commented Nov 21, 2025

Uh oh!

azure-pipelines bot commented Nov 21, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

machavan Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

divang commented Dec 5, 2025

Uh oh!

azure-pipelines bot commented Dec 5, 2025

Uh oh!

machavan Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

machavan Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

machavan Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

machavan Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

machavan Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

divang commented Nov 18, 2025 •

edited

Loading

codecov bot commented Dec 2, 2025 •

edited

Loading