IDatabaseCreator.CanConnectAsync(CancellationToken) Method

Definition

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

true if the database is available; false otherwise.

Exceptions

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