Skip to content

[VECTOR_FLOAT16] Implement feature extension and version negotiation for Vector v2 support #2868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
muskan124947 wants to merge 8 commits into
base: main
Choose a base branch
from
+183 −34
Open

[VECTOR_FLOAT16] Implement feature extension and version negotiation for Vector v2 support #2868

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
88084ba
Add support for v2 version for vector
muskan124947 Dec 22, 2025
61c6f75
Add driver property for vector support
muskan124947 Dec 22, 2025
5779d28
Update negotiation logic
muskan124947 Dec 23, 2025
f2aa7ce
Update vectorTypeSupport enum
muskan124947 Dec 23, 2025
e45a182
Merge branch 'main' into vector_FE_v2
muskan124947 Jan 6, 2026
c8a97c2
Updated negotiation logic
muskan124947 Jan 6, 2026
e389d57
Merge branch 'main' into vector_FE_v2
muskan124947 Feb 4, 2026
f09d152
Addressed copilot generated comments
muskan124947 Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/main/java/com/microsoft/sqlserver/jdbc/IOBuffer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,11 @@ final class TDS {

// Vector support
static final byte TDS_FEATURE_EXT_VECTORSUPPORT = 0x0E;
static final byte VECTORSUPPORT_NOT_SUPPORTED = 0x00;
static final byte MAX_VECTORSUPPORT_VERSION = 0x01;
static final byte VECTORSUPPORT_NOT_SUPPORTED = 0x00; // vector not supported; will return json formatted string
static final byte VECTORSUPPORT_VERSION_1 = 0x01; // supports float32 vector type
static final byte VECTORSUPPORT_VERSION_2 = 0x02; // supports float32 and float16 vector types
static final byte MAX_VECTORSUPPORT_VERSION = 0x02;

// JSON support
static final byte TDS_FEATURE_EXT_JSONSUPPORT = 0x0D;
static final byte JSONSUPPORT_NOT_SUPPORTED = 0x00;
Expand Down
7 changes: 5 additions & 2 deletions src/main/java/com/microsoft/sqlserver/jdbc/ISQLServerConnection.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -658,7 +658,10 @@ CallableStatement prepareCall(String sql, int nType, int nConcur, int nHold,
*
* @param vectorTypeSupport
* A string that indicates the vector type support during connection initialization.
* Valid values are "off" (vector types are returned as strings) and "v1" (vectors of type FLOAT32 are returned as vectors).
* Valid values are :
* - "off" (vector types are returned as strings)
* - "v1" (supports float32 vector type)
* - "v2" (supports float32 and float16 vector types)
* Default is "v1".
*/
void setVectorTypeSupport(String vectorTypeSupport);
Expand All @@ -667,7 +670,7 @@ CallableStatement prepareCall(String sql, int nType, int nConcur, int nHold,
* Returns the value of the vectorTypeSupport connection property.
*
* @return vectorTypeSupport
* The current vector type support setting ("off" or "v1").
* The current vector type support setting ("off"|"v1"|"v2").
*/
String getVectorTypeSupport();

Expand Down
7 changes: 5 additions & 2 deletions src/main/java/com/microsoft/sqlserver/jdbc/ISQLServerDataSource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1090,7 +1090,10 @@ public interface ISQLServerDataSource extends javax.sql.CommonDataSource {
*
* @param vectorTypeSupport
* A string that indicates the vector type support during connection initialization.
* Valid values are "off" (vector types are returned as strings) and "v1" (vectors of type FLOAT32 are returned as vectors).
* Valid values are :
* - "off" (vector types are returned as strings)
* - "v1" (supports float32 vector type)
* - "v2" (supports float32 and float16 vector types)
* Default is "v1".
*/
void setVectorTypeSupport(String vectorTypeSupport);
Expand All @@ -1099,7 +1102,7 @@ public interface ISQLServerDataSource extends javax.sql.CommonDataSource {
* Returns the value of the vectorTypeSupport connection property.
*
* @return vectorTypeSupport
* The current vector type support setting ("off" or "v1").
* The current vector type support setting ("off"|"v1"|"v2").
*/
String getVectorTypeSupport();

Expand Down
113 changes: 94 additions & 19 deletions src/main/java/com/microsoft/sqlserver/jdbc/SQLServerConnection.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -762,9 +762,6 @@ private ActiveDirectoryAuthentication() {
}
}

private static final String VECTOR_SUPPORT_OFF = "off";
private static final String VECTOR_SUPPORT_V1 = "v1";

final static int TNIR_FIRST_ATTEMPT_TIMEOUT_MS = 500; // fraction of timeout to use for fast failover connections

/**
Expand Down Expand Up @@ -1105,16 +1102,26 @@ public void setBulkCopyForBatchInsertAllowEncryptedValueModifications(

/**
* A string that indicates the vector type support during connection initialization.
* Valid values are "off" (vector types are returned as strings) and "v1" (vectors of type FLOAT32 are returned as vectors).
* Valid values are :
* - "off" (vector types are returned as strings)
* - "v1" (supports float32 vector type)
* - "v2" (supports float32 and float16 vector types)
* Default is "v1".
*/
private String vectorTypeSupport = VECTOR_SUPPORT_V1;
private String vectorTypeSupport = SQLServerDriverStringProperty.VECTOR_TYPE_SUPPORT.getDefaultValue();

private VectorTypeSupport vectorTypeSupportEnum = VectorTypeSupport.V1;

/**
* Negotiated vector version between client and server
*/
private byte negotiatedVectorVersion = TDS.VECTORSUPPORT_NOT_SUPPORTED;

/**
* Returns the value of the vectorTypeSupport connection property.
*
* @return vectorTypeSupport
* The current vector type support setting ("off" or "v1").
* The current vector type support setting ("off"|"v1"|"v2").
*/
@Override
public String getVectorTypeSupport() {
Expand All @@ -1126,7 +1133,10 @@ public String getVectorTypeSupport() {
*
* @param vectorTypeSupport
* A string that indicates the vector type support during connection initialization.
* Valid values are "off" (vector types are returned as strings) and "v1" (vectors of type FLOAT32 are returned as vectors).
* Valid values are :
* - "off" (vector types are returned as strings)
* - "v1" (supports float32 vector type)
* - "v2" (supports float32 and float16 vector types)
* Default is "v1".
*/
@Override
Expand All @@ -1136,15 +1146,13 @@ public void setVectorTypeSupport(String vectorTypeSupport) {
Object[] msgArgs = { "null" };
throw new IllegalArgumentException(form.format(msgArgs));
}
switch (vectorTypeSupport.trim().toLowerCase()) {
case VECTOR_SUPPORT_OFF:
case VECTOR_SUPPORT_V1:
this.vectorTypeSupport = vectorTypeSupport.toLowerCase();
break;
default:
MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_invalidVectorTypeSupport"));
Object[] msgArgs = { vectorTypeSupport };
throw new IllegalArgumentException(form.format(msgArgs));
try {
this.vectorTypeSupportEnum = VectorTypeSupport.valueOfString(vectorTypeSupport.trim());
this.vectorTypeSupport = vectorTypeSupport.toLowerCase();
} catch (SQLServerException e) {
MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_invalidVectorTypeSupport"));
Object[] msgArgs = { vectorTypeSupport };
throw new IllegalArgumentException(form.format(msgArgs));
}
}

Expand Down Expand Up @@ -5899,14 +5907,28 @@ int writeUserAgentFeatureRequest(boolean write, /* if false just calculates the
*/
int writeVectorSupportFeatureRequest(boolean write,
TDSWriter tdsWriter) throws SQLServerException {
if (VECTOR_SUPPORT_OFF.equalsIgnoreCase(vectorTypeSupport)) {

// Initialize vectorTypeSupportEnum if not already done.
if (vectorTypeSupportEnum == null) {
try {
vectorTypeSupportEnum = VectorTypeSupport.valueOfString(vectorTypeSupport);
} catch (SQLServerException e) {
// Fallback to value OFF if invalid value is provided.
vectorTypeSupportEnum = VectorTypeSupport.OFF;
}
}

if (vectorTypeSupportEnum == VectorTypeSupport.OFF) {
return 0;
}

int len = 6; // 1byte = featureID, 4bytes = featureData length, 1 bytes = Version
if (write) {
tdsWriter.writeByte(TDS.TDS_FEATURE_EXT_VECTORSUPPORT);
tdsWriter.writeInt(1);
tdsWriter.writeByte(TDS.MAX_VECTORSUPPORT_VERSION);

// write the vector type support version
tdsWriter.writeByte(vectorTypeSupportEnum.getTdsValue());
}
return len;
}
Expand Down Expand Up @@ -7118,7 +7140,20 @@ private void onFeatureExtAck(byte featureId, byte[] data) throws SQLServerExcept
if (0 == serverSupportedVectorVersion || serverSupportedVectorVersion > TDS.MAX_VECTORSUPPORT_VERSION) {
throw new SQLServerException(SQLServerException.getErrString("R_InvalidVectorVersionNumber"), null);
}
serverSupportsVector = true;
// Negotiate the vector version between client and server
negotiatedVectorVersion = negotiateVectorVersion(vectorTypeSupportEnum, serverSupportedVectorVersion);

if (negotiatedVectorVersion > TDS.VECTORSUPPORT_NOT_SUPPORTED) {
serverSupportsVector = true;

if (connectionlogger.isLoggable(Level.FINE)) {
connectionlogger.fine(toString() + " Vector support negotiated. Client: " + vectorTypeSupport +
", Server: " + serverSupportedVectorVersion +
", Negotiated: " + negotiatedVectorVersion);
}
} else {
serverSupportsVector = false;
}
break;
}

Expand Down Expand Up @@ -7154,6 +7189,45 @@ private void onFeatureExtAck(byte featureId, byte[] data) throws SQLServerExcept
}
}

/**
* Negotiates the vector version between client and server based on the
* following rules:
* - If either client or server is "off", negotiated version is "off"
* - If both support v2, negotiated version is v2
* - If both support v1, negotiated version is v1
* - Otherwise, use the minimum supported version
*
* @param clientVectorSupportEnum The client's vector type support setting
* @param serverVersion The server's supported vector version
* @return The negotiated vector version
*/
private byte negotiateVectorVersion(VectorTypeSupport clientVectorSupportEnum, byte serverVersion) {

// If server doesn't support vectors, negotiation is off
if (serverVersion == TDS.VECTORSUPPORT_NOT_SUPPORTED) {
return TDS.VECTORSUPPORT_NOT_SUPPORTED;
}

if (clientVectorSupportEnum == VectorTypeSupport.OFF) {
return TDS.VECTORSUPPORT_NOT_SUPPORTED;
}

byte clientMaxVersion = clientVectorSupportEnum.getTdsValue();

// Negotiate using the minimum supported version
return (byte) Math.min(clientMaxVersion, serverVersion);
Comment on lines +7204 to +7218
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new negotiateVectorVersion logic introduces non-trivial behavior (e.g., handling client OFF vs. server NOT_SUPPORTED, client V2 vs. server V1, etc.), but there do not appear to be tests that directly validate these negotiation outcomes or the negotiatedVectorVersion field. Given that other SQLServerConnection behaviors are covered by tests (for example, see RequestBoundaryMethodsTest.setConnectionFields / compareValuesAgainstConnection), consider adding targeted tests that exercise this negotiation for the key combinations of client and server versions to guard against regressions.

Copilot uses AI. Check for mistakes.

}

/**
* Returns the negotiated vector version between client and server.
*
* @return The negotiated vector version (0 = off, 1 = v1, 2 = v2)
*/
public byte getNegotiatedVectorVersion() {
return negotiatedVectorVersion;
}

/*
* Executes a DTC command
*/
Expand Down Expand Up @@ -7452,6 +7526,7 @@ final boolean complete(LogonCommand logonCommand, TDSReader tdsReader) throws SQ

// request vector support
len += writeVectorSupportFeatureRequest(false, tdsWriter);

// request JSON support
len += writeJSONSupportFeatureRequest(false, tdsWriter);

Expand Down
14 changes: 10 additions & 4 deletions src/main/java/com/microsoft/sqlserver/jdbc/SQLServerConnectionPoolProxy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -893,19 +893,25 @@ public void setBulkCopyForBatchInsertAllowEncryptedValueModifications(boolean bu
}

/**
* Returns the vectorTypeSupport value.
* Returns the value of the vectorTypeSupport connection property.
*
* @return the vectorTypeSupport value.
* @return vectorTypeSupport
* The current vector type support setting ("off"|"v1"|"v2").
*/
public String getVectorTypeSupport() {
return wrappedConnection.getVectorTypeSupport();
}

/**
* Sets the vectorTypeSupport value.
* Sets the value of the vectorTypeSupport connection property.
*
* @param vectorTypeSupport
* the vectorTypeSupport value to set ("off" or "v1").
* A string that indicates the vector type support during connection initialization.
* Valid values are :
* - "off" (vector types are returned as strings)
* - "v1" (supports float32 vector type)
* - "v2" (supports float32 and float16 vector types)
* Default is "v1".
*/
public void setVectorTypeSupport(String vectorTypeSupport) {
wrappedConnection.setVectorTypeSupport(vectorTypeSupport);
Expand Down
63 changes: 61 additions & 2 deletions src/main/java/com/microsoft/sqlserver/jdbc/SQLServerDriver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -501,6 +501,64 @@ static DatetimeType valueOfString(String value) throws SQLServerException {
}
}

enum VectorTypeSupport {
OFF("off", TDS.VECTORSUPPORT_NOT_SUPPORTED),
V1("v1", TDS.VECTORSUPPORT_VERSION_1), //float32 support
V2("v2", TDS.VECTORSUPPORT_VERSION_2); //float32 and float16 support

private final String type;
private final byte tdsValue;

VectorTypeSupport(String type, byte tdsValue) {
this.type = type;
this.tdsValue = tdsValue;
}

@Override
public String toString() {
return type;
}

/**
* Returns the byte value used in TDS communication
*/
public byte getTdsValue() {
return tdsValue;
}

/**
* Returns the string value of vectorTypeSupport
*/
public String getType() {
return type;
}

static VectorTypeSupport valueOfString(String value) throws SQLServerException {
if (value == null) {
throwInvalid(value);
}

switch (value.trim().toLowerCase()) {
case "off":
return VectorTypeSupport.OFF;
case "v1":
return VectorTypeSupport.V1;
case "v2":
return VectorTypeSupport.V2;
default:
throwInvalid(value);
return VectorTypeSupport.OFF; // Never reached
}
}

private static void throwInvalid(String value) throws SQLServerException {
MessageFormat form =
new MessageFormat(SQLServerException.getErrString("R_invalidVectorTypeSupport"));
Object[] msgArgs = {value};
throw new SQLServerException(null, form.format(msgArgs), null, 0, false);
}
}


enum SQLServerDriverObjectProperty {
GSS_CREDENTIAL("gsscredential", null),
Expand Down Expand Up @@ -616,7 +674,7 @@ enum SQLServerDriverStringProperty {
RETRY_CONN("retryConn", ""),
QUOTED_IDENTIFIER("quotedIdentifier", OnOffOption.ON.toString()),
CONCAT_NULL_YIELDS_NULL("concatNullYieldsNull", OnOffOption.ON.toString()),
VECTOR_TYPE_SUPPORT("vectorTypeSupport", "v1");
VECTOR_TYPE_SUPPORT("vectorTypeSupport", VectorTypeSupport.V1.toString());

private final String name;
private final String defaultValue;
Expand Down Expand Up @@ -1016,7 +1074,8 @@ public final class SQLServerDriver implements java.sql.Driver {
new SQLServerDriverPropertyInfo(SQLServerDriverBooleanProperty.ENABLE_BULK_COPY_CACHE.toString(),
Boolean.toString(SQLServerDriverBooleanProperty.ENABLE_BULK_COPY_CACHE.getDefaultValue()),false, TRUE_FALSE),
new SQLServerDriverPropertyInfo(SQLServerDriverStringProperty.VECTOR_TYPE_SUPPORT.toString(),
SQLServerDriverStringProperty.VECTOR_TYPE_SUPPORT.getDefaultValue(), false, new String[] {"off", "v1"}),
SQLServerDriverStringProperty.VECTOR_TYPE_SUPPORT.getDefaultValue(), false,
new String[] {VectorTypeSupport.OFF.toString(), VectorTypeSupport.V1.toString(), VectorTypeSupport.V2.toString()}),
new SQLServerDriverPropertyInfo(SQLServerDriverStringProperty.MSI_CLIENT_ID.toString(),
SQLServerDriverStringProperty.MSI_CLIENT_ID.getDefaultValue(), false, null),
new SQLServerDriverPropertyInfo(SQLServerDriverStringProperty.KEY_VAULT_PROVIDER_CLIENT_ID.toString(),
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/microsoft/sqlserver/jdbc/SQLServerResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,8 +341,8 @@ protected Object[][] getContents() {
{"R_unsupportedStmtColEncSetting", "SQLServerStatementColumnEncryptionSetting cannot be null."},
{"R_unsupportedConversionAE", "The conversion from {0} to {1} is unsupported for encrypted column."},
{"R_InvalidDataForAE", "The given value of type {0} from the data source cannot be converted to type {1} of the specified target column {2}."},
{"R_vectorTypeSupportPropertyDescription", "Determines the vector support feature negotiation during connection initialization. Valid values are \"off\" or \"v1\". Default is \"v1\"."},
{"R_invalidVectorTypeSupport", "Invalid value for vectorTypeSupport: {0}. Valid values are \"off\" or \"v1\"."},
{"R_vectorTypeSupportPropertyDescription", "Determines the vector support feature negotiation during connection initialization. Valid values are \"off\" ,\"v1\" or \"v2\". Default is \"v1\"."},
{"R_invalidVectorTypeSupport", "Invalid value for vectorTypeSupport: {0}. Valid values are \"off\", \"v1\", or \"v2\"."},
{"R_VectorDimensionCountMismatch", "Mismatch between vector dimension count and provided data."},
{"R_InvalidVectorDimensionCount", "Invalid vector dimension count."},
{"R_VectorDimensionTypeCannotBeNull", "Vector dimension type cannot be null."},
Expand Down
2 changes: 1 addition & 1 deletion src/test/java/com/microsoft/sqlserver/jdbc/datatypes/VectorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1739,7 +1739,7 @@ void validatePreparedStatementMetaData() throws SQLException {
*/
private SQLServerConnection getConnectionWithVectorFlag(String vectorTypeSupport) throws SQLException {
String connStr = connectionString;
if ("off".equalsIgnoreCase(vectorTypeSupport) || "v1".equalsIgnoreCase(vectorTypeSupport)) {
if ("off".equalsIgnoreCase(vectorTypeSupport) || "v1".equalsIgnoreCase(vectorTypeSupport) || "v2".equalsIgnoreCase(vectorTypeSupport)) {
connStr = connStr + ";vectorTypeSupport=" + vectorTypeSupport;
} else {
throw new IllegalArgumentException(
Expand Down
Loading