CosmosDatabaseFacadeExtensions.IsCosmos(DatabaseFacade) Method

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore

Assembly:: Microsoft.EntityFrameworkCore.Cosmos.dll

Package:: Microsoft.EntityFrameworkCore.Cosmos v3.0.0

Package:: Microsoft.EntityFrameworkCore.Cosmos v3.1.0

Package:: Microsoft.EntityFrameworkCore.Cosmos v5.0.0

Package:: Microsoft.EntityFrameworkCore.Cosmos v6.0.0

Package:: Microsoft.EntityFrameworkCore.Cosmos v7.0.0

Package:: Microsoft.EntityFrameworkCore.Cosmos 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.

Returns true if the database provider currently in use is the Cosmos provider.

public static bool IsCosmos (this Microsoft.EntityFrameworkCore.Infrastructure.DatabaseFacade database);

static member IsCosmos : Microsoft.EntityFrameworkCore.Infrastructure.DatabaseFacade -> bool

<Extension()>
Public Function IsCosmos (database As DatabaseFacade) As Boolean

Parameters

database: DatabaseFacade

The facade from Database.

Returns

Boolean

true if the Cosmos provider is being used.

Remarks

This method can only be used after the DbContext has been configured because it is only then that the provider is known. This means that this method cannot be used in OnConfiguring(DbContextOptionsBuilder) because this is where application code sets the provider to use as part of configuring the context.

See Accessing Azure Cosmos DB with EF Core for more information and examples.

Applies to