Repository navigation
Add vector(float16) support - #4501
apoorvdeshmukh wants to merge 46 commits into
Conversation
A vector column's base type and number of dimensions were already available from the column schema, but only as a numeric scale and a column size which the caller had to decode. They are now surfaced under their own names, so that applications inspecting result set metadata do not have to know that encoding. Also registers the vector type in the DataTypes schema collection, where it was missing. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
SQL Server transports vector(N, float16) elements as raw binary16 values. System.Half is only available on .NET, so the conversion is implemented manually for .NET Framework. The manual implementation is compiled for every target framework rather than only for .NET Framework, so that it can be validated exhaustively against System.Half on .NET while remaining the code path .NET Framework actually uses. It is verified against every binary16 bit pattern, a strided sweep of the single precision range, and the rounding, subnormal, overflow and underflow boundaries. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
Advertises version 2 of the VECTORSUPPORT feature extension, so that a vector(N, float16) column is exchanged in its native binary form rather than as a varchar(max) JSON string. On .NET such a column is surfaced as SqlVector<Half>. .NET Framework has no System.Half, so it is reported as a string there, matching how it is already presented when the server does not negotiate float16 support. Callers on either framework can explicitly request a strongly typed value via GetSqlVector<float>, which widens the elements without loss. SqlVector<T> continues to derive the base type written to the wire from T alone. Conversion between base types is left to the server, which performs it for parameters. Bulk copy is the exception: it declares the destination's base type in the INSERT BULK statement, so a payload using a different base type is rejected as a column length error rather than converted, and is rewritten by the driver first. That conversion runs after coercion, because the payload coercion produces uses the source value's own base type: a JSON string always yields float32, which is how a float16 column reads back where System.Half is unavailable. SqlVector<T>.ToString() now returns the vector's values as a JSON array rather than the type name. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
Describes the base types a vector column can have, how they map to SqlVector<T>, and how a float16 column is read and written on .NET Framework, where System.Half does not exist. Also documents the vector feature extension versions and the column metadata properties. Adds a sample covering both frameworks, reading a float16 column as an exact, widened or JSON value, inspecting a column's base type and dimensions, and converting between base types. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
There was a problem hiding this comment.
Pull request overview
Adds end-to-end support for SQL Server vector(N, float16) by negotiating VECTORSUPPORT feature extension version 2, introducing an IEEE-754 binary16 codec, and wiring float16 handling through SqlVector<T> read/write paths (including bulk copy), with accompanying docs and tests.
Changes:
- Negotiate vector feature extension v2 and track negotiated vector capability version (float32/float16) on the connection.
- Add float16 vector support across
SqlVector<T>,SqlDataReader,SqlBuffer,SqlParameter,SqlCommand, andSqlBulkCopy, including payload conversion for bulk copy. - Add unit/manual tests plus docs/snippets/sample updates; expose vector base type + dimensions via
DbColumnindexer and registervectorin theDataTypesschema collection.
Reviewed changes
Copilot reviewed 23 out of 23 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Microsoft.Data.SqlClient/tests/UnitTests/SimulatedServerTests/ConnectionTests.cs | Updates simulated negotiation tests for vector feature extension v2. |
| src/Microsoft.Data.SqlClient/tests/UnitTests/Microsoft/Data/SqlTypes/SqlVectorTest.cs | Adds float16 construction/rendering tests and payload conversion tests. |
| src/Microsoft.Data.SqlClient/tests/UnitTests/Microsoft/Data/SqlTypes/Float16ConverterTest.cs | New unit tests validating binary16 codec (incl. exhaustive bit-pattern validation on .NET). |
| src/Microsoft.Data.SqlClient/tests/ManualTests/SQL/VectorTest/VectorFloat16BehaviourTests.cs | Manual tests for float16-specific behaviors (read/write/cross-base-type/bulk copy). |
| src/Microsoft.Data.SqlClient/tests/ManualTests/SQL/VectorTest/VectorColumnMetadataTests.cs | Manual tests for vector column metadata + schema collection registration. |
| src/Microsoft.Data.SqlClient/tests/ManualTests/SQL/VectorTest/NativeVectorFloat16Tests.cs | Manual typed tests for SqlVector<Half> on .NET. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlTypes/SqlVector.cs | Implements float16 support in SqlVector<T>, adds JSON ToString(), payload widening/conversion helpers. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/TdsEnums.cs | Adds vector version constants and sets max supported vector version to float16 (v2). |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlParameter.cs | Handles float16 vector return/coercion paths (Half on .NET, widening on netfx). |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlMetaDataFactory.DataTypes.cs | Registers vector in GetSchema("DataTypes"). |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlEnums.cs | Adds float16 vector element type and element-size mapping; meta type inference includes SqlVector<Half> on .NET. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlDbColumn.cs | Exposes VectorBaseType/VectorDimensions via DbColumn indexer. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlDataReader.cs | Adds float16 field-type mapping and broadens GetSqlVector<T> to allow Half on .NET. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlCommand.cs | Emits (N, float16) parameter declaration when needed (keeps float32 declaration unchanged). |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlBulkCopy.cs | Emits float16 vector type in INSERT BULK declaration and converts payload base type to match destination. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlBuffer.cs | Centralizes float16 vector rendering/value-shaping across frameworks. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Connection/SqlConnectionInternal.cs | Records negotiated vector feature version on FEATUREEXTACK. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Connection/ConnectionCapabilities.cs | Replaces bool flag with VectorVersion and derived float32/float16 capability properties. |
| src/Microsoft.Data.SqlClient/src/Microsoft/Data/Common/Float16Converter.cs | New internal binary16<->binary32 conversion implementation. |
| src/Microsoft.Data.SqlClient/ref/Microsoft.Data.SqlTypes.cs | Updates reference surface to include SqlVector<T>.ToString() override. |
| doc/snippets/Microsoft.Data.SqlTypes/SqlVector.xml | Documents float16 support, size constraints, and ToString() JSON rendering. |
| doc/samples/SqlVectorFloat16Example.cs | New sample demonstrating float16 vectors (insert/read/metadata). |
| .github/instructions/features.instructions.md | Updates repo feature reference docs for float16 vector base type and negotiation versions. |
Suppressed comments (1)
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlTypes/SqlVector.cs:420
ConvertPayloadElementTypedoesn’t validate the vector header magic/version bytes before using the length and element type fields. This can cause non-vector payloads to be converted (or to fail later with less appropriate exceptions). ValidateVecHeaderMagicNo/VecVersionNoup front, consistent withGetCountsOrThrow.
if (tdsBytes.Length < TdsEnums.VECTOR_HEADER_SIZE)
{
throw ADP.InvalidVectorHeader();
}
Bulk copy read a vector column through the representation the reader surfaces, which is a JSON string on frameworks without System.Half. That round trip is both larger than the payload it encodes and unable to carry a negative zero, because System.Text.Json on .NET Framework serialises one as zero and parses a negative zero literal back as positive zero. Reading the payload directly avoids both. It is chosen once per column, when the source and destination are both vector columns, alongside the existing decimal and streaming decisions. Any difference in base type between the two is still resolved when the value is converted. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 23 out of 23 changed files in this pull request and generated no new comments.
Suppressed comments (4)
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlBulkCopy.cs:1755
SqlTypes.SqlVector<float>doesn’t resolve to any namespace/type in this file (there’s nousing SqlTypes = ...and noSqlTypesnamespace). This should be fully qualified toMicrosoft.Data.SqlTypes.SqlVector<float>(or add an alias) to avoid a compile error.
// The payload is converted directly rather than through a strongly typed vector,
// so that .NET Framework, which has no System.Half, can also write to float16
// destinations.
return SqlTypes.SqlVector<float>.ConvertPayloadElementType(payload, destinationElementType);
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlTypes/SqlVector.cs:154
FromTdsPayloadreads header fields (element type/length) without validating the vector magic/version bytes. This makes the widening path accept malformed payloads thatGetCountsOrThrowwould reject.
if (tdsBytes.Length < TdsEnums.VECTOR_HEADER_SIZE)
{
throw ADP.InvalidVectorHeader();
}
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlTypes/SqlVector.cs:420
ConvertPayloadElementTypeshould validate the vector header magic/version before interpreting element type and length; otherwise malformed byte[] values can be converted and sent on the wire rather than failing fast with InvalidVectorHeader.
if (tdsBytes.Length < TdsEnums.VECTOR_HEADER_SIZE)
{
throw ADP.InvalidVectorHeader();
}
doc/samples/SqlVectorFloat16Example.cs:146
- These interpolated strings won’t compile because the expression uses double quotes (e.g., column["VectorBaseType"]) inside a double-quoted string literal. Escape the quotes (or assign to a local variable) before interpolating.
Console.WriteLine($"\nColumn base type: {column["VectorBaseType"]}");
Console.WriteLine($"Column dimensions: {column["VectorDimensions"]}");
The existing suite covers nulls where the source and destination share a base type, but not where they differ, which is the path that converts the payload. Verified that nulls survive in every combination, interleaved with non-null rows so that a row's nullness cannot be satisfied by position alone. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 23 out of 23 changed files in this pull request and generated no new comments.
Suppressed comments (2)
doc/samples/SqlVectorFloat16Example.cs:146
- These interpolated strings won’t compile because the expression contains a string literal with double quotes (e.g., column["VectorBaseType"]) which terminates the outer interpolated string. Assign the indexer results to variables (or constants) first, then interpolate those variables.
Console.WriteLine($"\nColumn base type: {column["VectorBaseType"]}");
Console.WriteLine($"Column dimensions: {column["VectorDimensions"]}");
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlParameter.cs:2408
- This SqlVector special-case is redundant/unreachable because SqlVector implements ISqlVector (so it will already be handled by the earlier
value is ISqlVectorbranch). Keeping the extra branch increases maintenance burden and risks diverging behavior.
else if (currentType == typeof(SqlVector<Half>))
{
value = ((ISqlVector)value).VectorPayload;
}
#endif
saurabh500
left a comment
There was a problem hiding this comment.
Summary
This adds vector(N, float16) by advertising VECTORSUPPORT v2, introducing a hand-written binary16 codec, teaching SqlVector<T> about System.Half, and switching vector→vector bulk copy to a raw-payload transfer. The engineering is careful, and I want to call out specifically that the endianness and element-size arithmetic is correct throughout — I went looking for a missed (ColumnSize - 8) / 4 and there isn't one. The commit split is clean and the rationale in the description is unusually good.
I have one blocking correctness issue, plus a set of suggestions. Inline comments carry the detail and suggested diffs; this is the map.
Blocking
SqlBuffer.GetSqlVector<T>()succeeds or throws depending on the row's nullness. TheIsNullbranch builds a vector for anyTwithout consulting the column's base type, while the non-null branch validates.GetSqlVector<Half>()over afloat32column therefore returnsNullfor NULL rows and throwsNotSupportedExceptionfor non-NULL rows in the same result set. Data-dependent rather than schema-dependent, so it is hard to find in testing and impossible to guard against in caller code.
Suggestions
- The codec is not bit-exact against
System.Halffor NaN, contrary to the description, and the tests are written to step around exactly that case (continue/IsNaN-only).float.NaNcarries the sign bit, so widening flips the sign of every NaN relative toSystem.Half; narrowing canonicalises payloads that(Half)floatpreserves. Either matchSystem.Halfor pin the canonical form with explicit assertions and drop the "bit-exact" claim. - Bulk copy's vector case uses
metadata.scalerather than thescalelocal that the surrounding code establishes for encrypted columns. - The widening path skips the magic-number and version validation that the matching path gets via
GetCountsOrThrow. Capabilities.Float16VectorTypeis never read anywhere insrc/, so aSqlVector<Half>on a v1-negotiated connection fails server-side rather than client-side. (Float32VectorTypewas already dead inmain; this adds a second.)- The negotiation theory's
0x3case doesn't test what its comment claims — the simulated server caps the ack itself, so the client's own ceiling check atSqlConnectionInternal.cs:1660stays untested. - Docs say narrowing "fails for values outside its range"; the code saturates to ±Infinity and leaves it to the server.
MetaDatais dereferenced without a null check inCreateSourceColumnMetadata.
Things I checked and found correct
Worth recording, since they're the parts most likely to be wrong in a change like this:
- Subnormal widening, signed zero, overflow to infinity, the flush-to-zero boundary (2⁻²⁵ ties to even → 0, 2⁻²⁶ flushes), binary32 subnormal inputs, and the rounding carry into the exponent are all correct. Compiling
Manual*on every TFM so the netfx path is under test on .NET too is a good arrangement. - Bulk copy null handling is correct as-is —
GetValueFromSourceRowreturnsDBNull.ValuewithisNull = trueandConvertValuereturns beforeConvertVectorToBaseType. Notea5de733c3is test-only; it documents behaviour that already worked rather than fixing anything. - The raw-payload path can't be taken by
DataTable,DataRow[], or non-SqlClientDbDataReadersources (they keepValueMethod.GetValue), and reordering column mappings are safe becausesourceOrdinalis the mapped ordinal. - No unacknowledged breaking changes beyond the three listed:
GetDataTypeNameis unchanged,GetFieldType/GetProviderSpecificFieldTypeboth route through the single newGetVectorFieldTypeso they stay consistent,SqlMetaDataFactory.DataTypesonly adds a row (gated onMinimumVersionKey), thefloat32declaration is deliberately unchanged, andSqlDbColumn's new indexer falls through tobase[property]. - No shared mutable state:
Float16Converteris stateless andSqlVector<T>is areadonly structwith no static caches.
On testing
Taking as given that CI has no float16-capable server and no Azure SQL DB connectivity, so the manual suite is the only gate that will ever run — I looked at whether it is complete enough for a lab run rather than whether CI covers it. It is substantial: 11 behaviour tests plus the inherited NativeVectorTestsBase matrix, and the sample data is well chosen (Half.MaxValue, Half.Epsilon, -0.0f, exactly-representable eighths). Gaps I'd close:
- .NET Framework gets none of the
NativeVectorTestsBasematrix —NativeVectorFloat16Tests.csis entirely#if NET. That is where the hand-rolledManual*codec is the production path. - No async coverage for the new representation on any framework, and none at all for float16 on netfx.
DataTestUtility.CheckVectorFloat16Supportedfails open through the code under test. It reads the probe vector withGetString+JsonSerializer.Deserializeand catchesJsonException→false. A driver regression that produces malformed JSON silently skips the whole float16 suite green. Since the manual run is the only gate, that is the wrong failure mode. (Outside this diff, so no inline comment — but worth fixing alongside. It also leavesPREVIEW_FEATURES = ONon the shared test database as a side effect.)- Two range tests assert only that some
SqlExceptionwas thrown; they'd pass on an unrelated failure, and they can't distinguish "client rejects" from "client saturates and server rejects" — which is exactly the ambiguity in the doc wording above. - Nothing covers the blocking issue: reading a float32 column as
SqlVector<Half>, for a NULL and a non-NULL row. - Bulk copy with a dimension-count mismatch between source and destination is uncovered. Mitigating:
float32→float32now routes through the new raw-payload path too and is covered by the existingNativeVectorFloat32Tests, which runs against any vector-capable server — so regression risk to shipped functionality is covered.
Minor
SqlVector<T>.ToString()changing for existingSqlVector<float>callers is justified and correctly surfaced in the ref assembly and docs, but it is unrelated to float16 — it wants its own release-note entry as a behavioural break, not just an API-list line. Related:GetString()usesJsonSerializer.Serialize, which throws onNaN/Infinityby default, and on .NET Framework that is now the defaultGetValue()path.ConvertPayloadElementTypeisinternal staticonSqlVector<T>but never usesT, so callers writeSqlVector<float>.ConvertPayloadElementType(...), which reads as though it returns a float32 result.- On .NET Framework the reader surfaces a float16 column as
stringwhile an output parameter surfaces it asSqlVector<float>. Self-consistent, but worth documenting. - Preprocessor directives in the new code are indented to the surrounding block; the dominant style in these files is column 0.
ConnectionCapabilities.cs:179says vectors were "introduced in SQL Server 2022" — pre-existing, but the newFloat16VectorTypedoc sits right beside it.- Worth confirming the
doc/samplesbuild resolves the locally-packed driver:SqlVectorFloat16Example.csreferencesSqlVector<Half>andGetSqlVector<Half>, which exist in no released package.
Review assisted by GitHub Copilot; findings verified against the code at a5de733c3.
|
@apoorvdeshmukh and @cheenamalhotra, I think we will need to call this API a known limitation for preventing backward migration from .Net Runtime to NetFx. I believe this is a known reasonable compromise. |
|
BTW, I saw changes to ref assembly. Should I expect two copies of changes, one for netcore and another for NetFx? I am curious about how the APIs will show up in contract assemblies targeting 2 different frameworks. |
Correctness - Reject a narrowing read consistently for null and populated rows. The element type is now checked before the null check in GetSqlVector<T>, so reading a float32 column as SqlVector<Half> fails for every row rather than succeeding for the null ones. - Validate the vector header's magic number and version on the widening and payload conversion paths, which previously checked only the length. - Quieten a signalling NaN when widening to single precision, and preserve a NaN's sign and payload in both directions, so the hand written codec and System.Half agree on all 65,536 bit patterns. - Read the redirected scale when converting a bulk copy value, so an encrypted column uses its base type rather than the wrapping metadata's. - Guard against a null MetaData when deciding whether a bulk copy source can supply a raw vector payload. Behaviour - Report a value which cannot be narrowed to float16 during a bulk copy as an OverflowException, rather than saturating it to an infinity and letting the server reject the result as a malformed vector. - Remove the unused Float32VectorType and Float16VectorType capability properties. The negotiated version is still recorded in VectorVersion. A client side guard was considered in their place, but the server already reports an unrecognised base type clearly, so the guard would only have replaced a good error with a worse one, and would have made float16 fail differently from float32 for the same cause. - Return the JSON rendering of a float16 vector as a SqlString from the provider specific accessors, so that every provider specific value remains a type from System.Data.SqlTypes. GetValue continues to return a string. Tests - Run the whole native vector matrix against a float16 column through the single precision representation, which covers .NET Framework, where the hand written codec is the production path rather than a test double. - Assert NaN bitwise rather than skipping it, which is what allowed the codec divergence above to go unnoticed. - Cover reading a float32 column as a narrower vector, for null and populated rows, synchronously and asynchronously. - Exercise the client's own feature extension version ceiling, by letting the simulated server acknowledge a version regardless of what the client requested. The existing case only proved the harness capped the version. - Assert the server's error number for an out of range value rather than accepting any SqlException. - Show the column metadata driving a read for a caller which does not know the schema in advance. - Remove the SqlVector<T>.ToString() override added earlier in this branch. It changed the rendering of the already shipped SqlVector<float> as well, and the reader already exposes the JSON form through GetString and GetFieldValue<string>. The internal GetString is unchanged. - Move Float16Converter into the Microsoft.Data.Common namespace, matching the folder it lives in and its neighbours there. Docs - State that a bulk copy reports an out of range narrowing itself, and correct the SQL Server version for the float32 base type. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
There was a problem hiding this comment.
Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.
Note
This error may be related to your runner configuration. You can now configure runners for Copilot code review separately from Copilot cloud agent by creating a copilot-code-review.yml file with your setup steps. Read the docs for details.
Distinguish reader column representation from client-selected output parameter bindings without changing the existing Value or SqlValue contracts. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
I clarified the comment and V2 docs in e1e4757. Reader columns and output bindings are separate: on Framework, a float32 vector binding returns SqlVector, while varchar(max) returns string/SqlString for non-null output. The existing sync/async and null-output tests pass on net462 and net10.0; no returned types changed. |
There was a problem hiding this comment.
🔵 Needs a closer look
Human assessment is needed because an unverified edge case may cause bulk copies from native vector sources to text destinations to fail.
1 resolved since last review
1 file not reviewed
src/Microsoft.Data.SqlClient/src/Resources/Strings.Designer.cs: Generated file
Review effort: Lite
Preserve vector bulk source metadata, reader conversions, and schema properties while adopting the upstream TdsColumnMetadata and TdsTypeInfo names. Keep the pending review proposals and unpublished manual-test draft separate. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
There was a problem hiding this comment.
🟡 Changes recommended
The implementation still has critical vector bulk-copy bugs that can consume sequential readers and misclassify later native vector values after a leading null.
2 open issues
1 file not reviewed
src/Microsoft.Data.SqlClient/src/Resources/Strings.Designer.cs: Generated file
Review effort: Lite
Default vector support to V2 for 8.0, simplify keyword conversion, and share vector metadata and payload helpers while preserving existing float32 behavior. Support leading-null object-typed bulk sources, keep reader metadata analysis non-consuming, and use explicit UTF8 transport for server-owned float16 JSON conversion. Add regression coverage and update documentation. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
There was a problem hiding this comment.
🟡 Changes recommended
Active issues remain, including a critical NullReferenceException in vector bulk-copy metadata analysis and a documented default mismatch that must be resolved.
2 open issues
2 resolved since last review
1 file not reviewed
src/Microsoft.Data.SqlClient/src/Resources/Strings.Designer.cs: Generated file
Review effort: Lite
Replace the removed TdsTypeInfo.CopyFrom call with the incoming wire-type field updates. Preserve the operation-owned column instance, destination flags, and cached metadata isolation. Reproduced CS1061 on CI merge c36cd53 before the fix. Verified merged-tree Windows net462/net10.0 and Unix-target net10.0 builds, plus 273 focused unit and integration cases. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
There was a problem hiding this comment.
🔵 Needs a closer look
A critical hidden edge case in vector dimension inference can produce inconsistent metadata and payloads during bulk copy, so human assessment is needed.
No open issues 🎉
2 resolved since last review
1 file not reviewed
src/Microsoft.Data.SqlClient/src/Resources/Strings.Designer.cs: Generated file
Review effort: Lite
cheenamalhotra
left a comment
There was a problem hiding this comment.
Review summary
Scope: Full re-review at b2f1e688, compared with mssql-jdbc (579528968) and the JDBC vector docs.
What this PR does: Adds vector(n, float16) support, a new Vector Type Support keyword (Off/V1/V2, default V2), SqlVector<Half> on .NET, float16 to float32 widening, and bulk copy/schema updates.
Existing feedback: All 91 earlier threads are resolved. I am not repeating them.
New findings
| # | Severity | Area | Summary |
|---|---|---|---|
| 1 | P2 | Bulk copy | A typed SqlVector<T> value from a non-SqlClient reader fails when the destination is text (inline) |
Breaking behavior (please confirm it is intended)
- Default is now V2. On .NET,
GetValue/GetFieldType/schema returnSqlVector<Half>for float16 columns, where they used to return a JSON string. Apps that cast tostringwill break.Vector Type Support=V1restores the old behavior. Please call this out in the release notes. - Public API changes are additive only: the
SqlVectorTypeSupportenum andSqlConnectionStringBuilder.VectorTypeSupport. TheSqlVector<T>signatures match 7.1.1.
Gaps vs JDBC: intentional or accidental?
@apoorvdeshmukh, please confirm each item, and add a doc note for the intentional ones.
| # | JDBC | This PR | Question |
|---|---|---|---|
| 1 | Default vectorTypeSupport=v1 |
Default V2 |
Intentional? (see inline) |
| 2 | Rejects FLOAT16 writes on the client under v1/off, including TVP |
Sends the value to the server; the server error surfaces | Intentional? |
| 3 | Narrows Float[] to binary16 on write |
No float to Half encoder; typed float16 writes need SqlVector<Half> (.NET only) |
Intentional? How do .NET Framework users write native float16? |
| 4 | Vector TVP columns supported | SqlMetaData rejects SqlDbTypeExtensions.Vector (pre-existing) |
Planned follow-up? |
| 5 | One Vector type with Float[] on all runtimes |
SqlVector<Half> on .NET; string/SqlString by default on .NET Framework |
Intentional? |
| 6 | n/a | Wide float16 (1999-3996 dims) read as SqlVector<float> cannot be written back natively |
Already discussed; please document it |
Azure SQL DB coverage
I checked build 187133. Float16 manual tests run and pass on Azure SQL DB. For example, Win25_Azure_Sql net10 (run 3630674) and net462 (run 3630747) pass VectorFloat16BehaviourTests, NativeVectorFloat16Tests, and NativeVectorFloat16AsSingleTests.
On the on-prem legs (Win22_Sql19, Win25_Sql25, named instance, x86), every float16 test is skipped, because CheckVectorFloat16Supported returns false there.
Coverage request: The probe hides every SqlException, so a broken Azure config would also skip silently and the build would stay green. Consider failing, or at least logging the reason, when the target is Azure SQL and the probe fails.
Tests run locally (macOS, net10.0)
- Unit:
FullyQualifiedName~Vector|FullyQualifiedName~Float16Converter: 79 passed - Functional:
SqlConnectionStringBuilderTestVectorTypeSupport: 47 passed
Document the pre-existing typed-reader-to-text limitation, the intentional V2 breaking behavior, and unchanged outgoing-write and TVP policies. Preserve metadata-only reader setup and server-owned conversion. Report SQL error number, state, and severity when the optional float16 test probe fails, without exposing connection details. Add a deterministic missing-database regression on both target frameworks. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
For the coverage request, 5974f10 adds SQL error number, state, and severity to failed float16-probe diagnostics without logging connection details. The probe still treats unavailable capability as a skip; I have not changed CI's expected-capability policy. A missing-database regression failed before the diagnostic was added and passes on net462/net10.0; the combined probe/bulk-source run passed 33/58 cases with no skips. Update after the scope review (53d8e46): the implicit reader-to-text fallback from e98526b has been withdrawn. Vector-specific bulk metadata is restricted to native vector destinations; supply JSON strings for text destinations. Existing string-valued paths, including Framework float16 projections, keep their ordinary conversion behavior. Optional GetFieldType failures (NotImplementedException/NotSupportedException) preserve legacy reader inputs, and ordinary text copies gain no extra source-metadata calls or row scans. The merged tree passed 1,777 repository tests plus 1,616 local/Azure matrix checks across net462/net10.0. Reference/sample/package builds, Unix-target compilation, and strict source XML passed; strict packaged XML retains only the two known unrelated SqlTriggerContext references. |
There was a problem hiding this comment.
🔵 Needs a closer look
A critical active finding remains because bulk metadata discovery can dereference a null _currentRow, causing a NullReferenceException for vector-backed in-memory sources before copying begins.
No open issues 🎉
1 file not reviewed
src/Microsoft.Data.SqlClient/src/Resources/Strings.Designer.cs: Generated file
Review effort: Lite
cheenamalhotra
left a comment
There was a problem hiding this comment.
Thanks @apoorvdeshmukh. I checked the replies against 5974f10de. The docs, the breaking-change release note, and the notes on JDBC differences look good, and the reader-to-text limitation as documented is fine.
Two follow-ups (inline):
- The new probe log message may not show up in CI logs.
- The new schema tests failed with a deadlock on Azure SQL net462 in build 187379.
Render non-SqlClient reader vector values through the existing JSON formatter when incoming metadata is unencrypted varchar, nvarchar, or json. Preserve native binary paths and ordinary parameter coercion. Use a vector value access mode to avoid GetTextReader and DataTableReader's failing UDT IsDBNull pre-check. Add both-framework coverage for nulls, streaming, sequential readers, V1/Off, native signed zero, cached metadata, maximum payloads, and length checks; update docs and the sample. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
There was a problem hiding this comment.
🔵 Needs a closer look
A critical active defect remains in SqlBulkCopy metadata inference: when the first selected value is DBNull, later SqlVector values can receive incorrect destination metadata, causing valid float16 payloads to be rejected or coerced as text.
No open issues 🎉
1 file not reviewed
src/Microsoft.Data.SqlClient/src/Resources/Strings.Designer.cs: Generated file
Review effort: Lite
Cache the failure associated with the actual capability decision and report it through xUnit output, which the existing CI steps preserve in TRX artifacts. Keep isolated probe tests from overwriting the configured diagnostic, and leave optional-capability skip behavior unchanged. Verified both-framework probe/schema tests and retained TRX output. The previously deadlocked Azure schema tests passed in build 187396, run 3635153 without changing their assertions or adding broad retries. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
There was a problem hiding this comment.
🔵 Needs a closer look
A critical active issue causes the new in-memory bulk-copy path to dereference an uninitialized row and fail with a NullReferenceException before any rows are copied.
No open issues 🎉
1 file not reviewed
src/Microsoft.Data.SqlClient/src/Resources/Strings.Designer.cs: Generated file
Review effort: Lite
Describe vector JSON fallback to native JSON destinations as explicit varchar(max) with matching UTF8 collation, metadata, and payload. Reuse the float16 text-transport helper rather than relying on the legacy JSON bulk metadata substitution. Preserve native vector transfers, non-vector JSON sources, encrypted metadata, and cached destination identity. Add red/green metadata regression coverage and verify 289 targeted tests across net462 and net10.0. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
There was a problem hiding this comment.
🔵 Needs a closer look
The change spans TDS negotiation, cross-framework vector materialization, reader/output-parameter accessors, and bulk-copy behavior, while validation omits Linux/macOS runtimes, the full package matrix, and native SQL Server scenarios, so maintainer review is warranted.
No open issues 🎉
1 file not reviewed
src/Microsoft.Data.SqlClient/src/Resources/Strings.Designer.cs: Generated file
Review effort: Lite
Confirmed: build 187444 tested merge I inspected run 3636255 and its flaky-only task log: the TVP test failed its baseline-comparison assertion; MARS failed the session-count assertion with expected 3, actual 2. I have not independently reproduced these failures on base, so this is not a claim that a regression has been ruled out. No matching tracking issue turned up in exact-test-name searches. With no demonstrated vector-path defect, I am leaving these already non-gating diagnostic runs unretried and the tests/pipeline unchanged rather than expanding this PR. The description now explicitly records the partially succeeded build and distinguishes passing GitHub checks from an all-tests-passed claim. |
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
Make source type discovery optional for native vector destinations and preserve ordinary text conversion. Retain native null and cross-base handling, add reader compatibility coverage, and update the supported bulk-copy guidance. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
There was a problem hiding this comment.
🔵 Needs a closer look
A critical active finding shows vector coercion incorrectly returns binary data for text destinations, causing the Half cases in the new tests to fail and requiring a code fix.
No open issues 🎉
1 file not reviewed
src/Microsoft.Data.SqlClient/src/Resources/Strings.Designer.cs: Generated file
Review effort: Lite
This claim in the review overview does not match
CI follow-up: the integration failures were real, but in a different path: bulk copy's shared XML/JSON case asserted the value type without rejecting a native vector first. Our final local execution coverage was Release-only, where a later writer cast produced the expected exception; Debug instead raised a DebugAssertException. Fixed in 21f8750 by rejecting native vector JSON input at the bulk-copy conversion boundary, without weakening assertions or changing valid JSON/XML handling. The new boundary tests reproduced the defect in both configurations, then all 270 targeted unit/integration checks passed across net462/net10.0 in Debug and Release. |
Validate unsupported native vector input at the bulk-copy conversion boundary instead of relying on a later writer cast. Keep valid JSON and XML handling unchanged and cover the boundary in Debug and Release. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: e17ed782-c576-4cb7-9b4b-7ad286d7a7d0
There was a problem hiding this comment.
🔵 Needs a closer look
A critical active finding remains: metadata setup dereferences a null _currentRow for supported DataTable/DataRow[] vector sources, causing a NullReferenceException before any rows are copied.
No open issues 🎉
1 file not reviewed
src/Microsoft.Data.SqlClient/src/Resources/Strings.Designer.cs: Generated file
Review effort: Lite
priyankatiwari08
left a comment
There was a problem hiding this comment.
Looks good — no new concerns beyond existing threads. Partial coverage: core source only (SqlVector, Float16Converter, SqlBuffer, SqlDataReader, SqlCommand, vector negotiation/options); tests/docs skimmed.



Description
Adds
vector(N, float16)support while preserving the shipped float32 API:SqlVector<Half>; .NET Framework uses string/SqlString results or explicit lossless widening throughGetSqlVector<float>.Vector Type Supportdefaults to V2. Select V1 to preserve float16 JSON-string results, or Off for all-text vector results.Includes
mainthrough827c13651. Bulk-copy compatibility update:53d8e4603; Debug/Release JSON rejection correction:21f8750da.Issues
API discussion: #3382
Testing
Latest CI correction: 270 targeted checks passed, zero failures/skips. JSON vector input is now rejected at
SqlBulkCopy.ConvertValue, before the shared XML/JSON assertion or writer. The regression reproduced asDebugAssertExceptionin Debug and missing early rejection in Release; assertions and valid JSON/XML handling were not weakened.Earlier broader validation on
53d8e4603passed 1,777 repository tests and 1,616 local/Azure matrix checks, including expected rejections. That execution coverage was Release-only and did not exercise the Debug assertion path found by CI. Reference/sample/package builds, Unix-target compilation, and strict source XML validation passed.CI audit (build 188293): All added test methods have passing CI results except
Utf8TextSourceAcrossDatabases(sync/async), skipped in every lane. Both variants passed locally on net462/net10; CI coverage requires a float16-enabled SQL Server instance with cross-database access, which the Azure SQL Database CI lane does not provide.Known limitation: strict packaged XML still reports two pre-existing
SqlTriggerContextreferences fromTriggerAction; no new gating XML findings. This is focused validation, not a full-suite or performance-benchmark claim.Latest correction: commands and results
$rootis the local validation-artifact directory. Integration tests usedTEST_MDS_CONFIGandMDS_TCPConnectionStringfor an isolated local database. Each configuration was built and its filter verified with--list-testsbefore these--no-buildruns.The new
ConvertValue_NativeVectorForJson_ThrowsConversionErrorcases failed before the correction in both configurations. Existing string, SqlString, and SQL-null control cases passed before and after it. The separateSqlParameter.CoerceValuetext-destination tests also remain passing; the CI failure was in bulk copy's separate JSON path, not raw bytes being returned for text parameters.Guidelines
Please review the contribution guidelines before submitting a pull request: