Port PR #4084 to release/7.0: Fix API docs and doc include paths by Copilot · Pull Request #4107 · dotnet/SqlClient

Copilot · 2026-03-31T15:18:46Z

Cherry-pick PR Fix API docs #4084 changes (doc/snippets XML formatting fixes for SqlCommand.xml, SqlDataAdapter.xml, SqlDataReader.xml)
Fix doc include paths in SqlDataReader.cs (GetSqlJson, GetSqlVector) from ../../../../ to ../../../../../../
Fix doc include paths in SqlDbTypeExtensions.cs from ../../../../ to ../../../../../
Fix doc include paths in SqlJson.cs from ../../../../ to ../../../../../../
Fix doc include paths in SqlVector.cs from ../../../../ to ../../../../../../
Code review and security scan
Create PR against release/7.0

Agent-Logs-Url: https://github.com/dotnet/SqlClient/sessions/1d30e5d6-ae83-4523-9c05-2e7b15d13480 Co-authored-by: apoorvdeshmukh <5858671+apoorvdeshmukh@users.noreply.github.com>

…lJson.cs, SqlVector.cs (from PR #4033) Agent-Logs-Url: https://github.com/dotnet/SqlClient/sessions/1d30e5d6-ae83-4523-9c05-2e7b15d13480 Co-authored-by: apoorvdeshmukh <5858671+apoorvdeshmukh@users.noreply.github.com>

Copilot

Pull request overview

Ports doc-generation fixes from PR #4084 onto release/7.0 to resolve broken API doc includes and improve DocFX/XML output for several SqlClient APIs (notably JSON and vector types).

Changes:

Fixed <include file='...'> relative paths in source to correctly reference doc/snippets from the unified src/ tree (SqlDataReader, SqlJson, SqlVector, SqlDbTypeExtensions).
Cleaned up snippet XML formatting (whitespace/trailing spaces) and corrected a few xref targets (generic SqlVector<T> and retry-logic generic method xrefs; DataAdapter event xrefs).

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlTypes/SqlVector.cs	Adjusts doc snippet include paths to the correct repo-relative location.
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlTypes/SqlJson.cs	Adjusts doc snippet include paths to the correct repo-relative location.
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlDbTypeExtensions.cs	Adjusts doc snippet include paths to the correct repo-relative location.
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlDataReader.cs	Adjusts doc snippet include paths for `GetSqlJson` / `GetSqlVector`.
doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml	Formatting cleanup + fixes `SqlVector` xrefs to the generic type (`SqlVector\`1`).
doc/snippets/Microsoft.Data.SqlClient/SqlDataAdapter.xml	Formatting cleanup + changes references to RowUpdating/RowUpdated to event xrefs.
doc/snippets/Microsoft.Data.SqlClient/SqlCommand.xml	Formatting cleanup + fixes DocFX xrefs for generic retry-logic methods and `SqlVector<T>` references.

codecov · 2026-04-01T05:49:17Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.58%. Comparing base (864f666) to head (04ee13e).
⚠️ Report is 2 commits behind head on release/7.0.

❗ There is a different number of reports uploaded between BASE (864f666) and HEAD (04ee13e). Click for more details.

HEAD has 1 upload less than BASE

Flag BASE (864f666) HEAD (04ee13e)

CI-SqlClient 1 0

Additional details and impacted files

@@               Coverage Diff               @@
##           release/7.0    #4107      +/-   ##
===============================================
- Coverage        73.07%   65.58%   -7.50%     
===============================================
  Files              280      275       -5     
  Lines            42997    65822   +22825     
===============================================
+ Hits             31422    43168   +11746     
- Misses           11575    22654   +11079

Flag	Coverage Δ
CI-SqlClient	`?`
PR-SqlClient-Project	`65.58% <ø> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Updated [DotNetEnv](https://github.com/tonerdo/dotnet-env) from 3.1.1 to 3.2.0. <details> <summary>Release notes</summary> _Sourced from [DotNetEnv's releases](https://github.com/tonerdo/dotnet-env/releases)._ ## 3.2.0 - Switch parsing to Superpower (from Sprache) - Fix utf8 parsing - Interpolated variables parsing Commits viewable in [compare view](tonerdo/dotnet-env@v3.1.1...v3.2.0). </details> Updated [Microsoft.AspNetCore.Authentication.Google](https://github.com/dotnet/dotnet) from 10.0.6 to 10.0.7. <details> <summary>Release notes</summary> _Sourced from [Microsoft.AspNetCore.Authentication.Google's releases](https://github.com/dotnet/dotnet/releases)._ No release notes found for this version range. Commits viewable in [compare view](https://github.com/dotnet/dotnet/commits). </details> Updated [Microsoft.Data.SqlClient](https://github.com/dotnet/sqlclient) from 7.0.0 to 7.0.1. <details> <summary>Release notes</summary> _Sourced from [Microsoft.Data.SqlClient's releases](https://github.com/dotnet/sqlclient/releases)._ ## 7.0.1 This update brings the following changes since the [7.0.0](https://github.com/dotnet/SqlClient/blob/release/7.0/release-notes/7.0/7.0.0.md) release: ### Fixed - Fixed `SqlBulkCopy` failing on SQL Server 2016 with `Invalid column name 'graph_type'` error. The column metadata query now uses dynamic SQL so that references to the `graph_type` column (introduced in SQL Server 2017) are not compiled on older versions that lack the column. ([#3714](dotnet/SqlClient#3714), [#4092](dotnet/SqlClient#4092), [#4147](dotnet/SqlClient#4147)) - Fixed `SqlBulkCopy` failing on Azure Synapse Analytics dedicated SQL pools. The column-list query previously used a variable-assignment pattern that Synapse does not support; it now uses `STRING_AGG` when targeting Synapse (engine edition 6) and falls back to the variable-assignment approach for SQL Server 2016 compatibility. ([#4149](dotnet/SqlClient#4149), [#4176](dotnet/SqlClient#4176), [#4182](dotnet/SqlClient#4182)) - Fixed `SqlDataReader.GetFieldType()` and `GetProviderSpecificFieldType()` returning `typeof(byte[])` instead of `typeof(SqlVector<float>)` for vector float32 columns. The methods now follow the same type-determination logic as `GetValue()`. ([#4104](dotnet/SqlClient#4104), [#4105](dotnet/SqlClient#4105), [#4152](dotnet/SqlClient#4152)) - Added missing `System.Data.Common` (v4.3.0) NuGet package dependency for .NET Framework consumers. The inbox `System.Data.Common` assembly on .NET Framework predates APIs such as `IDbColumnSchemaGenerator`; without the explicit NuGet dependency, consumers encountered `CS0012` compilation errors when using these types through `Microsoft.Data.SqlClient`. ([#4063](dotnet/SqlClient#4063), [#4074](dotnet/SqlClient#4074)) ### Changed - Enabled the User Agent TDS feature extension unconditionally. The `Switch.Microsoft.Data.SqlClient.EnableUserAgent` AppContext switch has been removed; the driver now always sends User Agent information during login. ([#4124](dotnet/SqlClient#4124), [#4154](dotnet/SqlClient#4154)) - Added type forwards from the core `Microsoft.Data.SqlClient` assembly to public types that were moved to the `Microsoft.Data.SqlClient.Extensions.Abstractions` package: `SqlAuthenticationMethod`, `SqlAuthenticationParameters`, `SqlAuthenticationProvider`, `SqlAuthenticationProviderException`, and `SqlAuthenticationToken`. This ensures binary compatibility for assemblies compiled against earlier versions of `Microsoft.Data.SqlClient` where these types lived in the core assembly. ([#4067](dotnet/SqlClient#4067), [#4117](dotnet/SqlClient#4117)) - Fixed API documentation include paths and duplicate doc snippets. ([#4084](dotnet/SqlClient#4084), [#4086](dotnet/SqlClient#4086), [#4107](dotnet/SqlClient#4107), [#4161](dotnet/SqlClient#4161)) ## Contributors We thank the following public contributors. Their efforts toward this project are very much appreciated. - [edwardneal](https://github.com/edwardneal) ## Target Platform Support - .NET Framework 4.6.2+ (Windows x86, Windows x64, Windows ARM64) - .NET 8.0+ (Windows x86, Windows x64, Windows ARM, Windows ARM64, Linux, macOS) ### Dependencies #### .NET 9.0 - Microsoft.Bcl.Cryptography 9.0.13 - Microsoft.Data.SqlClient.Extensions.Abstractions 1.0.0 - Microsoft.Data.SqlClient.Internal.Logging 1.0.0 - Microsoft.Data.SqlClient.SNI.runtime 6.0.2 - Microsoft.Extensions.Caching.Memory 9.0.13 - Microsoft.IdentityModel.JsonWebTokens 8.16.0 - Microsoft.IdentityModel.Protocols.OpenIdConnect 8.16.0 - Microsoft.SqlServer.Server 1.0.0 - System.Configuration.ConfigurationManager 9.0.13 - System.Security.Cryptography.Pkcs 9.0.13 #### .NET 8.0 - Microsoft.Bcl.Cryptography 8.0.0 - Microsoft.Data.SqlClient.Extensions.Abstractions 1.0.0 ... (truncated) Commits viewable in [compare view](dotnet/SqlClient@v7.0.0...v7.0.1). </details> Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore <dependency name> major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself) - `@dependabot ignore <dependency name> minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself) - `@dependabot ignore <dependency name>` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself) - `@dependabot unignore <dependency name>` will remove all of the ignore conditions of the specified dependency - `@dependabot unignore <dependency name> <ignore condition>` will remove the ignore condition of the specified dependency and ignore conditions </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Copilot AI and others added 2 commits March 31, 2026 15:16

Port PR #4084: Fix API docs (cherry-pick)

fb821b0

Agent-Logs-Url: https://github.com/dotnet/SqlClient/sessions/1d30e5d6-ae83-4523-9c05-2e7b15d13480 Co-authored-by: apoorvdeshmukh <5858671+apoorvdeshmukh@users.noreply.github.com>

Copilot AI assigned Copilot and apoorvdeshmukh Mar 31, 2026

github-project-automation Bot added this to SqlClient Board Mar 31, 2026

github-project-automation Bot moved this to To triage in SqlClient Board Mar 31, 2026

Copilot created this pull request from a session on behalf of apoorvdeshmukh March 31, 2026 15:19 View session

Copilot finished work on behalf of apoorvdeshmukh March 31, 2026 15:19

Copilot AI requested a review from apoorvdeshmukh March 31, 2026 15:19

apoorvdeshmukh added this to the 7.0.1 milestone Mar 31, 2026

apoorvdeshmukh moved this from To triage to In review in SqlClient Board Mar 31, 2026

apoorvdeshmukh added the Area\Documentation Use this for issues that requires changes in public documentations/samples. label Mar 31, 2026

apoorvdeshmukh marked this pull request as ready for review March 31, 2026 15:36

apoorvdeshmukh requested a review from a team as a code owner March 31, 2026 15:36

Copilot AI review requested due to automatic review settings March 31, 2026 15:36

Copilot started reviewing on behalf of apoorvdeshmukh March 31, 2026 15:37 View session

Copilot AI reviewed Mar 31, 2026

View reviewed changes

paulmedynski mentioned this pull request Mar 31, 2026

[7.0] Fix API docs #4119

Closed

apoorvdeshmukh approved these changes Apr 1, 2026

View reviewed changes

apoorvdeshmukh requested a review from a team April 1, 2026 05:52

mdaigle approved these changes Apr 2, 2026

View reviewed changes

paulmedynski approved these changes Apr 6, 2026

View reviewed changes

paulmedynski merged commit c3dd601 into release/7.0 Apr 6, 2026
303 of 305 checks passed

paulmedynski deleted the copilot/port-pr-4084-to-release-7-0 branch April 6, 2026 11:05

github-project-automation Bot moved this from In review to Done in SqlClient Board Apr 6, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Port PR #4084 to release/7.0: Fix API docs and doc include paths#4107

Port PR #4084 to release/7.0: Fix API docs and doc include paths#4107
paulmedynski merged 2 commits intorelease/7.0from
copilot/port-pr-4084-to-release-7-0

Copilot AI commented Mar 31, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

codecov Bot commented Apr 1, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

Copilot AI commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

codecov Bot commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Copilot AI commented Mar 31, 2026 •

edited

Loading

codecov Bot commented Apr 1, 2026 •

edited

Loading