Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
DatabaseFacade.CanConnectAsync(CancellationToken) Method
Definition
- Namespace:
- Microsoft.EntityFrameworkCore.Infrastructure
- Assembly:
- Microsoft.EntityFrameworkCore.dll
- Package:
- Microsoft.EntityFrameworkCore v10.0.0
- Package:
- Microsoft.EntityFrameworkCore v2.2.6
- Package:
- Microsoft.EntityFrameworkCore v3.0.0
- Package:
- Microsoft.EntityFrameworkCore v3.1.0
- Package:
- Microsoft.EntityFrameworkCore v5.0.0
- Package:
- Microsoft.EntityFrameworkCore v6.0.0
- Package:
- Microsoft.EntityFrameworkCore v7.0.0
- Package:
- Microsoft.EntityFrameworkCore v8.0.0
- Package:
- Microsoft.EntityFrameworkCore v9.0.0
- Source:
- DatabaseFacade.cs
- Source:
- DatabaseFacade.cs
- Source:
- DatabaseFacade.cs
- Source:
- DatabaseFacade.cs
- Source:
- DatabaseFacade.cs
- Source:
- DatabaseFacade.cs
- Source:
- DatabaseFacade.cs
- Source:
- DatabaseFacade.cs
- Source:
- DatabaseFacade.cs
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Determines whether the database is available and can be connected to.
public virtual System.Threading.Tasks.Task<bool> CanConnectAsync(System.Threading.CancellationToken cancellationToken = default);abstract member CanConnectAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
override this.CanConnectAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>Public Overridable Function CanConnectAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)Parameters
- cancellationToken
- CancellationToken
A CancellationToken to observe while waiting for the task to complete.
Returns
true if the database is available; false otherwise.
Exceptions
If the CancellationToken is canceled.
Remarks
Any exceptions thrown when attempting to connect are caught and not propagated to the application.
The configured connection string is used to create the connection in the normal way, so all configured options such as timeouts are honored.
Note that being able to connect to the database does not mean that it is up-to-date with regard to schema creation, etc.
Entity Framework Core does not support multiple parallel operations being run on the same DbContext instance. This includes both parallel execution of async queries and any explicit concurrent use from multiple threads. Therefore, always await async calls immediately, or use separate DbContext instances for operations that execute in parallel. See Avoiding DbContext threading issues for more information and examples.
See Database connections in EF Core for more information and examples.
Applies to
Entity Framework
Feedback
Was this page helpful?