Fixes #1590 - [FEATURE REQUEST] Ability to explicitly specify conversion to datetime or datetime2 #1687

dswitzer · 2021-11-11T13:58:53Z

I've implemented a new connection string (i.e. datetimeParameterType) which fixes #1590 by allowing users to specify the datatype to use for date/timestamp parameters.

This pull request adds the ability to define the datetimeParameterType connection string with any of the following values:

Option	Description
datetime2	always use DATETIME2. Good if the user knows they only use DATETIME2 datatypes in their schema (current behavior, this is the default).
datetime	always use DATETIME. Good if the user is dealing with a legacy schema and is not willing to upgrade.
datetimeoffset	always use DATETIMEOFFSET.

By default, the value defaults to datetime2, which is the same behavior as today. Setting this value to any of the above will cause any SQL version of Katmai or higher to always use that datatype for date/time values when generating parameters. For older versions of SQL Server that do not support datetime2 or datetimeoffset, then datetime is always used (just as it has been working).

I've added unit test coverage for the changes.

There should be no behavioral change for users who do not set the datetimeParameterType connection string value. It should work as it has been. However, when supporting older databases running in SQL Server 2016 or higher compatibility mode, the datetimeParameterType can be set to datetime to support databases only using that data type without worrying about casting issues in SQL Server with conversion between datetime2 and datetime.

* Added support for the dateTimeType connection string, which allows you to define how date/time values are parameterized in SQL Server. By default, for SQL Server 2008+ the "datetime2" datatype is used, where as older versions of SQL Server always use the "datetime". This allows users migrating older database application that exclusively use "datetime" datatypes to run in SQL Server compatibility modes newer than 2014. * Added unit test coverage for changes

ghost · 2021-11-11T13:59:05Z

All CLA requirements met.

VeryVerySpicy · 2021-11-16T18:31:11Z

Hello @dswitzer,
Could you please resolve the merge conflicts in this PR? Then we can run the pipeline tests to check for acceptance.

This reverts commit 416dd5e, reversing changes made to 4e8d787.

This reverts commit 4e8d787.

The merge was corrupted and blew out most of the datetimeParameterType feature changes, so I've re-applied the changes manually.

dswitzer · 2021-11-17T20:21:24Z

@v-zhangw ,

Ok, I believe the merge should be fixed, some of the checks are failing, but they not in portions of the code that should have been affected by my changes.

dswitzer · 2021-11-29T13:52:00Z

@v-zhangw

Just checking up to see if there's anything more you need from me.

pacham7 · 2022-01-26T18:19:48Z

@lilgreenbird @v-zhangw, this pull request would be really useful, as updating to a later driver would unblock migration to jdk17 for us (ssl issues with existing very old driver). Is there any chance someone can take a look at it?

dswitzer · 2022-01-26T18:27:54Z

It should be pretty easy to resolve the conflicts, I just do not have write access to the repository to do it.

AlBundy33 · 2022-11-02T20:41:19Z

@dswitzer not sure but I think you have to update your forked branch and fix the conflicts there.

dswitzer · 2022-11-03T12:56:54Z

@AlBundy33,

I'd be happy to update the fork, but the origin code keeps changing so fast, that the PR keeps becoming invalidated. It wasn't worth the time to keep fixing the code when there's no movement on them approving the PR.

If they're willing to actually move on the PR, I'm happy to fix the conflicts.

I just don't want to keep spending time to fix my PR for no reason.

AlBundy33 · 2022-11-05T23:48:29Z

@v-zhangw @lilgreenbird @Jeffery-Wasty what do you think about the pr?

Jeffery-Wasty · 2022-11-10T21:24:58Z

Hi @AlBundy33,

The issue and associated PR are on our radar and we'll look into both of them as soon as we are able to.

lilgreenbird · 2022-11-17T23:31:35Z

Hi @dswitzer

Apologies this has been put off for so long. We had determined that the #1590 needed more investigation and then we have had problems juggling this as this a feature request so it kept getting bumped by other higher priority issues. We are now getting back to looking into this again. Once you get this PR up to date we will run this thru our test lab to verify.

Syncing fork to origin

dswitzer · 2022-11-18T13:19:00Z

@lilgreenbird,

I've updated the pull request. The failures do not appear to be related to my changes.

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

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

dswitzer · 2022-11-23T18:28:59Z

@lilgreenbird,

please use our code formatter on all the changes.

When I run the Format Document command from VS Code, it's making a lot of changes to the files in places of the code I did not change—especially in the comments.

Is that what you're wanting me to do?

If not, if you could provide me with explicit instructions on what you need me to do, I would appreciate it very much!

David-Engel

I'm good with the public-facing aspects of this change (public APIs, connection string additions). I had one javadoc-related suggestion and I commented on a few code issues, too.

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

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

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

David-Engel · 2022-11-30T23:56:22Z

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

+                switch (con.getDatetimeParameterType()){
+                    case "datetime2":
+                        datatype = SSType.DATETIME2.toString();
+                        if (scale != null){
+                            datatype += "(" + scale + ")";
+                        }
+                        return datatype;
+                    case "datetimeoffset":
+                        datatype = SSType.DATETIMEOFFSET.toString();
+                        if (scale != null){
+                            datatype += "(" + scale + ")";
+                        }
+                        return datatype;
+                    case "datetime":


Can we reference SQLServerDriver.DatetimeType instead of hard-coding "datetime2"/"datetime"/"datetimeoffset" strings here?

You should be able to switch on the enum:

switch (DatetimeType.valueOfString(con.getDatetimeParameterType()){ case DatetimeType.DATETIME2:

this will be updated in a subsequent PR

David-Engel · 2022-12-01T00:00:29Z

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

+        if (!isValidDatetimeParameterType(datetimeParameterTypeValue)){
+            String errorMessage = "The timestamp encoding value (i.e. " + datetimeParameterTypeValue.toString() + ") must be: datetime, datetime2 or datetimeoffset.";
+            SQLServerException newe = new SQLServerException(errorMessage, null);
+            throw newe;
+        }
+        datetimeParameterType = DatetimeType.valueOfString(datetimeParameterTypeValue);
+    }
+
+    private boolean isValidDatetimeParameterType(String datetimeParameterTypeValue) {
+        return (datetimeParameterTypeValue.equals("datetime") || datetimeParameterTypeValue.equals("datetime2") || datetimeParameterTypeValue.equals("datetimeoffset"));
+    }


You can run all this through the DatetimeType.valueOfString(datetimeParameterValueType) method to validate the input parameter and eliminate the error message instead of hard coding more strings here.

this will be updated in a subsequent PR

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

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

lilgreenbird · 2022-12-08T02:03:49Z

/azp run CI-MacOS

azure-pipelines · 2022-12-08T02:03:59Z

Azure Pipelines successfully started running 1 pipeline(s).

Co-authored-by: David Engel <dengel1012@gmail.com>

AlBundy33 · 2023-01-14T01:14:25Z

@lilgreenbird is this already available in a release?

Jeffery-Wasty · 2023-01-16T17:46:57Z

Hi @AlBundy33,

This is planned to be included in the 12.2.0 release, scheduled for the end of this month.

dswitzer added 3 commits November 5, 2021 10:22

Renamed dateTimeType to datetimeParameterType

1881950

Merge branch 'dev' of https://github.com/dswitzer/mssql-jdbc into dev

b98846d

dswitzer added 6 commits November 17, 2021 13:04

Merge branch 'dev'

416dd5e

Revert "Merge branch 'dev'"

035d2d9

This reverts commit 416dd5e, reversing changes made to 4e8d787.

Resolved merge conflicts

b251ec3

Merge branch 'main' into dev

e2f7e06

Revert "Update versions to fix vulnerabilities (microsoft#1689)"

62d4b01

This reverts commit 4e8d787.

Fixed broken merge and re-added datetimeParameterType feature

3818a80

The merge was corrupted and blew out most of the datetimeParameterType feature changes, so I've re-applied the changes manually.

lilgreenbird added the Enhancement An enhancement to the driver. Lower priority than bugs. label Nov 24, 2021

lilgreenbird added this to Under Investigation in MSSQL JDBC via automation Nov 24, 2021

lilgreenbird moved this from Under Investigation to Waiting for Customer in MSSQL JDBC Nov 24, 2021

VeryVerySpicy mentioned this pull request Jul 14, 2022

Feat specify datetime type #1865

Closed

AlBundy33 mentioned this pull request Oct 26, 2022

Selected datetime value doesn't match the original value on SQL Server 2016 #680

Closed

tkyc moved this from Waiting for Customer to In progress in MSSQL JDBC Nov 10, 2022

tkyc moved this from In progress to Under Investigation in MSSQL JDBC Nov 10, 2022

dswitzer added 2 commits November 18, 2022 07:23

Merge remote-tracking branch 'upstream/main'

69b0170

Syncing fork to origin

Merge branch 'main' into dev

6e1d13c

lilgreenbird reviewed Nov 22, 2022

View reviewed changes

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerResource.java Show resolved Hide resolved

lilgreenbird reviewed Nov 22, 2022

View reviewed changes

src/main/java/com/microsoft/sqlserver/jdbc/Parameter.java Show resolved Hide resolved

lilgreenbird requested a review from David-Engel November 29, 2022 00:54

David-Engel reviewed Dec 1, 2022

View reviewed changes

lilgreenbird and others added 3 commits December 21, 2022 12:54

Apply suggestions from code review

9eef727

Co-authored-by: David Engel <dengel1012@gmail.com>

Update src/main/java/com/microsoft/sqlserver/jdbc/Parameter.java

2615778

Co-authored-by: David Engel <dengel1012@gmail.com>

Update src/main/java/com/microsoft/sqlserver/jdbc/Parameter.java

780e900

Co-authored-by: David Engel <dengel1012@gmail.com>

lilgreenbird previously approved these changes Dec 21, 2022

View reviewed changes

tkyc previously approved these changes Dec 21, 2022

View reviewed changes

Update src/main/java/com/microsoft/sqlserver/jdbc/SQLServerLexer.java

4b78491

lilgreenbird dismissed stale reviews from tkyc and themself via 4b78491 December 21, 2022 21:05

MSSQL JDBC automation moved this from Under Peer Review to In progress Dec 21, 2022

lilgreenbird approved these changes Dec 21, 2022

View reviewed changes

tkyc approved these changes Dec 21, 2022

View reviewed changes

lilgreenbird merged commit 45c606f into microsoft:main Dec 21, 2022

MSSQL JDBC automation moved this from In progress to Closed/Merged PRs Dec 21, 2022

lilgreenbird removed the Under Review Used for pull requests under review label Dec 22, 2022

tkyc mentioned this pull request Jan 26, 2023

12.2.0 Changelog #2056

Merged

lilgreenbird added this to the 12.2.0 milestone Jan 30, 2023

avernet mentioned this pull request Apr 30, 2024

Export from Forms Admin doesn't produce a zip on SQL Server orbeon/orbeon-forms#6283

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes #1590 - [FEATURE REQUEST] Ability to explicitly specify conversion to datetime or datetime2 #1687

Fixes #1590 - [FEATURE REQUEST] Ability to explicitly specify conversion to datetime or datetime2 #1687

dswitzer commented Nov 11, 2021

ghost commented Nov 11, 2021 •

edited by ghost

Loading

VeryVerySpicy commented Nov 16, 2021

dswitzer commented Nov 17, 2021

dswitzer commented Nov 29, 2021

pacham7 commented Jan 26, 2022

dswitzer commented Jan 26, 2022

AlBundy33 commented Nov 2, 2022

dswitzer commented Nov 3, 2022

AlBundy33 commented Nov 5, 2022

Jeffery-Wasty commented Nov 10, 2022

lilgreenbird commented Nov 17, 2022

dswitzer commented Nov 18, 2022 •

edited

Loading

dswitzer commented Nov 23, 2022

David-Engel left a comment

David-Engel Nov 30, 2022

lilgreenbird Dec 21, 2022

David-Engel Dec 1, 2022

lilgreenbird Dec 21, 2022

lilgreenbird commented Dec 8, 2022

azure-pipelines bot commented Dec 8, 2022

AlBundy33 commented Jan 14, 2023

Jeffery-Wasty commented Jan 16, 2023

Fixes #1590 - [FEATURE REQUEST] Ability to explicitly specify conversion to datetime or datetime2 #1687

Fixes #1590 - [FEATURE REQUEST] Ability to explicitly specify conversion to datetime or datetime2 #1687

Conversation

dswitzer commented Nov 11, 2021

ghost commented Nov 11, 2021 • edited by ghost Loading

VeryVerySpicy commented Nov 16, 2021

dswitzer commented Nov 17, 2021

dswitzer commented Nov 29, 2021

pacham7 commented Jan 26, 2022

dswitzer commented Jan 26, 2022

AlBundy33 commented Nov 2, 2022

dswitzer commented Nov 3, 2022

AlBundy33 commented Nov 5, 2022

Jeffery-Wasty commented Nov 10, 2022

lilgreenbird commented Nov 17, 2022

dswitzer commented Nov 18, 2022 • edited Loading

dswitzer commented Nov 23, 2022

David-Engel left a comment

Choose a reason for hiding this comment

David-Engel Nov 30, 2022

Choose a reason for hiding this comment

lilgreenbird Dec 21, 2022

Choose a reason for hiding this comment

David-Engel Dec 1, 2022

Choose a reason for hiding this comment

lilgreenbird Dec 21, 2022

Choose a reason for hiding this comment

lilgreenbird commented Dec 8, 2022

azure-pipelines bot commented Dec 8, 2022

AlBundy33 commented Jan 14, 2023

Jeffery-Wasty commented Jan 16, 2023

ghost commented Nov 11, 2021 •

edited by ghost

Loading

dswitzer commented Nov 18, 2022 •

edited

Loading