Skip to content

Add new conn-string synonyms for cross-driver alignment #4192

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

Merged
apoorvdeshmukh merged 2 commits into from
Apr 23, 2026
Merged

Add new conn-string synonyms for cross-driver alignment #4192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eaa85f7
Add new conn-string synonyms for cross-driver alignment
apoorvdeshmukh Apr 14, 2026
066fa8c
Fix FailoverPartner testcases
apoorvdeshmukh Apr 14, 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
5 changes: 5 additions & 0 deletions ...t.Data.SqlClient/src/Microsoft/Data/Common/ConnectionString/DbConnectionStringSynonyms.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,15 @@ internal static class DbConnectionStringSynonyms
internal const string Address = "address";
internal const string App = "app";
internal const string ApplicationIntent = "applicationintent";
internal const string ColumnEncryption = "columnEncryption";
internal const string ConnectionLifetime = "connection lifetime";
internal const string ConnectionTimeout = "connection timeout";
internal const string ConnectRetryCount = "connectretrycount";
internal const string ConnectRetryInterval = "connectretryinterval";
internal const string ConnectTimeout = "connecttimeout";
internal const string Database = "database";
internal const string ExtendedProperties = "extended properties";
internal const string FailoverPartner = "failoverpartner";
internal const string FailoverPartnerSpn = "FailoverPartnerSPN";
internal const string HostNameInCertificate = "hostnameincertificate";
internal const string InitialFileName = "initial file name";
Expand All @@ -26,6 +29,7 @@ internal static class DbConnectionStringSynonyms
internal const string Net = "net";
internal const string Network = "network";
internal const string NetworkAddress = "network address";
internal const string PacketSize = "packetsize";
internal const string PersistSecurityInfo = "persistsecurityinfo";
internal const string PoolBlockingPeriod = "poolblockingperiod";
internal const string Pwd = "pwd";
Expand All @@ -38,6 +42,7 @@ internal static class DbConnectionStringSynonyms
internal const string TrustServerCertificate = "trustservercertificate";
internal const string Uid = "uid";
internal const string User = "user";
internal const string WorkstationId = "workstationid";
internal const string WsId = "wsid";
}
}
33 changes: 19 additions & 14 deletions src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlConnectionString.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ internal static class TRANSACTIONBINDING
internal const string ImplicitUnbind = "Implicit Unbind";
internal const string ExplicitUnbind = "Explicit Unbind";
}

private static readonly Dictionary<string, string> s_keywordMap =
new Dictionary<string, string>(StringComparer.InvariantCultureIgnoreCase);

Expand Down Expand Up @@ -109,9 +109,9 @@ internal static class TRANSACTIONBINDING
private static readonly Version s_constTypeSystemAsmVersion11 = new("11.0.0.0");

private readonly string _expandedAttachDBFilename; // expanded during construction so that CreatePermissionSet & Expand are consistent

#region Constructors

/// <summary>
/// Static constructor to do things that we can't do in a single line initialization.
/// </summary>
Expand All @@ -125,20 +125,22 @@ static SqlConnectionString()
AddKeywordToMap(DbConnectionStringKeywords.ApplicationIntent,
DbConnectionStringSynonyms.ApplicationIntent);
AddKeywordToMap(DbConnectionStringKeywords.ApplicationName,
DbConnectionStringSynonyms.App);
DbConnectionStringSynonyms.App);
AddKeywordToMap(DbConnectionStringKeywords.AttachDbFilename,
DbConnectionStringSynonyms.ExtendedProperties,
DbConnectionStringSynonyms.InitialFileName);
AddKeywordToMap(DbConnectionStringKeywords.AttestationProtocol);
AddKeywordToMap(DbConnectionStringKeywords.Authentication);
AddKeywordToMap(DbConnectionStringKeywords.ColumnEncryptionSetting);
AddKeywordToMap(DbConnectionStringKeywords.ColumnEncryptionSetting,
DbConnectionStringSynonyms.ColumnEncryption);
AddKeywordToMap(DbConnectionStringKeywords.CommandTimeout);
AddKeywordToMap(DbConnectionStringKeywords.ConnectRetryCount,
DbConnectionStringSynonyms.ConnectRetryCount);
AddKeywordToMap(DbConnectionStringKeywords.ConnectRetryInterval,
DbConnectionStringSynonyms.ConnectRetryInterval);
AddKeywordToMap(DbConnectionStringKeywords.ConnectTimeout,
DbConnectionStringSynonyms.ConnectionTimeout,
DbConnectionStringSynonyms.ConnectTimeout,
DbConnectionStringSynonyms.Timeout);
AddKeywordToMap(DbConnectionStringKeywords.ContextConnection);
AddKeywordToMap(DbConnectionStringKeywords.CurrentLanguage,
Expand All @@ -151,7 +153,8 @@ static SqlConnectionString()
AddKeywordToMap(DbConnectionStringKeywords.EnclaveAttestationUrl);
AddKeywordToMap(DbConnectionStringKeywords.Encrypt);
AddKeywordToMap(DbConnectionStringKeywords.Enlist);
AddKeywordToMap(DbConnectionStringKeywords.FailoverPartner);
AddKeywordToMap(DbConnectionStringKeywords.FailoverPartner,
DbConnectionStringSynonyms.FailoverPartner);
AddKeywordToMap(DbConnectionStringKeywords.FailoverPartnerSpn,
DbConnectionStringSynonyms.FailoverPartnerSpn);
AddKeywordToMap(DbConnectionStringKeywords.HostNameInCertificate,
Expand All @@ -170,7 +173,8 @@ static SqlConnectionString()
AddKeywordToMap(DbConnectionStringKeywords.MinPoolSize);
AddKeywordToMap(DbConnectionStringKeywords.MultiSubnetFailover,
DbConnectionStringSynonyms.MultiSubnetFailover);
AddKeywordToMap(DbConnectionStringKeywords.PacketSize);
AddKeywordToMap(DbConnectionStringKeywords.PacketSize,
DbConnectionStringSynonyms.PacketSize);
AddKeywordToMap(DbConnectionStringKeywords.Password,
DbConnectionStringSynonyms.Pwd);
AddKeywordToMap(DbConnectionStringKeywords.PersistSecurityInfo,
Expand All @@ -192,6 +196,7 @@ static SqlConnectionString()
DbConnectionStringSynonyms.User);
AddKeywordToMap(DbConnectionStringKeywords.UserInstance);
AddKeywordToMap(DbConnectionStringKeywords.WorkstationId,
DbConnectionStringSynonyms.WorkstationId,
DbConnectionStringSynonyms.WsId);

#if NETFRAMEWORK
Expand All @@ -203,7 +208,7 @@ static SqlConnectionString()
DbConnectionStringSynonyms.TransparentNetworkIpResolution);
#endif
}

internal SqlConnectionString(string connectionString): base(connectionString, s_keywordMap)
{
#if !NETFRAMEWORK
Expand Down Expand Up @@ -568,12 +573,12 @@ internal SqlConnectionString(SqlConnectionString connectionOptions, string dataS
}

#endregion

internal bool IntegratedSecurity => _integratedSecurity;

// @TODO: This is temporary until we can remove DbConnectionString (see SqlClientPermission)
internal static IReadOnlyDictionary<string, string> KeywordMap => s_keywordMap;

// We always initialize in Async mode so that both synchronous and asynchronous methods
// will work. In the future we can deprecate the keyword entirely.
internal bool Asynchronous => true;
Expand Down Expand Up @@ -983,21 +988,21 @@ protected internal override PermissionSet CreatePermissionSet()
internal string NetworkLibrary => _networkLibrary;

#endif // NETFRAMEWORK

#region Private Methods

private static void AddKeywordToMap(string keyword, params string[] synonyms)
{
// Add mapping of keyword to keyword
s_keywordMap.Add(keyword, keyword);

// Add mapping of synonyms to keyword
foreach (string synonym in synonyms)
{
s_keywordMap.Add(synonym, keyword);
}
}

#endregion
}
}
9 changes: 7 additions & 2 deletions src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlConnectionStringBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,12 +273,17 @@ private static Dictionary<string, Keywords> CreateKeywordsDictionary()
{ DbConnectionStringSynonyms.Uid, Keywords.UserID },
{ DbConnectionStringSynonyms.User, Keywords.UserID },
{ DbConnectionStringSynonyms.WsId, Keywords.WorkstationID },
{ DbConnectionStringSynonyms.WorkstationId, Keywords.WorkstationID },
{ DbConnectionStringSynonyms.ServerSpn, Keywords.ServerSPN },
{ DbConnectionStringSynonyms.FailoverPartnerSpn, Keywords.FailoverPartnerSPN },
{ DbConnectionStringSynonyms.ColumnEncryption, Keywords.ColumnEncryptionSetting },
{ DbConnectionStringSynonyms.ConnectTimeout, Keywords.ConnectTimeout },
{ DbConnectionStringSynonyms.FailoverPartner, Keywords.FailoverPartner },
{ DbConnectionStringSynonyms.PacketSize, Keywords.PacketSize },
};
return pairs;
}

// @TODO These methods are completely unnecessary.

private static bool ConvertToBoolean(object value) => DbConnectionStringUtilities.ConvertToBoolean(value);
Expand Down Expand Up @@ -565,7 +570,7 @@ private void Reset(Keywords index)
}

// @TODO: These methods can be inlined with the property setters.

private void SetValue(string keyword, bool value) => base[keyword] = value.ToString();

private void SetValue(string keyword, int value) => base[keyword] = value.ToString((System.IFormatProvider)null);
Expand Down
63 changes: 63 additions & 0 deletions src/Microsoft.Data.SqlClient/tests/FunctionalTests/SqlConnectionStringBuilderTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,12 @@ public partial class SqlConnectionStringBuilderTest
[InlineData("Type System Version = Latest")]
[InlineData("User Instance = true")]
[InlineData("Workstation ID = myworkstation")]
[InlineData("WorkstationID = myworkstation")]
[InlineData("WSID = myworkstation")]
[InlineData("ConnectTimeout = 30")]
[InlineData("Initial Catalog = Northwind; FailoverPartner = randomserver.sys.local")]
[InlineData("PacketSize = 8192")]
[InlineData("columnEncryption = Enabled")]
[InlineData("Host Name In Certificate = tds.test.com")]
[InlineData("HostNameInCertificate = tds.test.com")]
[InlineData("Server Certificate = c:\\test.cer")]
Expand Down Expand Up @@ -937,5 +942,63 @@ internal static void CheckEncryptType(SqlConnectionStringBuilder builder, SqlCon
Assert.Equal(expectedValue, builder.Encrypt);
}

[Theory]
[InlineData("ConnectTimeout = 45", 45)]
[InlineData("connecttimeout = 45", 45)]
[InlineData("CONNECTTIMEOUT = 45", 45)]
[InlineData("Connect Timeout = 45", 45)]
[InlineData("Connection Timeout = 45", 45)]
[InlineData("Timeout = 45", 45)]
public void ConnectTimeoutSynonymsResolveCorrectly(string connectionString, int expected)
Comment thread
apoorvdeshmukh marked this conversation as resolved.
{
SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder(connectionString);
Assert.Equal(expected, builder.ConnectTimeout);
}

[Theory]
[InlineData("Initial Catalog = Northwind; FailoverPartner = partner.sys.local")]
[InlineData("Initial Catalog = Northwind; failoverpartner = partner.sys.local")]
[InlineData("Initial Catalog = Northwind; FAILOVERPARTNER = partner.sys.local")]
[InlineData("Initial Catalog = Northwind; Failover Partner = partner.sys.local")]
public void FailoverPartnerSynonymsResolveCorrectly(string connectionString)
{
SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder(connectionString);
Assert.Equal("partner.sys.local", builder.FailoverPartner);
}

[Theory]
[InlineData("PacketSize = 16000", 16000)]
[InlineData("packetsize = 16000", 16000)]
[InlineData("PACKETSIZE = 16000", 16000)]
[InlineData("Packet Size = 16000", 16000)]
public void PacketSizeSynonymsResolveCorrectly(string connectionString, int expected)
{
SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder(connectionString);
Assert.Equal(expected, builder.PacketSize);
}

[Theory]
[InlineData("WorkstationID = myws")]
[InlineData("workstationid = myws")]
[InlineData("WORKSTATIONID = myws")]
[InlineData("Workstation ID = myws")]
[InlineData("WSID = myws")]
public void WorkstationIdSynonymsResolveCorrectly(string connectionString)
{
SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder(connectionString);
Assert.Equal("myws", builder.WorkstationID);
}

[Theory]
[InlineData("columnEncryption = Enabled")]
[InlineData("columnencryption = Enabled")]
[InlineData("COLUMNENCRYPTION = Enabled")]
[InlineData("Column Encryption Setting = Enabled")]
public void ColumnEncryptionSynonymsResolveCorrectly(string connectionString)
{
SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder(connectionString);
Assert.Equal(SqlConnectionColumnEncryptionSetting.Enabled, builder.ColumnEncryptionSetting);
}

}
}
Loading