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

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

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 67.14286% with 69 lines in your changes missing coverage. Please review.
✅ Project coverage is 56.59%. Comparing base (ac6130b) to head (b3c2905).

Files with missing lines	Patch %	Lines
.../microsoft/sqlserver/jdbc/SQLServerConnection.java	56.32%	25 Missing and 13 partials ⚠️
...oft/sqlserver/jdbc/SQLServerPreparedStatement.java	73.72%	19 Missing and 12 partials ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #2844      +/-   ##
============================================
+ Coverage     56.42%   56.59%   +0.16%     
- Complexity     4555     4627      +72     
============================================
  Files           151      151              
  Lines         34560    34764     +204     
  Branches       5768     5825      +57     
============================================
+ Hits          19501    19673     +172     
- Misses        12418    12456      +38     
+ Partials       2641     2635       -6

☔ 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).

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

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

…tion

…hExecutionTest; fix batch update count handling for comma-separated SQL statements.

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

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

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

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

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

…on logic - Renamed PrepareMethod from 'exec' to 'scopeTempTablesToConnection' for clarity - Added containsTemporaryTableOperations() method with optimized regex pattern - Method detects temp tables (#temp, ##global, [#temp_'chars]) in SQL statements - Only applies scopeTempTablesToConnection when temp tables are present - Falls back to normal execution when no temp tables detected Batch execution improvements: - Fixed batch combining to separate CREATE TABLE prefix from parameterized INSERT - Uses lastIndexOf(';', firstParamPos) to find proper SQL statement boundary - Handles whitespace offset calculation for accurate parameter positions - Fixed exception hierarchy: BatchUpdateException wrapped in SQLServerException Regex pattern enhancements: - Supports both unescaped (#temp) and bracketed ([#temp_'special-chars]) identifiers - Detects CREATE TABLE, INSERT, UPDATE, DELETE, SELECT INTO operations - Performance optimized with pre-compiled patterns Test coverage: - Added comprehensive test cases for temp table batch execution - Tests constraint violations with proper update counts validation - Tests exception cause chain unwrapping - All 5 tests in SQLServerPreparedStatementTempTableTest passing

…epare method in PrepareMethodExecTest and PreparedStatementTest.

…/github.com/microsoft/mssql-jdbc into dev/divang/sybase-migration-dynamic-prepare

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

divang added 4 commits December 8, 2025 12:22

Added replaceParameterMarkersWithValues() method and propogated execp…

d01859f

…tion

Correct temp table naming and constraint violation assertions in Batc…

8e2db67

…hExecutionTest; fix batch update count handling for comma-separated SQL statements.

Cleaned up unused code.

9adf6bf

Fixed Datae/Time converiosn in formatLiteralValue() method

4c77ac7

microsoft deleted a comment from machavan Dec 15, 2025

machavan reviewed Dec 15, 2025

View reviewed changes

divang added 2 commits December 16, 2025 11:45

Cleaned up the old approach and hanlded review comments

5c7c24f

timeoutOccurred variable is not required at this place

7f3ef8d

machavan reviewed Dec 16, 2025

View reviewed changes

divang added 6 commits December 17, 2025 11:33

Handled OOO case replaceParameterMarkersWithValues() method

677a709

Fixed ADO pipeline for JDK8

6598483

Merge branch 'main' into dev/divang/sybase-migration-dynamic-prepare

a35c878

Fixed the old exec and renamed it to PreparedStatementTest for the pr…

c4fe035

…epare method in PrepareMethodExecTest and PreparedStatementTest.

Merge branch 'dev/divang/sybase-migration-dynamic-prepare' of https:/…

b3c2905

…/github.com/microsoft/mssql-jdbc into dev/divang/sybase-migration-dynamic-prepare

Introduce new prepareMethod exec for PreparedStatement #2844

Are you sure you want to change the base?

Introduce new prepareMethod exec for PreparedStatement #2844

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!

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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