IDatabaseCreator.CanConnectAsync(CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Storage

Assembly:: Microsoft.EntityFrameworkCore.dll

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

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 or not the database is available and can be connected to.

public System.Threading.Tasks.Task<bool> CanConnectAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member CanConnectAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>

Public 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

Task<Boolean>

true if the database is available; false otherwise.

Exceptions

OperationCanceledException

If the CancellationToken is canceled.

Remarks

Note that being able to connect to the database does not mean that it is up-to-date with regard to schema creation, etc.

Applies to