DbContextOptions Class

Definition

The options to be used by a DbContext. You normally override OnConfiguring(DbContextOptionsBuilder) or use a DbContextOptionsBuilder to create instances of this class and it is not designed to be directly constructed in your application code.

public abstract class DbContextOptions : Microsoft.EntityFrameworkCore.Infrastructure.IDbContextOptions
Inheritance
DbContextOptions
Derived
Implements

Remarks

See Using DbContextOptions for more information and examples.

Constructors

DbContextOptions()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

DbContextOptions(ImmutableSortedDictionary<Type,ValueTuple<IDbContextOptionsExtension,Int32>>)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

DbContextOptions(IReadOnlyDictionary<Type,IDbContextOptionsExtension>)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

Properties

ContextType

The type of context that these options are for. Will return DbContext if the options are not built for a specific derived context.

Extensions

Gets the extensions that store the configured options.

ExtensionsMap

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

IsFrozen

Returns true if Freeze() has been called. A frozen options object cannot be further configured with OnConfiguring(DbContextOptionsBuilder).

Methods

Equals(DbContextOptions)

Determines whether the specified object is equal to the current object.

Equals(Object)

Determines whether the specified object is equal to the current object.

FindExtension<TExtension>()

Gets the extension of the specified type. Returns null if no extension of the specified type is configured.

Freeze()

Specifies that no further configuration of this options object should occur.

GetExtension<TExtension>()

Gets the extension of the specified type. Throws if no extension of the specified type is configured.

GetHashCode()

Serves as the default hash function.

WithExtension<TExtension>(TExtension)

Adds the given extension to the underlying options and creates a new DbContextOptions with the extension added.

Applies to

Product Versions
Entity Framework Core 1.0, 1.1, 2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0