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.JSON); 
 
     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;
@@ -452,7 +460,9 @@ JDBCType getJDBCType(SSType ssType, JDBCType jdbcTypeFromApp) {
                     case NTEXT:
                         jdbcType = JDBCType.LONGVARCHAR;
                         break;
-
+                    case JSON:
+                        jdbcType = JDBCType.JSON;
+                        break;
                     case XML:
                     default:
                         jdbcType = JDBCType.LONGVARBINARY;
@@ -673,8 +683,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 +733,8 @@ enum Category {
         GUID,
         SQL_VARIANT,
         GEOMETRY,
-        GEOGRAPHY;
+        GEOGRAPHY,
+        JSON;
 
         private static final Category[] VALUES = values();
     }
@@ -733,7 +745,7 @@ enum SetterConversion {
                 JDBCType.Category.TIME, JDBCType.Category.TIMESTAMP, JDBCType.Category.DATETIMEOFFSET,
                 JDBCType.Category.CHARACTER, JDBCType.Category.LONG_CHARACTER, JDBCType.Category.NCHARACTER,
                 JDBCType.Category.LONG_NCHARACTER, JDBCType.Category.BINARY, JDBCType.Category.LONG_BINARY,
-                JDBCType.Category.GUID, JDBCType.Category.SQL_VARIANT)),
+                JDBCType.Category.GUID, JDBCType.Category.SQL_VARIANT, JDBCType.Category.JSON)),
 
         LONG_CHARACTER(JDBCType.Category.LONG_CHARACTER, EnumSet.of(JDBCType.Category.CHARACTER,
                 JDBCType.Category.LONG_CHARACTER, JDBCType.Category.NCHARACTER, JDBCType.Category.LONG_NCHARACTER,
@@ -795,7 +807,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;
@@ -832,7 +845,7 @@ enum UpdaterConversion {
                 SSType.Category.DATETIMEOFFSET, SSType.Category.CHARACTER, SSType.Category.LONG_CHARACTER,
                 SSType.Category.NCHARACTER, SSType.Category.LONG_NCHARACTER, SSType.Category.XML,
                 SSType.Category.BINARY, SSType.Category.LONG_BINARY, SSType.Category.UDT, SSType.Category.GUID,
-                SSType.Category.TIMESTAMP, SSType.Category.SQL_VARIANT)),
+                SSType.Category.TIMESTAMP, SSType.Category.SQL_VARIANT, SSType.Category.JSON)),
 
         LONG_CHARACTER(JDBCType.Category.LONG_CHARACTER, EnumSet.of(SSType.Category.CHARACTER,
                 SSType.Category.LONG_CHARACTER, SSType.Category.NCHARACTER, SSType.Category.LONG_NCHARACTER,
@@ -895,7 +908,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 +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?
 
     boolean isTextual() {
         return textualCategories.contains(category);
@@ -997,6 +1012,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() + ")";
         }
@@ -4856,6 +4864,12 @@ void writeRPCStringUnicode(String sValue) throws SQLServerException {
         writeRPCStringUnicode(null, sValue, false, null);
     }
 
+    void writeRPCJson(String sName, String sValue, boolean bOut,
+            SQLCollation collation) throws SQLServerException {
+        writeRPCNameValType(sName, bOut, TDSType.JSON);
+        writeLong(0xFFFFFFFFFFFFFFFFL);
+    }
+
     /**
      * Writes a string value as Unicode for RPC
      * 
@@ -5241,6 +5255,7 @@ private void writeInternalTVPRowValues(JDBCType jdbcType, String currentColumnSt
             case LONGVARCHAR:
             case LONGNVARCHAR:
             case SQLXML:
+            case JSON:
                 isShortValue = (2L * columnPair.getValue().precision) <= DataTypes.SHORT_VARTYPE_MAX_BYTES;
                 isNull = (null == currentColumnStringValue);
                 dataLength = isNull ? 0 : currentColumnStringValue.length() * 2;
@@ -5476,6 +5491,7 @@ void writeTVPColumnMetaData(TVP value) throws SQLServerException {
                 case LONGVARCHAR:
                 case LONGNVARCHAR:
                 case SQLXML:
+                case JSON:
                     writeByte(TDSType.NVARCHAR.byteValue());
                     isShortValue = (2L * pair.getValue().precision) <= DataTypes.SHORT_VARTYPE_MAX_BYTES;
                     // Use PLP encoding on Yukon and later with long values

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/SQLServerBulkCSVFileRecord.java

@@ -545,6 +545,10 @@ else if ((null != columnNames) && (columnNames.length >= positionInSource))
                 columnMetadata.put(positionInSource,
                         new ColumnMetadata(colName, java.sql.Types.LONGNVARCHAR, precision, scale, dateTimeFormatter));
                 break;
+            case microsoft.sql.Types.JSON:
+                columnMetadata.put(positionInSource,
+                        new ColumnMetadata(colName, microsoft.sql.Types.JSON, precision, scale, dateTimeFormatter));
+                break;    
             /*
              * Redirecting Float as Double based on data type mapping
              * https://msdn.microsoft.com/library/ms378878%28v=sql.110%29.aspx

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

@@ -1025,7 +1025,14 @@ private void writeTypeInfo(TDSWriter tdsWriter, int srcJdbcType, int srcScale, i
                 }
                 collation.writeCollation(tdsWriter);
                 break;
-
+            case microsoft.sql.Types.JSON: // 0x62
+                tdsWriter.writeByte(TDSType.JSON.byteValue());
+                if (isStreaming) {
+                    tdsWriter.writeShort((short) 0xFFFF);
+                } else {
+                    tdsWriter.writeShort(isBaseType ? (short) (srcPrecision) : (short) (2 * srcPrecision));
+                }
+                break; 
             case java.sql.Types.BINARY: // 0xAD
                 tdsWriter.writeByte(TDSType.BIGBINARY.byteValue());
                 tdsWriter.writeShort((short) (srcPrecision));
@@ -1127,7 +1134,7 @@ private void writeTypeInfo(TDSWriter tdsWriter, int srcJdbcType, int srcScale, i
             case microsoft.sql.Types.SQL_VARIANT: // 0x62
                 tdsWriter.writeByte(TDSType.SQL_VARIANT.byteValue());
                 tdsWriter.writeInt(TDS.SQL_VARIANT_LENGTH);
-                break;
+                break;   
             default:
                 MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_BulkTypeNotSupported"));
                 String unsupportedDataType = JDBCType.of(srcJdbcType).toString().toLowerCase(Locale.ENGLISH);
@@ -1470,6 +1477,8 @@ private String getDestTypeFromSrcType(int srcColIndx, int destColIndx,
                 }
             case microsoft.sql.Types.SQL_VARIANT:
                 return SSType.SQL_VARIANT.toString();
+            case microsoft.sql.Types.JSON:
+                return SSType.JSON.toString();    
             default: {
                 MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_BulkTypeNotSupported"));
                 Object[] msgArgs = {JDBCType.of(bulkJdbcType).toString().toLowerCase(Locale.ENGLISH)};
@@ -2090,6 +2099,7 @@ private void writeNullToTdsWriter(TDSWriter tdsWriter, int srcJdbcType,
             case java.sql.Types.LONGVARCHAR:
             case java.sql.Types.LONGNVARCHAR:
             case java.sql.Types.LONGVARBINARY:
+            case microsoft.sql.Types.JSON:
                 if (isStreaming) {
                     tdsWriter.writeLong(PLPInputStream.PLP_NULL);
                 } else {
@@ -2161,6 +2171,7 @@ else if (null != sourceCryptoMeta) {
                 case java.sql.Types.TIME:
                 case java.sql.Types.TIMESTAMP:
                 case microsoft.sql.Types.DATETIMEOFFSET:
+                case microsoft.sql.Types.JSON:
                     bulkJdbcType = java.sql.Types.VARCHAR;
                     break;
                 default:
@@ -2419,6 +2430,7 @@ else if (null != sourceCryptoMeta) {
                 case java.sql.Types.LONGNVARCHAR:
                 case java.sql.Types.NCHAR:
                 case java.sql.Types.NVARCHAR:
+                case microsoft.sql.Types.JSON:
                     if (isStreaming) {
                         // PLP_BODY rule in TDS
                         // Use ResultSet.getString for non-streaming data and ResultSet.getNCharacterStream() for
@@ -2986,6 +2998,7 @@ private Object readColumnFromResultSet(int srcColOrdinal, int srcJdbcType, boole
                 case java.sql.Types.LONGNVARCHAR:
                 case java.sql.Types.NCHAR:
                 case java.sql.Types.NVARCHAR:
+                case microsoft.sql.Types.JSON:
                     // PLP if stream type and both the source and destination are not encrypted
                     // This is because AE does not support streaming types.
                     // Therefore an encrypted source or destination means the data must not actually be streaming data
@@ -3060,7 +3073,8 @@ private void writeColumn(TDSWriter tdsWriter, int srcColOrdinal, int destColOrdi
         destPrecision = destColumnMetadata.get(destColOrdinal).precision;
 
         if ((java.sql.Types.NCHAR == srcJdbcType) || (java.sql.Types.NVARCHAR == srcJdbcType)
-                || (java.sql.Types.LONGNVARCHAR == srcJdbcType)) {
+                || (java.sql.Types.LONGNVARCHAR == srcJdbcType)
+                || (microsoft.sql.Types.JSON == srcJdbcType)) {
             isStreaming = (DataTypes.SHORT_VARTYPE_MAX_CHARS < srcPrecision)
                     || (DataTypes.SHORT_VARTYPE_MAX_CHARS < destPrecision);
         } else {
@@ -3771,6 +3785,7 @@ void setDestinationTableMetadata(SQLServerResultSet rs) {
     private boolean unicodeConversionRequired(int jdbcType, SSType ssType) {
         return ((java.sql.Types.CHAR == jdbcType || java.sql.Types.VARCHAR == jdbcType
                 || java.sql.Types.LONGNVARCHAR == jdbcType)
-                && (SSType.NCHAR == ssType || SSType.NVARCHAR == ssType || SSType.NVARCHARMAX == ssType));
+                && (SSType.NCHAR == ssType || SSType.NVARCHAR == ssType || SSType.NVARCHARMAX == ssType
+                || SSType.JSON == ssType));
     }
 }

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();
 
@@ -5333,6 +5343,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;
@@ -6462,6 +6483,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);
@@ -6761,6 +6800,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
@@ -6957,6 +6999,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();