JSON datatype support

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

@@ -336,7 +336,7 @@ else if (jdbcType.isBinary()) {
 
         // Update of Unicode SSType from textual JDBCType: Use Unicode.
         if ((SSType.NCHAR == ssType || SSType.NVARCHAR == ssType || SSType.NVARCHARMAX == ssType
-                || SSType.NTEXT == ssType || SSType.XML == ssType) &&
+                || SSType.NTEXT == ssType || SSType.XML == ssType || SSType.JSON == ssType) &&
 
                 (JDBCType.CHAR == jdbcType || JDBCType.VARCHAR == jdbcType || JDBCType.LONGVARCHAR == jdbcType
                         || JDBCType.CLOB == jdbcType)) {

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

@@ -65,6 +65,7 @@ enum TDSType {
     NTEXT(0x63), // 99
     UDT(0xF0), // -16
     XML(0xF1), // -15
+    JSON(0xF4), // -12
 
     // LONGLEN types
     SQL_VARIANT(0x62); // 98
@@ -148,7 +149,8 @@ enum SSType {
     XML(Category.XML, "xml", JDBCType.LONGNVARCHAR),
     TIMESTAMP(Category.TIMESTAMP, "timestamp", JDBCType.BINARY),
     GEOMETRY(Category.UDT, "geometry", JDBCType.GEOMETRY),
-    GEOGRAPHY(Category.UDT, "geography", JDBCType.GEOGRAPHY);
+    GEOGRAPHY(Category.UDT, "geography", JDBCType.GEOGRAPHY),
+    JSON(Category.JSON, "json", JDBCType.LONGNVARCHAR);
 
     final Category category;
     private final String name;
@@ -204,7 +206,8 @@ enum Category {
         TIMESTAMP,
         UDT,
         SQL_VARIANT,
-        XML;
+        XML,
+        JSON;
 
         private static final Category[] VALUES = values();
     }
@@ -266,7 +269,12 @@ enum GetterConversion {
 
         SQL_VARIANT(SSType.Category.SQL_VARIANT, EnumSet.of(JDBCType.Category.CHARACTER, JDBCType.Category.SQL_VARIANT,
                 JDBCType.Category.NUMERIC, JDBCType.Category.DATE, JDBCType.Category.TIME, JDBCType.Category.BINARY,
-                JDBCType.Category.TIMESTAMP, JDBCType.Category.NCHARACTER, JDBCType.Category.GUID));
+                JDBCType.Category.TIMESTAMP, JDBCType.Category.NCHARACTER, JDBCType.Category.GUID)),
+
+        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,
+                JDBCType.Category.BLOB, JDBCType.Category.JSON));    
 
         private final SSType.Category from;
         private final EnumSet<JDBCType.Category> to;
@@ -450,6 +458,7 @@ JDBCType getJDBCType(SSType ssType, JDBCType jdbcTypeFromApp) {
                     case NVARCHAR:
                     case NVARCHARMAX:
                     case NTEXT:
+                    case JSON:
                         jdbcType = JDBCType.LONGVARCHAR;
                         break;
 
@@ -673,8 +682,9 @@ enum JDBCType {
     SQL_VARIANT(Category.SQL_VARIANT, microsoft.sql.Types.SQL_VARIANT, Object.class.getName()),
     GEOMETRY(Category.GEOMETRY, microsoft.sql.Types.GEOMETRY, Object.class.getName()),
     GEOGRAPHY(Category.GEOGRAPHY, microsoft.sql.Types.GEOGRAPHY, Object.class.getName()),
-    LOCALDATETIME(Category.TIMESTAMP, java.sql.Types.TIMESTAMP, LocalDateTime.class.getName());
-
+    LOCALDATETIME(Category.TIMESTAMP, java.sql.Types.TIMESTAMP, LocalDateTime.class.getName()),
+    JSON(Category.JSON, microsoft.sql.Types.JSON, Object.class.getName());
+
     final Category category;
     private final int intValue;
     private final String className;
@@ -722,7 +732,8 @@ enum Category {
         GUID,
         SQL_VARIANT,
         GEOMETRY,
-        GEOGRAPHY;
+        GEOGRAPHY,
+        JSON;
 
         private static final Category[] VALUES = values();
     }
@@ -795,7 +806,8 @@ enum SetterConversion {
 
         GEOMETRY(JDBCType.Category.GEOMETRY, EnumSet.of(JDBCType.Category.GEOMETRY)),
 
-        GEOGRAPHY(JDBCType.Category.GEOGRAPHY, EnumSet.of(JDBCType.Category.GEOGRAPHY));
+        GEOGRAPHY(JDBCType.Category.GEOGRAPHY, EnumSet.of(JDBCType.Category.GEOGRAPHY)),
+        JSON(JDBCType.Category.JSON, EnumSet.of(JDBCType.Category.JSON));    
 
         private final JDBCType.Category from;
         private final EnumSet<JDBCType.Category> to;
@@ -895,7 +907,9 @@ enum UpdaterConversion {
                 SSType.Category.DATETIMEOFFSET, SSType.Category.CHARACTER, SSType.Category.LONG_CHARACTER,
                 SSType.Category.NCHARACTER, SSType.Category.LONG_NCHARACTER)),
 
-        SQL_VARIANT(JDBCType.Category.SQL_VARIANT, EnumSet.of(SSType.Category.SQL_VARIANT));
+        SQL_VARIANT(JDBCType.Category.SQL_VARIANT, EnumSet.of(SSType.Category.SQL_VARIANT)),
+
+        JSON(JDBCType.Category.JSON, EnumSet.of(SSType.Category.JSON));
 
         private final JDBCType.Category from;
         private final EnumSet<SSType.Category> to;
@@ -970,7 +984,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?
 
     boolean isTextual() {
         return textualCategories.contains(category);
@@ -997,6 +1011,7 @@ int asJavaSqlType() {
                     return java.sql.Types.CHAR;
                 case NVARCHAR:
                 case SQLXML:
+                case JSON:
                     return java.sql.Types.VARCHAR;
                 case LONGNVARCHAR:
                     return java.sql.Types.LONGVARCHAR;

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

@@ -169,6 +169,11 @@ final class TDS {
     static final byte TDS_FEATURE_EXT_AZURESQLDNSCACHING = 0x0B;
     static final byte TDS_FEATURE_EXT_SESSIONRECOVERY = 0x01;
 
+    // JSON support
+    static final byte TDS_FEATURE_EXT_JSONSUPPORT = 0x0D;
+    static final byte JSONSUPPORT_NOT_SUPPORTED = 0x00;
+    static final byte MAX_JSONSUPPORT_VERSION = 0x01;
+
     static final int TDS_TVP = 0xF3;
     static final int TVP_ROW = 0x01;
     static final int TVP_NULL_TOKEN = 0xFFFF;
@@ -237,6 +242,9 @@ static final String getTokenName(int tdsTokenType) {
                 return "TDS_FEATURE_EXT_AZURESQLDNSCACHING (0x0B)";
             case TDS_FEATURE_EXT_SESSIONRECOVERY:
                 return "TDS_FEATURE_EXT_SESSIONRECOVERY (0x01)";
+            case TDS_FEATURE_EXT_JSONSUPPORT:
+                return "TDS_FEATURE_EXT_JSONSUPPORT (0x0D)";
+
             default:
                 return "unknown token (0x" + Integer.toHexString(tdsTokenType).toUpperCase() + ")";
         }

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

@@ -899,7 +899,9 @@ private void setTypeDefinition(DTV dtv) {
                 case SQLXML:
                     param.typeDefinition = SSType.XML.toString();
                     break;
-
+                case JSON:
+                    param.typeDefinition = SSType.JSON.toString();
+                    break;
                 case TVP:
                     // definition should contain the TVP name and the keyword READONLY
                     String schema = param.schemaName;

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

@@ -1021,6 +1021,16 @@ byte getServerSupportedDataClassificationVersion() {
         return serverSupportedDataClassificationVersion;
     }
 
+    /** whether server supports JSON */
+    private boolean serverSupportsJSON = false;
+
+    /** server supported JSON version */
+    private byte serverSupportedJSONVersion = TDS.JSONSUPPORT_NOT_SUPPORTED;
+
+    boolean getServerSupportsJSON() {
+        return serverSupportsJSON;
+    }
+
     /** Boolean that indicates whether LOB objects created by this connection should be loaded into memory */
     private boolean delayLoadingLobs = SQLServerDriverBooleanProperty.DELAY_LOADING_LOBS.getDefaultValue();
 
@@ -5340,6 +5350,17 @@ int writeDNSCacheFeatureRequest(boolean write, /* if false just calculates the l
         return len;
     }
 
+    int writeJSONSupportFeatureRequest(boolean write, /* if false just calculates the length */
+            TDSWriter tdsWriter) throws SQLServerException {
+        int len = 6; // 1byte = featureID, 4bytes = featureData length, 1 bytes = Version
+        if (write) {
+            tdsWriter.writeByte(TDS.TDS_FEATURE_EXT_JSONSUPPORT);
+            tdsWriter.writeInt(1);
+            tdsWriter.writeByte(TDS.MAX_JSONSUPPORT_VERSION);
+        }
+        return len;
+    }
+
     int writeIdleConnectionResiliencyRequest(boolean write, TDSWriter tdsWriter) throws SQLServerException {
         SessionStateTable ssTable = sessionRecovery.getSessionStateTable();
         int len = 1;
@@ -6469,6 +6490,24 @@ private void onFeatureExtAck(byte featureId, byte[] data) throws SQLServerExcept
                 sessionRecovery.setConnectionRecoveryPossible(true);
                 break;
             }
+
+            case TDS.TDS_FEATURE_EXT_JSONSUPPORT: {
+                if (connectionlogger.isLoggable(Level.FINER)) {
+                    connectionlogger.fine(toString() + " Received feature extension acknowledgement for JSON Support.");
+                }
+
+                if (1 != data.length) {
+                    throw new SQLServerException(SQLServerException.getErrString("R_unknownJSONSupportValue"), null);
+                }
+
+                serverSupportedJSONVersion = data[0];
+                if (0 == serverSupportedJSONVersion || serverSupportedJSONVersion > TDS.MAX_JSONSUPPORT_VERSION) {
+                    throw new SQLServerException(SQLServerException.getErrString("R_InvalidJSONVersionNumber"), null);
+                }
+                serverSupportsJSON = true;
+                break;
+            }
+
             default: {
                 // Unknown feature ack
                 throw new SQLServerException(SQLServerException.getErrString("R_UnknownFeatureAck"), null);
@@ -6768,6 +6807,9 @@ final boolean complete(LogonCommand logonCommand, TDSReader tdsReader) throws SQ
 
         len = len + writeDNSCacheFeatureRequest(false, tdsWriter);
 
+        // request JSON support
+        len += writeJSONSupportFeatureRequest(false, tdsWriter);
+
         len = len + 1; // add 1 to length because of FeatureEx terminator
 
         // Idle Connection Resiliency is requested
@@ -6964,6 +7006,7 @@ final boolean complete(LogonCommand logonCommand, TDSReader tdsReader) throws SQ
         writeDataClassificationFeatureRequest(true, tdsWriter);
         writeUTF8SupportFeatureRequest(true, tdsWriter);
         writeDNSCacheFeatureRequest(true, tdsWriter);
+        writeJSONSupportFeatureRequest(true, tdsWriter);
 
         // Idle Connection Resiliency is requested
         if (connectRetryCount > 0) {

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

@@ -300,6 +300,7 @@ private void internalAddrow(JDBCType jdbcType, Object val, Object[] rowValues,
                 case LONGVARCHAR:
                 case LONGNVARCHAR:
                 case SQLXML:
+                case JSON:
                     if (val instanceof UUID)
                         val = val.toString();
                     nValueLen = (2 * ((String) val).length());

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

@@ -166,6 +166,8 @@ private void parseQueryMeta(ResultSet rsQueryMeta) throws SQLServerException {
                             qm.precision = 8;
                         } else if (SSType.XML == ssType) {
                             qm.precision = SQLServerDatabaseMetaData.MAXLOBSIZE / 2;
+                        }  else if (SSType.JSON == ssType) {
+                            qm.precision = SQLServerDatabaseMetaData.MAXLOBSIZE / 2;
                         }
 
                         qm.parameterTypeName = ssType.toString();

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

@@ -311,6 +311,7 @@ protected Object[][] getContents() {
         {"R_StreamingDataTypeAE", "Data of length greater than {0} is not supported in encrypted {1} column."},
         {"R_AE_NotSupportedByServer", "SQL Server in use does not support column encryption."},
         {"R_InvalidAEVersionNumber", "Received invalid version number \"{0}\" for Always Encrypted."}, // From server
+        {"R_InvalidJSONVersionNumber", "Received invalid version number \"{0}\" for JSON."},
         {"R_NullEncryptedColumnEncryptionKey", "Internal error. Encrypted column encryption key cannot be null."},
         {"R_EmptyEncryptedColumnEncryptionKey", "Internal error. Empty encrypted column encryption key specified."},
         {"R_InvalidMasterKeyDetails", "Invalid master key details specified."},
@@ -470,6 +471,7 @@ protected Object[][] getContents() {
         {"R_InvalidDataClsVersionNumber", "Invalid version number {0} for Data Classification."}, // From Server
         {"R_unknownUTF8SupportValue", "Unknown value for UTF8 support."},
         {"R_unknownAzureSQLDNSCachingValue", "Unknown value for Azure SQL DNS Caching."},
+        {"R_unknownJSONSupportValue", "Unknown value for JSON support."},
         {"R_illegalWKT", "Illegal Well-Known text. Please make sure Well-Known text is valid."},
         {"R_illegalTypeForGeometry", "{0} is not supported for Geometry."},
         {"R_illegalWKTposition", "Illegal character in Well-Known text at position {0}."},

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

@@ -288,6 +288,7 @@ public boolean isSearchable(int column) throws SQLServerException {
             case NTEXT:
             case UDT:
             case XML:
+            case JSON:
                 return false;
 
             default:

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

@@ -115,6 +115,7 @@ abstract class DTVExecuteOp {
     abstract void execute(DTV dtv, TVP tvpValue) throws SQLServerException;
 
     abstract void execute(DTV dtv, SqlVariant sqlVariantValue) throws SQLServerException;
+
 }
 
 
@@ -1518,6 +1519,7 @@ final void executeOp(DTVExecuteOp op) throws SQLServerException {
                 case VARCHAR:
                 case LONGVARCHAR:
                 case CLOB:
+                case JSON:
                     op.execute(this, (byte[]) null);
                     break;
 
@@ -2989,6 +2991,25 @@ public void apply(TypeInfo typeInfo, TDSReader tdsReader) throws SQLServerExcept
                 typeInfo.maxLength = tdsReader.readInt();
                 typeInfo.ssType = SSType.SQL_VARIANT;
             }
+        }),
+
+        JSON(TDSType.JSON, new Strategy() {
+            /**
+             * Sets the fields of typeInfo to the correct values
+             * 
+             * @param typeInfo
+             *        the TypeInfo whos values are being corrected
+             * @param tdsReader
+             *        the TDSReader used to set the fields of typeInfo to the correct values
+             * @throws SQLServerException
+             *         when an error occurs
+             */
+            public void apply(TypeInfo typeInfo, TDSReader tdsReader) throws SQLServerException {
+                typeInfo.ssLenType = SSLenType.PARTLENTYPE; 
+                typeInfo.ssType = SSType.JSON;
+                typeInfo.displaySize = typeInfo.precision = Integer.MAX_VALUE / 2;
+                typeInfo.charset = Encoding.UTF8.charset();
+            }
         });
 
         private final TDSType tdsType;
@@ -3737,6 +3758,7 @@ Object getValue(DTV dtv, JDBCType jdbcType, int scale, InputStreamGetterArgs str
                 case VARBINARYMAX:
                 case VARCHARMAX:
                 case NVARCHARMAX:
+                case JSON:
                 case UDT: {
                     convertedValue = DDC.convertStreamToObject(
                             PLPInputStream.makeStream(tdsReader, streamGetterArgs, this), typeInfo, jdbcType,

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

@@ -74,4 +74,10 @@ private Types() {
      * Microsoft SQL type GEOGRAPHY.
      */
     public static final int GEOGRAPHY = -158;
+
+    /**
+     * The constant in the Java programming language, sometimes referred to as a type code, that identifies the
+     * Microsoft SQL type JSON.
+     */
+    public static final int JSON = -159;
 }

src/test/java/com/microsoft/sqlserver/jdbc/resultset/ResultSetTest.java

@@ -100,7 +100,7 @@ public void testJdbc41ResultSetMethods() throws SQLException {
                     + "col2 varchar(512), " + "col3 float, " + "col4 decimal(10,5), " + "col5 uniqueidentifier, "
                     + "col6 xml, " + "col7 varbinary(max), " + "col8 text, " + "col9 ntext, " + "col10 varbinary(max), "
                     + "col11 date, " + "col12 time, " + "col13 datetime2, " + "col14 datetimeoffset, "
-                    + "col15 decimal(10,9), " + "col16 decimal(38,38), "
+                    + "col15 decimal(10,9), " + "col16 decimal(38,38), " + "col17 json, "
                     + "order_column int identity(1,1) primary key)");
             try {
 
@@ -120,12 +120,13 @@ public void testJdbc41ResultSetMethods() throws SQLException {
                                 + "'2017-05-19T10:47:15.1234567'," // col13
                                 + "'2017-05-19T10:47:15.1234567+02:00'," // col14
                                 + "0.123456789, " // col15
-                                + "0.1234567890123456789012345678901234567" // col16
+                                + "0.1234567890123456789012345678901234567, " // col16
+                                + "'{\"test\":\"123\"}'" // col17
                                 + ")");
 
                 stmt.executeUpdate("Insert into " + AbstractSQLGenerator.escapeIdentifier(tableName) + " values("
                         + "null, " + "null, " + "null, " + "null, " + "null, " + "null, " + "null, " + "null, "
-                        + "null, " + "null, " + "null, " + "null, " + "null, " + "null, " + "null, " + "null)");
+                        + "null, " + "null, " + "null, " + "null, " + "null, " + "null, " + "null, " + "null, " + "null)");
 
                 try (ResultSet rs = stmt.executeQuery("select * from "
                         + AbstractSQLGenerator.escapeIdentifier(tableName) + " order by order_column")) {
@@ -223,7 +224,11 @@ public void testJdbc41ResultSetMethods() throws SQLException {
                             .compareTo(new BigDecimal("0.12345678901234567890123456789012345670")));
                     assertEquals(0, rs.getObject("col16", BigDecimal.class)
                             .compareTo(new BigDecimal("0.12345678901234567890123456789012345670")));
-
+
+                    String expectedJsonValue = "{\"test\":\"123\"}";        
+                    assertEquals(expectedJsonValue, rs.getObject(17).toString());
+                    assertEquals(expectedJsonValue, rs.getObject("col17").toString());
+
                     // test null values, mostly to verify primitive wrappers do not return default values
                     assertTrue(rs.next());
                     assertNull(rs.getObject("col1", Boolean.class));
@@ -284,6 +289,9 @@ public void testJdbc41ResultSetMethods() throws SQLException {
                     assertNull(rs.getObject(16, BigDecimal.class));
                     assertNull(rs.getObject("col16", BigDecimal.class));
 
+                    assertNull(rs.getObject(17));
+                    assertNull(rs.getObject("col17"));
+
                     assertFalse(rs.next());
                 }
             } finally {