Expose copy default transient error list #3903

MatthiasHuygelen · 2026-01-20T10:00:25Z

Description

The default set of transient error codes is private. This seems to make it difficult to extend error codes without copy/pasting the base set from this repository. So we expose a copy.

Issues

#2342

Copilot

Pull request overview

This PR exposes the previously private default transient error list as a public property to address issue #2342, allowing consumers to extend the error code list without needing to copy/paste the base set from the repository.

Changes:

Adds a new public property DefaultTransientErrors to SqlConfigurableRetryFactory that returns a read-only copy of the default transient error list
Removes duplicated error list from test helper class RetryLogicTestHelper and migrates to use the new public API
Adds XML documentation for the new public property and documents additional error codes (64, 20, 0, -2, 207, 18456, 42108, 42109)

Reviewed changes

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

File	Description
src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Reliability/SqlConfigurableRetryFactory.cs	Adds public `DefaultTransientErrors` property that returns a `ReadOnlyCollection<int>` copy of the private transient error list; adds missing error codes to the private list
src/Microsoft.Data.SqlClient/tests/ManualTests/SQL/RetryLogic/RetryLogicTestHelper.cs	Removes duplicated private error list and updates code to reference the new public `SqlConfigurableRetryFactory.DefaultTransientErrors` property
doc/snippets/Microsoft.Data.SqlClient/SqlConfigurableRetryFactory.xml	Adds XML documentation for the new property and documents the previously undocumented error codes

...osoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Reliability/SqlConfigurableRetryFactory.cs

MatthiasHuygelen · 2026-01-20T10:07:30Z

@MatthiasHuygelen please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
@dotnet-policy-service agree [company="{your company}"]
Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@dotnet-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@dotnet-policy-service agree company="Microsoft"
Contributor License Agreement

@dotnet-policy-service agree

...osoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Reliability/SqlConfigurableRetryFactory.cs

paulmedynski · 2026-01-20T10:35:31Z

/azp run

azure-pipelines · 2026-01-20T10:35:57Z

Azure Pipelines successfully started running 2 pipeline(s).

paulmedynski

Thanks for the submission. The team will need to discuss the public API changes, and I have one implementation suggestion.

paulmedynski · 2026-01-20T10:41:47Z

...osoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Reliability/SqlConfigurableRetryFactory.cs

-                };
+                    233,    // A connection was successfully established with the server, but then an error occurred during the login process. (provider: Shared Memory Provider, error: 0 - No process is on the other end of the pipe.) (Microsoft SQL Server, Error: 233)
+                    64,     // A connection was successfully established with the server, but then an error occurred during the login process. (provider: TCP Provider, error: 0 - The specified network name is no longer available.)
+                    20,     // The instance of SQL Server you attempted to connect to does not support encryption.


I'm not sure how this error (or 207 or 18456) are transient. I'll discuss with the team.

paulmedynski · 2026-01-20T10:42:35Z

...osoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Reliability/SqlConfigurableRetryFactory.cs

                    997,    // A connection was successfully established with the server, but then an error occurred during the login process. (provider: Named Pipes Provider, error: 0 - Overlapped I/O operation is in progress)
-                    233     // A connection was successfully established with the server, but then an error occurred during the login process. (provider: Shared Memory Provider, error: 0 - No process is on the other end of the pipe.) (Microsoft SQL Server, Error: 233)
-                };
+                    233,    // A connection was successfully established with the server, but then an error occurred during the login process. (provider: Shared Memory Provider, error: 0 - No process is on the other end of the pipe.) (Microsoft SQL Server, Error: 233)


These changes constitute a public API change (altering which errors we consider transient by default), so this will need some extra scrutiny.

...osoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Reliability/SqlConfigurableRetryFactory.cs

Copilot

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.

...osoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Reliability/SqlConfigurableRetryFactory.cs

doc/snippets/Microsoft.Data.SqlClient/SqlConfigurableRetryFactory.xml

src/Microsoft.Data.SqlClient/netfx/ref/Microsoft.Data.SqlClient.cs

src/Microsoft.Data.SqlClient/netcore/ref/Microsoft.Data.SqlClient.cs

doc/snippets/Microsoft.Data.SqlClient/SqlConfigurableRetryFactory.xml

...osoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Reliability/SqlConfigurableRetryFactory.cs

paulmedynski · 2026-01-20T13:32:22Z

/azp run

azure-pipelines · 2026-01-20T13:32:47Z

Azure Pipelines successfully started running 2 pipeline(s).

paulmedynski · 2026-01-20T15:01:12Z

/azp run

azure-pipelines · 2026-01-20T15:01:42Z

Azure Pipelines successfully started running 2 pipeline(s).

...osoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Reliability/SqlConfigurableRetryFactory.cs

Copilot

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

doc/snippets/Microsoft.Data.SqlClient/SqlConfigurableRetryFactory.xml

paulmedynski · 2026-01-22T11:58:24Z

/azp run

azure-pipelines · 2026-01-22T11:58:50Z

Azure Pipelines successfully started running 2 pipeline(s).

benrr101 · 2026-01-22T18:59:06Z

@David-Engel Since this changes our public API, could you give this a look to see if it's something we should take?

benrr101

I like it and don't see any issues - just want to get some PM approval on it before we add to our public API!

paulmedynski · 2026-01-22T20:26:47Z

#649 also discusses transient errors.

codecov · 2026-01-22T20:30:57Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.45%. Comparing base (0a1c612) to head (aba4f96).
⚠️ Report is 8 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (0a1c612) and HEAD (aba4f96). Click for more details.

HEAD has 1 upload less than BASE

Flag BASE (0a1c612) HEAD (aba4f96)

addons 1 0

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3903      +/-   ##
==========================================
- Coverage   76.66%   69.45%   -7.22%     
==========================================
  Files         269      263       -6     
  Lines       43246    66178   +22932     
==========================================
+ Hits        33156    45962   +12806     
- Misses      10090    20216   +10126

Flag	Coverage Δ
addons	`?`
netcore	`69.39% <100.00%> (-7.30%)`	⬇️
netfx	`68.65% <100.00%> (-7.61%)`	⬇️

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.

David-Engel · 2026-01-23T19:25:39Z

Since this changes our public API, could you give this a look to see if it's something we should take?

My main hesitancy is I don't want changes to the list to be considered breaking changes. We already have enough things that require us to major vbump. If we can expose them in a way that changes to the error list is not considered breaking, I'm all for it.

MatthiasHuygelen · 2026-01-27T06:56:05Z

@paulmedynski So how should we proceed? Are these considered breaking? I've only added the ones that were already used in the tests.

paulmedynski · 2026-01-27T11:25:21Z

Hi @MatthiasHuygelen - The team will be meeting to discuss on Thursday, and I'll post an update after that.

cheenamalhotra · 2026-01-29T21:28:11Z

...osoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Reliability/SqlConfigurableRetryFactory.cs

+                    -2,     // Execution Timeout Expired.  The timeout period elapsed prior to completion of the operation or the server is not responding.
+                    0,      // A network-related or instance-specific error occurred while establishing a connection to SQL Server. The server was not found or was not accessible. Verify that the instance name is correct and that SQL Server is configured to allow remote connections. (provider: TCP Provider, error: 0 - A connection attempt failed because the connected party did not properly respond after a period of time, or established connection failed because connected host has failed to respond.)
+                    20,     // The instance of SQL Server you attempted to connect to does not support encryption.
+                    64,     // A connection was successfully established with the server, but then an error occurred during the login process. (provider: TCP Provider, error: 0 - The specified network name is no longer available.)
+                    207,    // Invalid column name


Why are we adding these error codes to transient list? Are they documented somewhere as transient?

If not, they should be removed.

If these shouldn't be in the list why were they added to the transient error list of your tests ? RetryLogicTestHelper.cs

That is likely done to mock a failure in tests, where its less important to test a 'transient' error code but more important to test whether the retry logic works as expected when a particular error occurs. Also our tests generate these error codes due to a particular configuration in use, which is not a generic condition for those errors to occur.

Publicly documented transient errors are the only ones we should be using as default errors SqlClient would retry on.

cheenamalhotra

Do not add new error codes as transient without documentation proofs.

cheenamalhotra · 2026-01-29T23:18:25Z

...osoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Reliability/SqlConfigurableRetryFactory.cs

+                    10060,  // An error has occurred while establishing a connection to the server. When connecting to SQL Server, this failure may be caused by the fact that under the default settings SQL Server does not allow remote connections. (provider: TCP Provider, error: 0 - A connection attempt failed because the connected party did not properly respond after a period of time, or established connection failed because connected host has failed to respond.) (Microsoft SQL Server, Error: 10060)
+                    10928,  // Resource ID: %d. The %s limit for the database is %d and has been reached. For more information, see http://go.microsoft.com/fwlink/?LinkId=267637.
+                    10929,  // Resource ID: %d. The %s minimum guarantee is %d, maximum limit is %d and the current usage for the database is %d. However, the server is currently too busy to support requests greater than %d for this database. For more information, see http://go.microsoft.com/fwlink/?LinkId=267637. Otherwise, please try again later.
+                    18456,  // Using managed identity in Azure Sql Server throws 18456 for non-existent database instead of 4060.


18456 : This is also not a transient error, in tests it's a different usecase where retrying makes sense, but it's not a retriable error in most cases.

expose-default-transient-error-codes

110222c

MatthiasHuygelen requested a review from a team as a code owner January 20, 2026 10:00

Copilot AI review requested due to automatic review settings January 20, 2026 10:00

Copilot started reviewing on behalf of MatthiasHuygelen January 20, 2026 10:00 View session

Copilot AI reviewed Jan 20, 2026

View reviewed changes

pregress reviewed Jan 20, 2026

View reviewed changes

...osoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Reliability/SqlConfigurableRetryFactory.cs Outdated Show resolved Hide resolved

fixed comments

cdbfe53

paulmedynski self-assigned this Jan 20, 2026

paulmedynski requested changes Jan 20, 2026

View reviewed changes

paulmedynski added Public API 🆕 Issues/PRs that introduce new APIs to the driver. Approval Needed Issues/PRs that require approval from the maintainers before changes will be accepted. labels Jan 20, 2026

Fix comments

1c96948

Copilot AI review requested due to automatic review settings January 20, 2026 12:04

Copilot started reviewing on behalf of MatthiasHuygelen January 20, 2026 12:04 View session

Copilot AI reviewed Jan 20, 2026

View reviewed changes

paulmedynski linked an issue Jan 20, 2026 that may be closed by this pull request

Expose default transient SQL error codes for extensibility #2342

Open

comments

f4358f4

paulmedynski approved these changes Jan 20, 2026

View reviewed changes

paulmedynski requested changes Jan 21, 2026

View reviewed changes

...osoft.Data.SqlClient/src/Microsoft/Data/SqlClient/Reliability/SqlConfigurableRetryFactory.cs Outdated Show resolved Hide resolved

convert to property and add missing codes from xml to implementation

6652e99

Copilot AI review requested due to automatic review settings January 22, 2026 06:54

Copilot started reviewing on behalf of MatthiasHuygelen January 22, 2026 06:54 View session

Copilot AI reviewed Jan 22, 2026

View reviewed changes

doc/snippets/Microsoft.Data.SqlClient/SqlConfigurableRetryFactory.xml Outdated Show resolved Hide resolved

typo

aba4f96

paulmedynski approved these changes Jan 22, 2026

View reviewed changes

benrr101 approved these changes Jan 22, 2026

View reviewed changes

cheenamalhotra reviewed Jan 29, 2026

View reviewed changes

cheenamalhotra requested changes Jan 29, 2026

View reviewed changes

cheenamalhotra reviewed Jan 29, 2026

View reviewed changes

Expose copy default transient error list #3903

Are you sure you want to change the base?

Expose copy default transient error list #3903

Conversation

MatthiasHuygelen commented Jan 20, 2026

Description

Issues

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MatthiasHuygelen commented Jan 20, 2026

Uh oh!

Uh oh!

paulmedynski commented Jan 20, 2026

Uh oh!

azure-pipelines bot commented Jan 20, 2026

Uh oh!

paulmedynski left a comment

Choose a reason for hiding this comment

Uh oh!

paulmedynski Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

paulmedynski Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

paulmedynski commented Jan 20, 2026

Uh oh!

azure-pipelines bot commented Jan 20, 2026

Uh oh!

paulmedynski commented Jan 20, 2026

Uh oh!

azure-pipelines bot commented Jan 20, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

paulmedynski commented Jan 22, 2026

Uh oh!

azure-pipelines bot commented Jan 22, 2026

Uh oh!

benrr101 commented Jan 22, 2026

Uh oh!

benrr101 left a comment

Choose a reason for hiding this comment

Uh oh!

paulmedynski commented Jan 22, 2026

Uh oh!

codecov bot commented Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

David-Engel commented Jan 23, 2026

Uh oh!

MatthiasHuygelen commented Jan 27, 2026

Uh oh!

paulmedynski commented Jan 27, 2026

Uh oh!

cheenamalhotra Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

codecov bot commented Jan 22, 2026 •

edited

Loading

cheenamalhotra Jan 29, 2026 •

edited

Loading

cheenamalhotra Jan 29, 2026 •

edited

Loading

cheenamalhotra Jan 29, 2026 •

edited

Loading