JSON datatype support #2558

divang · 2024-12-06T13:24:44Z

To add support for the new JSON datatype, the following changes have been made to the codebase:

Extended TDS feature support
Added JDBC JSON data type support in DataTypes
Implemented JSON strategy in DTV
Included JSON character encoding and constants
Handled JSON datatype support in ResultSet, TVP, and IOBuffer
Supported JSON as IN/OUT parameters in SQL prepared and callable statements
Managed JSON datatype in SQLServerBulkCopy and related bulk copy scenarios

codecov · 2024-12-06T13:47:40Z

Codecov Report

Attention: Patch coverage is 82.22222% with 8 lines in your changes missing coverage. Please review.

Project coverage is 50.09%. Comparing base (5bb3353) to head (508a1b9).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
.../microsoft/sqlserver/jdbc/SQLServerConnection.java	75.00%	3 Missing and 2 partials ⚠️
...oft/sqlserver/jdbc/SQLServerParameterMetaData.java	0.00%	1 Missing and 1 partial ⚠️
...in/java/com/microsoft/sqlserver/jdbc/IOBuffer.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #2558      +/-   ##
============================================
- Coverage     51.01%   50.09%   -0.93%     
+ Complexity     3921     3829      -92     
============================================
  Files           147      147              
  Lines         33483    33544      +61     
  Branches       5609     5619      +10     
============================================
- Hits          17081    16803     -278     
- Misses        13991    14347     +356     
+ Partials       2411     2394      -17

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

…rios.

src/test/java/com/microsoft/sqlserver/jdbc/unit/statement/RegressionTest.java

lilgreenbird · 2024-12-19T23:11:21Z

/azp run public-mssql-jdbc.windows

azure-pipelines · 2024-12-19T23:11:32Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2024-12-19T23:18:15Z

No pipelines are associated with this pull request.

lilgreenbird · 2024-12-19T23:18:56Z

/azp run public-mssql-jdbc.linux

lilgreenbird · 2024-12-19T23:19:05Z

/azp run CI-MacOS

azure-pipelines · 2024-12-19T23:19:05Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2024-12-19T23:19:15Z

Azure Pipelines successfully started running 1 pipeline(s).

src/test/java/com/microsoft/sqlserver/jdbc/callablestatement/CallableStatementTest.java

…m/microsoft/mssql-jdbc into user/divang/json-datatype-support

…ype conversion

…ues.

src/main/java/microsoft/sql/Types.java

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

lilgreenbird

need to add tests for datatype conversions. See PR for sql_variant for example

…type-support

tkyc · 2025-02-12T18:22:06Z

src/test/java/com/microsoft/sqlserver/jdbc/bulkCopy/BulkCopyISQLServerBulkRecordTest.java

@@ -150,6 +150,37 @@ public void testBulkCopyDateTimePrecision() throws SQLException {
        }
    }

+    @Test
+    public void testBulkCopyJSON() throws SQLException {


Before this merges, just a heads up and reminder that both internal and public pipelines will need the new SQL Server version that supports JSON.

saurabh500 · 2025-02-14T07:10:52Z

Can you update the description with a list of high level areas that have been modified in this PR ?

saurabh500 · 2025-02-14T07:12:21Z

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

+
+        JSON(SSType.Category.JSON, EnumSet.of(JDBCType.Category.CHARACTER, JDBCType.Category.LONG_CHARACTER,
+                JDBCType.Category.CLOB, JDBCType.Category.NCHARACTER, JDBCType.Category.LONG_NCHARACTER,
+                JDBCType.Category.NCLOB, JDBCType.Category.BINARY, JDBCType.Category.LONG_BINARY,


What does it mean to have a LONG_BINARY on Json ? I see the other types using it as well, but wondering what its purpose is.

saurabh500 · 2025-02-14T07:13:44Z

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

@@ -970,7 +985,7 @@ boolean isBinary() {
     * @return true if the JDBC type is textual
     */
    private final static EnumSet<Category> textualCategories = EnumSet.of(Category.CHARACTER, Category.LONG_CHARACTER,
-            Category.CLOB, Category.NCHARACTER, Category.LONG_NCHARACTER, Category.NCLOB);
+    Category.CLOB, Category.NCHARACTER, Category.LONG_NCHARACTER, Category.NCLOB, Category.JSON); //FIXME: JSON is textual?


you have a //fixme comment. Was this resolved? how does textualCategories impact APIs ?

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

microsoft-github-policy-service · 2025-02-14T08:29:34Z

@divang please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

Definitions.
“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to Microsoft under this Agreement.
“Project” means any of the projects owned or managed by Microsoft and offered under a license
approved by the Open Source Initiative (www.opensource.org).
“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.
Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.
Originality of Work. You represent that each of Your Submissions is entirely Your original work.
Should You wish to Submit materials that are not Your original work, You may Submit them separately
to the Project if You (a) retain all copyright and license information that was in the materials as You
received them, (b) in the description accompanying Your Submission, include the phrase “Submission
containing materials of a third party:” followed by the names of the third party and any licenses or other
restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
guidelines concerning Submissions.
Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.
Licenses.

Copyright License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
parties.
Patent License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.
Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
You later become aware that would make Your representations in this Agreement inaccurate in any
respect.
Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.
Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.
Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

…t, and fixed existing scenarios when enabling escapeDelimiter.

lilgreenbird and others added 2 commits November 28, 2024 13:16

JSON feature extension

17e21c1

Added JSON data type support in DataTypes

b480490

divang marked this pull request as draft December 10, 2024 20:23

Divang Sharma added 5 commits December 11, 2024 02:05

JSON startegy in DTV

1f2b95b

Fix Json character encoding and JSON constants.

e102633

Added JSON datatype test case

d994fec

Added JSON datatype test cases in ResultSet, TVP and Regression scena…

c164ef9

…rios.

Added JSON datatype support

f9db4f7

machavan reviewed Dec 19, 2024

View reviewed changes

src/test/java/com/microsoft/sqlserver/jdbc/unit/statement/RegressionTest.java Show resolved Hide resolved

Added JSON support in IOBuffer.java

dff9280

Ananya2 added 2 commits January 3, 2025 11:27

Json datatype support: SQLServerCallableStatement

0e7a053

Updated callableStatementTest.java

a8ebfd3

divang commented Jan 3, 2025

View reviewed changes

src/test/java/com/microsoft/sqlserver/jdbc/callablestatement/CallableStatementTest.java Outdated Show resolved Hide resolved

Divang Sharma and others added 8 commits January 9, 2025 18:31

Merge branch 'main' into user/divang/json-datatype-support

952e37e

Added test cases for the TVP type in Callable Statements.

44a185b

Fixed JSON op.execute method mapping

dc53208

Merge branch 'user/divang/json-datatype-support' of https://github.co…

508a1b9

…m/microsoft/mssql-jdbc into user/divang/json-datatype-support

Fixed Store procedure output param TDS metadata and fixed bulk copy t…

fd21d1a

…ype conversion

Fixed BulkCopy JSON datatype issue.

07bea45

Removed duplicate code and used existing method to solve Bulk opy iss…

afb3753

…ues.

Added test cases for Bulk copy

9c4a401

lilgreenbird reviewed Feb 12, 2025

View reviewed changes

src/main/java/microsoft/sql/Types.java Show resolved Hide resolved

lilgreenbird reviewed Feb 12, 2025

View reviewed changes

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

lilgreenbird reviewed Feb 12, 2025

View reviewed changes

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

lilgreenbird requested changes Feb 12, 2025

View reviewed changes

Divang Sharma added 4 commits February 12, 2025 12:13

Enhanced JSON datatype regression test

961f557

Fixed formatting in dtv.java

a9042bf

Removed additional empty line in dtv.java

a719e0a

Added JSON metadata test case

9bac0eb

divang self-assigned this Feb 12, 2025

Merge remote-tracking branch 'origin/main' into user/divang/json-data…

9bf9ffa

…type-support

divang marked this pull request as ready for review February 12, 2025 09:54

tkyc reviewed Feb 12, 2025

View reviewed changes

David-Engel previously approved these changes Feb 13, 2025

View reviewed changes

saurabh500 reviewed Feb 14, 2025

View reviewed changes

Added JSON support for BulkCopyCSV, included test cases to validate i…

cd28b53

…t, and fixed existing scenarios when enabling escapeDelimiter.

Ananya2 dismissed David-Engel’s stale review via cd28b53 February 14, 2025 08:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JSON datatype support #2558

JSON datatype support #2558

divang commented Dec 6, 2024 •

edited

Loading

codecov bot commented Dec 6, 2024 •

edited

Loading

lilgreenbird commented Dec 19, 2024

azure-pipelines bot commented Dec 19, 2024

azure-pipelines bot commented Dec 19, 2024

lilgreenbird commented Dec 19, 2024

lilgreenbird commented Dec 19, 2024

azure-pipelines bot commented Dec 19, 2024

azure-pipelines bot commented Dec 19, 2024

lilgreenbird left a comment

tkyc Feb 12, 2025

saurabh500 commented Feb 14, 2025

saurabh500 Feb 14, 2025

saurabh500 Feb 14, 2025

microsoft-github-policy-service bot commented Feb 14, 2025

Contribution License Agreement

JSON datatype support #2558

Are you sure you want to change the base?

JSON datatype support #2558

Conversation

divang commented Dec 6, 2024 • edited Loading

codecov bot commented Dec 6, 2024 • edited Loading

Codecov Report

lilgreenbird commented Dec 19, 2024

azure-pipelines bot commented Dec 19, 2024

azure-pipelines bot commented Dec 19, 2024

lilgreenbird commented Dec 19, 2024

lilgreenbird commented Dec 19, 2024

azure-pipelines bot commented Dec 19, 2024

azure-pipelines bot commented Dec 19, 2024

lilgreenbird left a comment

Choose a reason for hiding this comment

tkyc Feb 12, 2025

Choose a reason for hiding this comment

saurabh500 commented Feb 14, 2025

saurabh500 Feb 14, 2025

Choose a reason for hiding this comment

saurabh500 Feb 14, 2025

Choose a reason for hiding this comment

microsoft-github-policy-service bot commented Feb 14, 2025

Contribution License Agreement

divang commented Dec 6, 2024 •

edited

Loading

codecov bot commented Dec 6, 2024 •

edited

Loading