Skip to content

Cleanup | SqlConnectionFactory <- DbConnectionFactory #3435

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

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
+846 −857
Open

Cleanup | SqlConnectionFactory <- DbConnectionFactory #3435

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
2769667
Sort modifiers
benrr101 Jun 13, 2025
b75c7c0
Replace all usages of DbConnectionFactory with SqlConnectionFactory l…
benrr101 Jun 13, 2025
9a4af4c
Move member variables and constructor
benrr101 Jun 13, 2025
5a0b1e8
Move properties over
benrr101 Jun 13, 2025
d49d488
Move pool clearing methods
benrr101 Jun 13, 2025
ca3e33d
Move Create*Connection methods over
benrr101 Jun 13, 2025
c43f371
Move CreateConnectionPoolGroupProviderInfo
benrr101 Jun 13, 2025
5aa2d13
Move QueuePool*ForRelease
benrr101 Jun 13, 2025
efc0c28
Move TryGetConnection
benrr101 Jun 13, 2025
396bab5
Move CreateReplaceConnectionContinuation
benrr101 Jun 13, 2025
e5d42d9
Move TryGetConnectionCompletedContinuation
benrr101 Jun 13, 2025
25d580d
Move GetConnectionPool
benrr101 Jun 13, 2025
111e42b
Move GetConnectionPoolGroup
benrr101 Jun 13, 2025
3d12896
Move GetMetaDataFactory and PruneConnectionPoolGroups
benrr101 Jun 13, 2025
2027c5d
Move CompletedTask and merge FindConnectionOptions
benrr101 Jun 16, 2025
e357617
Remove DbConnectionFactory
benrr101 Jun 16, 2025
f67a608
Make timer period times based on milliseconds instead of seconds
benrr101 Jun 25, 2025
ff21328
Fix reflection references to Db/SqlConnectionFactory
benrr101 Jun 25, 2025
36ee48c
Addressing called out expression bodies
benrr101 Jun 26, 2025
2894c10
Address @mdaigle's comments
benrr101 Jul 8, 2025
ae54d3c
Unseal class, temporarily, just for @mdaigle
benrr101 Jul 9, 2025
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
3 changes: 0 additions & 3 deletions src/Microsoft.Data.SqlClient/netcore/src/Microsoft.Data.SqlClient.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,6 @@
<Compile Include="$(CommonSourceRoot)\Microsoft\Data\ProviderBase\DbConnectionClosed.cs">
<Link>Microsoft\Data\ProviderBase\DbConnectionClosed.cs</Link>
</Compile>
<Compile Include="$(CommonSourceRoot)\Microsoft\Data\ProviderBase\DbConnectionFactory.cs">
<Link>Microsoft\Data\ProviderBase\DbConnectionFactory.cs</Link>
</Compile>
<Compile Include="$(CommonSourceRoot)Microsoft\Data\SqlClient\ConnectionPool\ChannelDbConnectionPool.cs">
<Link>Microsoft\Data\SqlClient\ConnectionPool\ChannelDbConnectionPool.cs</Link>
</Compile>
Expand Down
10 changes: 5 additions & 5 deletions src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SqlConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1272,7 +1272,7 @@ public override void ChangeDatabase(string database)
/// <include file='../../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnection.xml' path='docs/members[@name="SqlConnection"]/ClearAllPools/*' />
public static void ClearAllPools()
{
SqlConnectionFactory.SingletonInstance.ClearAllPools();
SqlConnectionFactory.Instance.ClearAllPools();
}

/// <include file='../../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnection.xml' path='docs/members[@name="SqlConnection"]/ClearPool/*' />
Expand All @@ -1283,7 +1283,7 @@ public static void ClearPool(SqlConnection connection)
DbConnectionOptions connectionOptions = connection.UserConnectionOptions;
if (connectionOptions != null)
{
SqlConnectionFactory.SingletonInstance.ClearPool(connection);
SqlConnectionFactory.Instance.ClearPool(connection);
}
}

Expand Down Expand Up @@ -2265,7 +2265,7 @@ public static void ChangePassword(string connectionString, string newPassword)

SqlConnectionPoolKey key = new SqlConnectionPoolKey(connectionString, credential: null, accessToken: null, accessTokenCallback: null);

SqlConnectionString connectionOptions = SqlConnectionFactory.FindSqlConnectionOptions(key);
SqlConnectionString connectionOptions = SqlConnectionFactory.Instance.FindSqlConnectionOptions(key);
if (connectionOptions.IntegratedSecurity)
{
throw SQL.ChangePasswordConflictsWithSSPI();
Expand Down Expand Up @@ -2314,7 +2314,7 @@ public static void ChangePassword(string connectionString, SqlCredential credent

SqlConnectionPoolKey key = new SqlConnectionPoolKey(connectionString, credential, accessToken: null, accessTokenCallback: null);

SqlConnectionString connectionOptions = SqlConnectionFactory.FindSqlConnectionOptions(key);
SqlConnectionString connectionOptions = SqlConnectionFactory.Instance.FindSqlConnectionOptions(key);

// Check for connection string values incompatible with SqlCredential
if (!string.IsNullOrEmpty(connectionOptions.UserID) || !string.IsNullOrEmpty(connectionOptions.Password))
Expand Down Expand Up @@ -2352,7 +2352,7 @@ private static void ChangePassword(string connectionString, SqlConnectionString
}
SqlConnectionPoolKey key = new SqlConnectionPoolKey(connectionString, credential, accessToken: null, accessTokenCallback: null);

SqlConnectionFactory.SingletonInstance.ClearPool(key);
SqlConnectionFactory.Instance.ClearPool(key);
}

internal Task<T> RegisterForConnectionCloseNotification<T>(Task<T> outerTask, object value, int tag)
Expand Down
6 changes: 3 additions & 3 deletions src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SqlConnectionHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ namespace Microsoft.Data.SqlClient
{
public sealed partial class SqlConnection : DbConnection
{
private static readonly DbConnectionFactory s_connectionFactory = SqlConnectionFactory.SingletonInstance;
private static readonly SqlConnectionFactory s_connectionFactory = SqlConnectionFactory.Instance;

private DbConnectionOptions _userConnectionOptions;
private DbConnectionPoolGroup _poolGroup;
Expand All @@ -42,7 +42,7 @@ internal int CloseCount
}
}

internal DbConnectionFactory ConnectionFactory
internal SqlConnectionFactory ConnectionFactory
{
get
{
Expand Down Expand Up @@ -157,7 +157,7 @@ override protected DbCommand CreateDbCommand()
using (TryEventScope.Create("<prov.DbConnectionHelper.CreateDbCommand|API> {0}", ObjectID))
{
DbCommand command = null;
DbProviderFactory providerFactory = ConnectionFactory.ProviderFactory;
DbProviderFactory providerFactory = SqlConnectionFactory.ProviderFactory;
command = providerFactory.CreateCommand();
command.Connection = this;
return command;
Expand Down
10 changes: 6 additions & 4 deletions ...Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SqlInternalConnectionTds.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3049,10 +3049,12 @@ internal bool ThreadHasParserLockForClose
}
}

internal override bool TryReplaceConnection(DbConnection outerConnection, DbConnectionFactory connectionFactory, TaskCompletionSource<DbConnectionInternal> retry, DbConnectionOptions userOptions)
{
return base.TryOpenConnectionInternal(outerConnection, connectionFactory, retry, userOptions);
}
internal override bool TryReplaceConnection(
DbConnection outerConnection,
SqlConnectionFactory connectionFactory,
TaskCompletionSource<DbConnectionInternal> retry,
DbConnectionOptions userOptions) =>
TryOpenConnectionInternal(outerConnection, connectionFactory, retry, userOptions);
}

internal sealed class ServerInfo
Expand Down
3 changes: 0 additions & 3 deletions src/Microsoft.Data.SqlClient/netfx/src/Microsoft.Data.SqlClient.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,9 +285,6 @@
<Compile Include="$(CommonSourceRoot)\Microsoft\Data\ProviderBase\DbConnectionClosed.cs">
<Link>Microsoft\Data\ProviderBase\DbConnectionClosed.cs</Link>
</Compile>
<Compile Include="$(CommonSourceRoot)\Microsoft\Data\ProviderBase\DbConnectionFactory.cs">
<Link>Microsoft\Data\ProviderBase\DbConnectionFactory.cs</Link>
</Compile>
<Compile Include="$(CommonSourceRoot)Microsoft\Data\ProviderBase\DbConnectionInternal.cs">
<Link>Microsoft\Data\ProviderBase\DbConnectionInternal.cs</Link>
</Compile>
Expand Down
10 changes: 5 additions & 5 deletions src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/SqlConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1266,7 +1266,7 @@ public override void ChangeDatabase(string database)
public static void ClearAllPools()
{
(new SqlClientPermission(PermissionState.Unrestricted)).Demand();
SqlConnectionFactory.SingletonInstance.ClearAllPools();
SqlConnectionFactory.Instance.ClearAllPools();
}

/// <include file='../../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlConnection.xml' path='docs/members[@name="SqlConnection"]/ClearPool/*' />
Expand All @@ -1278,7 +1278,7 @@ public static void ClearPool(SqlConnection connection)
if (connectionOptions != null)
{
connectionOptions.DemandPermission();
SqlConnectionFactory.SingletonInstance.ClearPool(connection);
SqlConnectionFactory.Instance.ClearPool(connection);
}
}

Expand Down Expand Up @@ -2197,7 +2197,7 @@ public static void ChangePassword(string connectionString, string newPassword)

SqlConnectionPoolKey key = new SqlConnectionPoolKey(connectionString, credential: null, accessToken: null, accessTokenCallback: null);

SqlConnectionString connectionOptions = SqlConnectionFactory.FindSqlConnectionOptions(key);
SqlConnectionString connectionOptions = SqlConnectionFactory.Instance.FindSqlConnectionOptions(key);
if (connectionOptions.IntegratedSecurity || connectionOptions.Authentication == SqlAuthenticationMethod.ActiveDirectoryIntegrated)
{
throw SQL.ChangePasswordConflictsWithSSPI();
Expand Down Expand Up @@ -2249,7 +2249,7 @@ public static void ChangePassword(string connectionString, SqlCredential credent

SqlConnectionPoolKey key = new SqlConnectionPoolKey(connectionString, credential, accessToken: null, accessTokenCallback: null);

SqlConnectionString connectionOptions = SqlConnectionFactory.FindSqlConnectionOptions(key);
SqlConnectionString connectionOptions = SqlConnectionFactory.Instance.FindSqlConnectionOptions(key);

// Check for connection string values incompatible with SqlCredential
if (!string.IsNullOrEmpty(connectionOptions.UserID) || !string.IsNullOrEmpty(connectionOptions.Password))
Expand Down Expand Up @@ -2290,7 +2290,7 @@ private static void ChangePassword(string connectionString, SqlConnectionString
}
SqlConnectionPoolKey key = new SqlConnectionPoolKey(connectionString, credential, accessToken: null, accessTokenCallback: null);

SqlConnectionFactory.SingletonInstance.ClearPool(key);
SqlConnectionFactory.Instance.ClearPool(key);
}

internal Task<T> RegisterForConnectionCloseNotification<T>(Task<T> outerTask, object value, int tag)
Expand Down
8 changes: 4 additions & 4 deletions src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/SqlConnectionHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ namespace Microsoft.Data.SqlClient
{
public sealed partial class SqlConnection : DbConnection
{
private static readonly DbConnectionFactory _connectionFactory = SqlConnectionFactory.SingletonInstance;
private static readonly SqlConnectionFactory _connectionFactory = SqlConnectionFactory.Instance;
internal static readonly System.Security.CodeAccessPermission ExecutePermission = SqlConnection.CreateExecutePermission();

private DbConnectionOptions _userConnectionOptions;
Expand Down Expand Up @@ -69,7 +69,7 @@ internal int CloseCount
}
}

internal DbConnectionFactory ConnectionFactory
internal SqlConnectionFactory ConnectionFactory
{
get
{
Expand Down Expand Up @@ -203,7 +203,7 @@ override protected DbCommand CreateDbCommand()
{
using (TryEventScope.Create("<prov.DbConnectionHelper.CreateDbCommand|API> {0}", ObjectID))
{
DbProviderFactory providerFactory = ConnectionFactory.ProviderFactory;
DbProviderFactory providerFactory = SqlConnectionFactory.ProviderFactory;
DbCommand command = providerFactory.CreateCommand();
command.Connection = this;
return command;
Expand All @@ -212,7 +212,7 @@ override protected DbCommand CreateDbCommand()

private static System.Security.CodeAccessPermission CreateExecutePermission()
{
DBDataPermission p = (DBDataPermission)SqlConnectionFactory.SingletonInstance.ProviderFactory.CreatePermission(System.Security.Permissions.PermissionState.None);
DBDataPermission p = (DBDataPermission)SqlConnectionFactory.ProviderFactory.CreatePermission(System.Security.Permissions.PermissionState.None);
p.Add(String.Empty, String.Empty, KeyRestrictionBehavior.AllowOnly);
return p;
}
Expand Down
10 changes: 6 additions & 4 deletions src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/SqlInternalConnectionTds.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3081,10 +3081,12 @@ internal bool ThreadHasParserLockForClose
}
}

internal override bool TryReplaceConnection(DbConnection outerConnection, DbConnectionFactory connectionFactory, TaskCompletionSource<DbConnectionInternal> retry, DbConnectionOptions userOptions)
{
return base.TryOpenConnectionInternal(outerConnection, connectionFactory, retry, userOptions);
}
internal override bool TryReplaceConnection(
DbConnection outerConnection,
SqlConnectionFactory connectionFactory,
TaskCompletionSource<DbConnectionInternal> retry,
DbConnectionOptions userOptions) =>
base.TryOpenConnectionInternal(outerConnection, connectionFactory, retry, userOptions);
}

internal sealed class ServerInfo
Expand Down
14 changes: 13 additions & 1 deletion src/Microsoft.Data.SqlClient/src/Microsoft/Data/Common/AdapterUtil.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,18 @@ internal static Exception ExceptionWithStackTrace(Exception e)
}
}

internal static Timer UnsafeCreateTimer(TimerCallback callback, object state, int dueTime, int period)
internal static Timer UnsafeCreateTimer(
TimerCallback callback,
object state,
int dueTimeMilliseconds,
int periodMilliseconds) =>
UnsafeCreateTimer(
callback,
state,
TimeSpan.FromMilliseconds(dueTimeMilliseconds),
TimeSpan.FromMilliseconds(periodMilliseconds));

internal static Timer UnsafeCreateTimer(TimerCallback callback, object state, TimeSpan dueTime, TimeSpan period)
{
// Don't capture the current ExecutionContext and its AsyncLocals onto
// a global timer causing them to live forever
Expand All @@ -154,6 +165,7 @@ internal static Timer UnsafeCreateTimer(TimerCallback callback, object state, in
}
}
}


#region COM+ exceptions
internal static ArgumentException Argument(string error)
Expand Down
50 changes: 38 additions & 12 deletions src/Microsoft.Data.SqlClient/src/Microsoft/Data/ProviderBase/DbConnectionClosed.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
using System.Threading.Tasks;
using Microsoft.Data.Common;
using Microsoft.Data.Common.ConnectionString;
using Microsoft.Data.SqlClient;
using Microsoft.Data.SqlClient.ConnectionPool;

namespace Microsoft.Data.ProviderBase
Expand All @@ -27,7 +28,7 @@ protected DbConnectionClosed(ConnectionState state, bool hidePassword, bool allo

public override void ChangeDatabase(string database) => throw ADP.ClosedConnectionError();

internal override void CloseConnection(DbConnection owningObject, DbConnectionFactory connectionFactory)
internal override void CloseConnection(DbConnection owningObject, SqlConnectionFactory connectionFactory)
{
// not much to do here...
}
Expand All @@ -36,13 +37,22 @@ internal override void CloseConnection(DbConnection owningObject, DbConnectionFa

public override void EnlistTransaction(System.Transactions.Transaction transaction) => throw ADP.ClosedConnectionError();

protected internal override DataTable GetSchema(DbConnectionFactory factory, DbConnectionPoolGroup poolGroup, DbConnection outerConnection, string collectionName, string[] restrictions)
protected internal override DataTable GetSchema(
SqlConnectionFactory factory,
DbConnectionPoolGroup poolGroup,
DbConnection outerConnection,
string collectionName,
string[] restrictions)
=> throw ADP.ClosedConnectionError();

protected override DbReferenceCollection CreateReferenceCollection() => throw ADP.ClosedConnectionError();

internal override bool TryOpenConnection(DbConnection outerConnection, DbConnectionFactory connectionFactory, TaskCompletionSource<DbConnectionInternal> retry, DbConnectionOptions userOptions)
=> base.TryOpenConnectionInternal(outerConnection, connectionFactory, retry, userOptions);
internal override bool TryOpenConnection(
DbConnection outerConnection,
SqlConnectionFactory connectionFactory,
TaskCompletionSource<DbConnectionInternal> retry,
DbConnectionOptions userOptions) =>
TryOpenConnectionInternal(outerConnection, connectionFactory, retry, userOptions);
}

internal abstract class DbConnectionBusy : DbConnectionClosed
Expand All @@ -51,7 +61,11 @@ protected DbConnectionBusy(ConnectionState state) : base(state, true, false)
{
}

internal override bool TryOpenConnection(DbConnection outerConnection, DbConnectionFactory connectionFactory, TaskCompletionSource<DbConnectionInternal> retry, DbConnectionOptions userOptions)
internal override bool TryOpenConnection(
DbConnection outerConnection,
SqlConnectionFactory connectionFactory,
TaskCompletionSource<DbConnectionInternal> retry,
DbConnectionOptions userOptions)
=> throw ADP.ConnectionAlreadyOpen(State);
}

Expand Down Expand Up @@ -84,15 +98,23 @@ private DbConnectionClosedConnecting() : base(ConnectionState.Connecting)
{
}

internal override void CloseConnection(DbConnection owningObject, DbConnectionFactory connectionFactory)
internal override void CloseConnection(DbConnection owningObject, SqlConnectionFactory connectionFactory)
{
connectionFactory.SetInnerConnectionTo(owningObject, DbConnectionClosedPreviouslyOpened.SingletonInstance);
}

internal override bool TryReplaceConnection(DbConnection outerConnection, DbConnectionFactory connectionFactory, TaskCompletionSource<DbConnectionInternal> retry, DbConnectionOptions userOptions)
=> TryOpenConnection(outerConnection, connectionFactory, retry, userOptions);

internal override bool TryOpenConnection(DbConnection outerConnection, DbConnectionFactory connectionFactory, TaskCompletionSource<DbConnectionInternal> retry, DbConnectionOptions userOptions)
internal override bool TryReplaceConnection(
DbConnection outerConnection,
SqlConnectionFactory connectionFactory,
TaskCompletionSource<DbConnectionInternal> retry,
DbConnectionOptions userOptions) =>
TryOpenConnection(outerConnection, connectionFactory, retry, userOptions);

internal override bool TryOpenConnection(
DbConnection outerConnection,
SqlConnectionFactory connectionFactory,
TaskCompletionSource<DbConnectionInternal> retry,
DbConnectionOptions userOptions)
{
if (retry == null || !retry.Task.IsCompleted)
{
Expand Down Expand Up @@ -137,7 +159,11 @@ private DbConnectionClosedPreviouslyOpened() : base(ConnectionState.Closed, true
{
}

internal override bool TryReplaceConnection(DbConnection outerConnection, DbConnectionFactory connectionFactory, TaskCompletionSource<DbConnectionInternal> retry, DbConnectionOptions userOptions)
=> TryOpenConnection(outerConnection, connectionFactory, retry, userOptions);
internal override bool TryReplaceConnection(
DbConnection outerConnection,
SqlConnectionFactory connectionFactory,
TaskCompletionSource<DbConnectionInternal> retry,
DbConnectionOptions userOptions) =>
TryOpenConnection(outerConnection, connectionFactory, retry, userOptions);
}
}
Loading
Loading