Standardize Connection String properties for enhanced user experience (#534)

Author: cheenamalhotra

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

@@ -48,13 +48,20 @@ public enum PoolBlockingPeriod
     public sealed partial class SqlConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilder
     {
         /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml' path='docs/members[@name="SqlConnectionStringBuilder"]/PoolBlockingPeriod/*'/>
+        [System.ComponentModel.DisplayNameAttribute("Pool Blocking Period")]
+        [System.ComponentModel.RefreshPropertiesAttribute(System.ComponentModel.RefreshProperties.All)] 
         public PoolBlockingPeriod PoolBlockingPeriod { get { throw null; } set { } }
         /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml' path='docs/members[@name="SqlConnectionStringBuilder"]/ColumnEncryptionSetting/*'/>
+        [System.ComponentModel.DisplayNameAttribute("Column Encryption Setting")]
+        [System.ComponentModel.RefreshPropertiesAttribute(System.ComponentModel.RefreshProperties.All)] 
         public Microsoft.Data.SqlClient.SqlConnectionColumnEncryptionSetting ColumnEncryptionSetting { get { throw null; } set { } }
         /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml' path='docs/members[@name="SqlConnectionStringBuilder"]/EnclaveAttestationUrl/*'/>
+        [System.ComponentModel.DisplayNameAttribute("Enclave Attestation Url")]
+        [System.ComponentModel.RefreshPropertiesAttribute(System.ComponentModel.RefreshProperties.All)] 
         public string EnclaveAttestationUrl { get { throw null; } set { } }
-
         /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml' path='docs/members[@name="SqlConnectionStringBuilder"]/AttestationProtocol/*' />
+        [System.ComponentModel.DisplayNameAttribute("Attestation Protocol")]
+        [System.ComponentModel.RefreshPropertiesAttribute(System.ComponentModel.RefreshProperties.All)] 
         public Microsoft.Data.SqlClient.SqlConnectionAttestationProtocol AttestationProtocol {get { throw null; } set { } }
     }
     /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlParameter.xml' path='docs/members[@name="SqlParameter"]/SqlParameter/*'/>

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

@@ -617,7 +617,7 @@ public SqlConnectionStringBuilder() { }
         /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml' path='docs/members[@name="SqlConnectionStringBuilder"]/ctorConnectionString/*'/>
         public SqlConnectionStringBuilder(string connectionString) { }
         /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml' path='docs/members[@name="SqlConnectionStringBuilder"]/ApplicationIntent/*'/>
-        [System.ComponentModel.DisplayNameAttribute("ApplicationIntent")]
+        [System.ComponentModel.DisplayNameAttribute("Application Intent")]
         [System.ComponentModel.RefreshPropertiesAttribute(System.ComponentModel.RefreshProperties.All)]
         public Microsoft.Data.SqlClient.ApplicationIntent ApplicationIntent { get { throw null; } set { } }
         /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml' path='docs/members[@name="SqlConnectionStringBuilder"]/ApplicationName/*'/>
@@ -634,11 +634,11 @@ public SqlConnectionStringBuilder(string connectionString) { }
         [System.ComponentModel.RefreshPropertiesAttribute(System.ComponentModel.RefreshProperties.All)]
         public Microsoft.Data.SqlClient.SqlAuthenticationMethod Authentication { get { throw null; } set { } }
         /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml' path='docs/members[@name="SqlConnectionStringBuilder"]/ConnectRetryCount/*'/>
-        [System.ComponentModel.DisplayNameAttribute("ConnectRetryCount")]
+        [System.ComponentModel.DisplayNameAttribute("Connect Retry Count")]
         [System.ComponentModel.RefreshPropertiesAttribute(System.ComponentModel.RefreshProperties.All)]
         public int ConnectRetryCount { get { throw null; } set { } }
         /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml' path='docs/members[@name="SqlConnectionStringBuilder"]/ConnectRetryInterval/*'/>
-        [System.ComponentModel.DisplayNameAttribute("ConnectRetryInterval")]
+        [System.ComponentModel.DisplayNameAttribute("Connect Retry Interval")]
         [System.ComponentModel.RefreshPropertiesAttribute(System.ComponentModel.RefreshProperties.All)]
         public int ConnectRetryInterval { get { throw null; } set { } }
         /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml' path='docs/members[@name="SqlConnectionStringBuilder"]/ConnectTimeout/*'/>
@@ -692,11 +692,11 @@ public SqlConnectionStringBuilder(string connectionString) { }
         [System.ComponentModel.RefreshPropertiesAttribute(System.ComponentModel.RefreshProperties.All)]
         public int MinPoolSize { get { throw null; } set { } }
         /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml' path='docs/members[@name="SqlConnectionStringBuilder"]/MultipleActiveResultSets/*'/>
-        [System.ComponentModel.DisplayNameAttribute("MultipleActiveResultSets")]
+        [System.ComponentModel.DisplayNameAttribute("Multiple Active Result Sets")]
         [System.ComponentModel.RefreshPropertiesAttribute(System.ComponentModel.RefreshProperties.All)]
         public bool MultipleActiveResultSets { get { throw null; } set { } }
         /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml' path='docs/members[@name="SqlConnectionStringBuilder"]/MultiSubnetFailover/*'/>
-        [System.ComponentModel.DisplayNameAttribute("MultiSubnetFailover")]
+        [System.ComponentModel.DisplayNameAttribute("Multi Subnet Failover")]
         [System.ComponentModel.RefreshPropertiesAttribute(System.ComponentModel.RefreshProperties.All)]
         public bool MultiSubnetFailover { get { throw null; } set { } }
         /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml' path='docs/members[@name="SqlConnectionStringBuilder"]/PacketSize/*'/>
@@ -725,7 +725,7 @@ public SqlConnectionStringBuilder(string connectionString) { }
         [System.ComponentModel.RefreshPropertiesAttribute(System.ComponentModel.RefreshProperties.All)]
         public string TransactionBinding { get { throw null; } set { } }
         /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml' path='docs/members[@name="SqlConnectionStringBuilder"]/TrustServerCertificate/*'/>
-        [System.ComponentModel.DisplayNameAttribute("TrustServerCertificate")]
+        [System.ComponentModel.DisplayNameAttribute("Trust Server Certificate")]
         [System.ComponentModel.RefreshPropertiesAttribute(System.ComponentModel.RefreshProperties.All)]
         public bool TrustServerCertificate { get { throw null; } set { } }
         /// <include file='../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml' path='docs/members[@name="SqlConnectionStringBuilder"]/TypeSystemVersion/*'/>

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

@@ -677,7 +677,7 @@ internal static partial class DbConnectionStringKeywords
         // internal const string NamedConnection = "Named Connection";
 
         // SqlClient
-        internal const string ApplicationIntent = "ApplicationIntent";
+        internal const string ApplicationIntent = "Application Intent";
         internal const string ApplicationName = "Application Name";
         internal const string AsynchronousProcessing = "Asynchronous Processing";
         internal const string AttachDBFilename = "AttachDbFilename";
@@ -688,18 +688,18 @@ internal static partial class DbConnectionStringKeywords
         internal const string Encrypt = "Encrypt";
         internal const string FailoverPartner = "Failover Partner";
         internal const string InitialCatalog = "Initial Catalog";
-        internal const string MultipleActiveResultSets = "MultipleActiveResultSets";
-        internal const string MultiSubnetFailover = "MultiSubnetFailover";
+        internal const string MultipleActiveResultSets = "Multiple Active Result Sets";
+        internal const string MultiSubnetFailover = "Multi Subnet Failover";
         internal const string NetworkLibrary = "Network Library";
         internal const string PacketSize = "Packet Size";
         internal const string Replication = "Replication";
         internal const string TransactionBinding = "Transaction Binding";
-        internal const string TrustServerCertificate = "TrustServerCertificate";
+        internal const string TrustServerCertificate = "Trust Server Certificate";
         internal const string TypeSystemVersion = "Type System Version";
         internal const string UserInstance = "User Instance";
         internal const string WorkstationID = "Workstation ID";
-        internal const string ConnectRetryCount = "ConnectRetryCount";
-        internal const string ConnectRetryInterval = "ConnectRetryInterval";
+        internal const string ConnectRetryCount = "Connect Retry Count";
+        internal const string ConnectRetryInterval = "Connect Retry Interval";
         internal const string Authentication = "Authentication";
         internal const string ColumnEncryptionSetting = "Column Encryption Setting";
         internal const string EnclaveAttestationUrl = "Enclave Attestation Url";
@@ -720,7 +720,7 @@ internal static partial class DbConnectionStringKeywords
         internal const string Pooling = "Pooling";
         internal const string MinPoolSize = "Min Pool Size";
 #if netcoreapp
-        internal const string PoolBlockingPeriod = "PoolBlockingPeriod";
+        internal const string PoolBlockingPeriod = "Pool Blocking Period";
 #endif
     }
 
@@ -732,6 +732,9 @@ internal static class DbConnectionStringSynonyms
         //internal const string ApplicationName        = APP;
         internal const string APP = "app";
 
+        //internal const string ApplicationIntent    = APPLICATIONINTENT;
+        internal const string APPLICATIONINTENT = "ApplicationIntent";
+
         //internal const string AttachDBFilename       = EXTENDEDPROPERTIES+","+INITIALFILENAME;
         internal const string EXTENDEDPROPERTIES = "extended properties";
         internal const string INITIALFILENAME = "initial file name";
@@ -740,6 +743,12 @@ internal static class DbConnectionStringSynonyms
         internal const string CONNECTIONTIMEOUT = "connection timeout";
         internal const string TIMEOUT = "timeout";
 
+        //internal const string ConnectRetryCount = CONNECTRETRYCOUNT;
+        internal const string CONNECTRETRYCOUNT = "ConnectRetryCount";
+
+        //internal const string ConnectRetryInterval = CONNECTRETRYINTERVAL;
+        internal const string CONNECTRETRYINTERVAL = "ConnectRetryInterval";
+
         //internal const string CurrentLanguage        = LANGUAGE;
         internal const string LANGUAGE = "language";
 
@@ -759,17 +768,30 @@ internal static class DbConnectionStringSynonyms
         //internal const string LoadBalanceTimeout     = ConnectionLifetime;
         internal const string ConnectionLifetime = "connection lifetime";
 
+        //internal const string MultipleActiveResultSets    = MULTIPLEACTIVERESULTSETS;
+        internal const string MULTIPLEACTIVERESULTSETS = "MultipleActiveResultSets";
+
+        //internal const string MultiSubnetFailover = MULTISUBNETFAILOVER;
+        internal const string MULTISUBNETFAILOVER = "MultiSubnetFailover";
+        
         //internal const string NetworkLibrary         = NET+","+NETWORK;
         internal const string NET = "net";
         internal const string NETWORK = "network";
 
+#if netcoreapp
+        //internal const string PoolBlockingPeriod = POOLBLOCKINGPERIOD;
+        internal const string POOLBLOCKINGPERIOD = "PoolBlockingPeriod";
+#endif
 
         //internal const string Password               = Pwd;
         internal const string Pwd = "pwd";
 
         //internal const string PersistSecurityInfo    = PERSISTSECURITYINFO;
         internal const string PERSISTSECURITYINFO = "persistsecurityinfo";
 
+        //internal const string TrustServerCertificate = TRUSTSERVERCERTIFICATE;
+        internal const string TRUSTSERVERCERTIFICATE = "TrustServerCertificate";
+
         //internal const string UserID                 = UID+","+User;
         internal const string UID = "uid";
         internal const string User = "user";