Missing "Command Timeout" connection string key?

[fterrani]

Type of issue

Other (describe below)

Description

I don't know if this is an outdated information of a missing information (hence the type of issue being "Other").

I was looking for EF Core documentation about the Microsoft SQL Server EF Core provider, more precisely on the keys supported in the connection string.

The following page mentions a Command Timeout connection string key: https://learn.microsoft.com/en-us/azure/azure-sql/database/troubleshoot-common-connectivity-issues?view=azuresql#net-sqlconnection-parameters-for-connection-retry

The text includes a link on this page (at the end of the first paragraph): https://learn.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqlconnection.connectionstring?view=netframework-4.8.1

But the Remarks section doesn't mention any Command Timeout key: https://learn.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqlconnection.connectionstring?view=netframework-4.8.1#remarks

Is this normal?

Page URL

https://learn.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqlconnection.connectionstring?view=netframework-4.8.1#remarks

Content source URL

https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Data.SqlClient/SqlConnection.xml

Document Version Independent Id

aa71bfe8-76a9-69d9-18d4-b5c22f7f8843

Platform Id

e1dbbfaf-1eaa-0904-0d75-0d7ae07addbb

Article author

@dotnet-bot

[dotnet-policy-service]

Tagging subscribers to this area: @cheenamalhotra, @David-Engel

[David-Engel]

The doc page (https://learn.microsoft.com/en-us/azure/azure-sql/database/troubleshoot-common-connectivity-issues?view=azuresql#net-sqlconnection-parameters-for-connection-retry) is inaccurate. Command Timeout, as a connection string option, was added to microsoft.data.sqlclient (MDS, new/current) and doesn't exist in system.data.sqlclient (SDS, legacy). In SDS, it's only available as a property of a SqlCommand instance.

So the API docs (this repo) are accurate. I'll submit a PR to the azure-sql docs to correct the content over there.