Microsoft.EntityFrameworkCore Namespace
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.
Classes
BackingFieldAttribute |
Names the backing field associated with this property or navigation property. |
ChangeTrackerExtensions |
Extension methods for ChangeTracker. |
CommentAttribute |
Marks a class, property or field with a comment to be set on the corresponding database table or column. |
ConventionAnnotatableExtensions |
Extension methods for IConventionAnnotatable. |
ConventionEntityTypeExtensions |
Extension methods for IConventionEntityType. |
ConventionForeignKeyExtensions |
Extension methods for IConventionForeignKey. |
ConventionKeyExtensions |
Extension methods for IConventionKey. |
ConventionModelExtensions |
Extension methods for IConventionModel. |
ConventionNavigationExtensions |
Extension methods for IConventionNavigation. |
ConventionPropertyBaseExtensions |
Extension methods for IConventionPropertyBase. |
ConventionPropertyExtensions |
Extension methods for IConventionProperty. |
ConventionTypeBaseExtensions |
Extension methods for IConventionTypeBase. |
CosmosDatabaseFacadeExtensions |
Extension methods for the DatabaseFacade returned from Database that can be used only with the Cosmos provider. |
CosmosDbContextOptionsExtensions |
Cosmos-specific extension methods for DbContextOptionsBuilder. |
CosmosEntityTypeBuilderExtensions |
Cosmos-specific extension methods for EntityTypeBuilder. |
CosmosEntityTypeExtensions |
Entity type extension methods for Cosmos metadata. |
CosmosIndexBuilderExtensions |
Azure Cosmos DB-specific extension methods for IndexBuilder. |
CosmosIndexExtensions |
Index extension methods for Azure Cosmos DB-specific metadata. |
CosmosModelBuilderExtensions |
Cosmos-specific extension methods for ModelBuilder. |
CosmosModelExtensions |
Model extension methods for Cosmos metadata. |
CosmosPrimitiveCollectionBuilderExtensions |
Cosmos-specific extension methods for PrimitiveCollectionBuilder. |
CosmosPropertyBuilderExtensions |
Cosmos-specific extension methods for PropertyBuilder. |
CosmosPropertyExtensions |
Property extension methods for Cosmos metadata. |
CosmosQueryableExtensions |
Cosmos-specific extension methods for LINQ queries. |
DbContext |
A DbContext instance represents a session with the database and can be used to query and save instances of your entities. DbContext is a combination of the Unit Of Work and Repository patterns. |
DbContextOptions |
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. |
DbContextOptions<TContext> |
The options to be used by a DbContext. You normally override OnConfiguring(DbContextOptionsBuilder) or use a DbContextOptionsBuilder<TContext> to create instances of this class and it is not designed to be directly constructed in your application code. |
DbContextOptionsBuilder |
Provides a simple API surface for configuring DbContextOptions. Databases (and other extensions) typically define extension methods on this object that allow you to configure the database connection (and other options) to be used for a context. |
DbContextOptionsBuilder<TContext> |
Provides a simple API surface for configuring DbContextOptions<TContext>. Databases (and other extensions) typically define extension methods on this object that allow you to configure the database connection (and other options) to be used for a context. |
DbFunctionAttribute |
Maps a static CLR method to a database function so that the CLR method may be used in LINQ queries. By convention uses the .NET method name as name of the database function and the default schema. |
DbFunctions |
Provides CLR methods that get translated to database functions when used in LINQ to Entities queries. The methods on this class are accessed via Functions. |
DbFunctionsExtensions |
Provides CLR methods that get translated to database functions when used in LINQ to Entities queries. The methods on this class are accessed via Functions. |
DbLoggerCategory |
An API for getting logger categories in an Intellisense/tab-completion friendly manner. |
DbLoggerCategory.ChangeTracking |
Logger category for messages from change detection and tracking. |
DbLoggerCategory.Database |
Logger categories for messages related to database interactions. |
DbLoggerCategory.Database.Command |
Logger category for command execution, including SQL sent to the database. |
DbLoggerCategory.Database.Connection |
Logger category for messages related to connection operations. |
DbLoggerCategory.Database.Transaction |
Logger category for messages related to transaction operations. |
DbLoggerCategory.Infrastructure |
Logger category for miscellaneous messages from the Entity Framework infrastructure. |
DbLoggerCategory.Migrations |
Logger category messages from Migrations. |
DbLoggerCategory.Model |
Logger categories for messages related to model building and metadata. |
DbLoggerCategory.Model.Validation |
Logger category for messages from model validation. |
DbLoggerCategory.Query |
Logger category for messages related to queries, excluding the generated SQL, which is in the DbLoggerCategory.Database.Command category. |
DbLoggerCategory.Scaffolding |
Logger category for messages from scaffolding/reverse engineering. |
DbLoggerCategory.Update |
Logger category for messages related to SaveChanges(), excluding messages specifically relating to database interactions which are covered by the DbLoggerCategory.Database categories. |
DbQuery<TQuery> |
A DbQuery<TQuery> can be used to query instances of The results of a LINQ query against a DbQuery<TQuery> will contain the results returned from the database and may not reflect changes made in the context that have not been persisted to the database. For example, the results will not contain newly added views and may still contain views that are marked for deletion. Depending on the database being used, some parts of a LINQ query against a DbQuery<TQuery> may be evaluated in memory rather than being translated into a database query. DbQuery<TQuery> objects are usually obtained from a DbQuery<TQuery> property on a derived DbContext or from the Query<TQuery>() method. |
DbSet<TEntity> |
A DbSet<TEntity> can be used to query and save instances of |
DbUpdateConcurrencyException |
An exception that is thrown when a concurrency violation is encountered while saving to the database. A concurrency violation occurs when an unexpected number of rows are affected during save. This is usually because the data in the database has been modified since it was loaded into memory. |
DbUpdateException |
An exception that is thrown when an error is encountered while saving to the database. |
DeleteBehaviorAttribute |
Configures the navigation property on the dependent side of a relationship to indicate how a delete operation is applied to dependent entities in a relationship when it is deleted or the relationship is severed. |
EF |
Static methods that are useful in application code where there is not an EF type for the method to be accessed from. For example, referencing a shadow state property in a LINQ query. |
EntityFrameworkQueryableExtensions |
Entity Framework LINQ related extension methods. |
EntityTypeConfigurationAttribute |
Specifies the configuration type for the entity type. |
EntityTypeConfigurationAttribute<TConfiguration,TEntity> |
Specifies the configuration type for the entity type. |
EntityTypeExtensions |
Entity type extension methods for IReadOnlyEntityType. |
ExecutionStrategyExtensions |
Extension methods for IExecutionStrategy |
ForeignKeyExtensions |
Extension methods for IReadOnlyForeignKey. |
IndexAttribute |
Specifies an index to be generated in the database. |
IndexExtensions |
Extension methods for IIndex. |
InMemoryDatabaseFacadeExtensions |
In-memory specific extension methods for Database. |
InMemoryDbContextOptionsExtensions |
In-memory specific extension methods for DbContextOptionsBuilder. |
InMemoryEntityTypeBuilderExtensions |
Extension methods for EntityTypeBuilder for the in-memory provider. |
InMemoryEntityTypeExtensions |
Extension methods for IReadOnlyEntityType for the in-memory provider. |
KeyExtensions |
Extension methods for IReadOnlyKey. |
KeylessAttribute |
Marks a type as keyless entity. |
LazyLoadingProxiesOptionsBuilder |
Allows SQL Server specific configuration to be performed on DbContextOptions. |
ModelBuilder |
Provides a simple API surface for configuring a IMutableModel that defines the shape of your entities, the relationships between them, and how they map to the database. |
ModelConfigurationBuilder |
Provides a simple API surface for setting defaults and configuring conventions before they run. |
ModelCreationDependencies |
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. |
ModelExtensions |
Extension methods for IReadOnlyModel. |
MutableAnnotatableExtensions |
Extension methods for IMutableAnnotatable. |
MutableEntityTypeExtensions |
Extension methods for IMutableEntityType. |
MutableForeignKeyExtensions |
Extension methods for IMutableForeignKey. |
MutableKeyExtensions |
Extension methods for IMutableKey. |
MutableModelExtensions |
Extension methods for IMutableModel. |
MutableNavigationExtensions |
Extension methods for IMutableNavigation. |
MutablePropertyBaseExtensions |
Extension methods for IMutablePropertyBase. |
MutablePropertyExtensions |
Extension methods for IMutableProperty. |
MutableTypeBaseExtensions |
Extension methods for IMutableTypeBase. |
NavigationExtensions |
Extension methods for IReadOnlyNavigation. |
ObservableCollectionExtensions |
Extension methods for ObservableCollection<T>. |
OwnedAttribute |
Marks a type as owned. All references to this type will be configured as owned entity types. |
PrecisionAttribute |
Configures the precision of data that is allowed in this property. For example, if the property is a Decimal then this is the maximum number of digits. |
PrimaryKeyAttribute |
Specifies a primary key for the entity type mapped to this CLR type. |
PropertyBaseExtensions |
Extension methods for IReadOnlyPropertyBase. |
PropertyExtensions |
Extension methods for IReadOnlyProperty. |
ProxiesExtensions |
Extension methods related to use of proxies with Entity Framework Core. |
RelationalCollectionOwnershipBuilderExtensions |
Relational database specific extension methods for CollectionOwnershipBuilder. |
RelationalComplexTypeExtensions |
Complex type extension methods for relational database metadata. |
RelationalComplexTypePrimitiveCollectionBuilderExtensions |
Relational database specific extension methods for ComplexTypePrimitiveCollectionBuilder. |
RelationalComplexTypePropertyBuilderExtensions |
Relational database specific extension methods for ComplexTypePropertyBuilder. |
RelationalDatabaseFacadeExtensions |
Extension methods for the DatabaseFacade returned from Database that can be used only with relational database providers. |
RelationalDbFunctionsExtensions |
Provides CLR methods that get translated to database functions when used in LINQ to Entities queries. The methods on this class are accessed via Functions. |
RelationalElementTypeBuilderExtensions |
Relational database specific extension methods for ElementTypeBuilder. |
RelationalElementTypeExtensions |
IElementType extension methods for relational database metadata. |
RelationalEntityTypeBuilderExtensions |
Relational database specific extension methods for EntityTypeBuilder. |
RelationalEntityTypeExtensions |
Entity type extension methods for relational database metadata. |
RelationalForeignKeyBuilderExtensions |
Relational database specific extension methods for relationship builders. |
RelationalForeignKeyExtensions |
Foreign key extension methods for relational database metadata. |
RelationalIndexBuilderExtensions |
Relational database specific extension methods for IndexBuilder. |
RelationalIndexExtensions |
Index extension methods for relational database metadata. |
RelationalKeyBuilderExtensions |
Relational database specific extension methods for KeyBuilder. |
RelationalKeyExtensions |
Key extension methods for relational database metadata. |
RelationalMetadataExtensions |
Relational database specific extension methods for metadata. |
RelationalModelBuilderExtensions |
Relational database specific extension methods for ModelBuilder. |
RelationalModelExtensions |
Relational-specific model extension methods. |
RelationalOwnedNavigationBuilderExtensions |
Relational database specific extension methods for OwnedNavigationBuilder. |
RelationalPrimitiveCollectionBuilderExtensions |
Relational database specific extension methods for PrimitiveCollectionBuilder. |
RelationalPropertiesConfigurationBuilderExtensions |
Relational database specific extension methods for PropertiesConfigurationBuilder. |
RelationalPropertyBuilderExtensions |
Relational database specific extension methods for PropertyBuilder. |
RelationalPropertyExtensions |
Property extension methods for relational database metadata. |
RelationalQueryableExtensions |
Relational database specific extension methods for LINQ queries. |
RelationalQueryTypeBuilderExtensions |
Relational database specific extension methods for QueryTypeBuilder. |
RelationalReferenceCollectionBuilderExtensions |
Relational database specific extension methods for ReferenceCollectionBuilder. |
RelationalReferenceOwnershipBuilderExtensions |
Relational database specific extension methods for ReferenceOwnershipBuilder. |
RelationalReferenceReferenceBuilderExtensions |
Relational database specific extension methods for ReferenceReferenceBuilder. |
RelationalTriggerBuilderExtensions |
Relational database specific extension methods for TriggerBuilder. |
RelationalTriggerExtensions |
Trigger extension methods for relational database metadata. |
RelationalTypeBaseExtensions |
Type extension methods for relational database metadata. |
RelationalTypeMappingConfigurationBuilderExtensions |
Relational database specific extension methods for TypeMappingConfigurationBuilder. |
SaveChangesEventArgs |
Base event arguments for the DbContext.SaveChanges and DbContext.SaveChangesAsync events. |
SaveChangesFailedEventArgs |
Event arguments for the SaveChangesFailed event. |
SavedChangesEventArgs |
Event arguments for the SavedChanges event. |
SavingChangesEventArgs |
Event arguments for the SavingChanges event. |
ScaffoldingModelExtensions |
Design-time model extensions. |
ServicePropertyExtensions |
Extension methods for IServiceProperty. |
SkipNavigationExtensions |
Extension methods for ISkipNavigation. |
SqliteComplexTypePropertyBuilderExtensions |
SQLite-specific extension methods for ComplexTypePropertyBuilder. |
SqliteDatabaseFacadeExtensions |
SQLite specific extension methods for Database. |
SqliteDbContextOptionsBuilderExtensions |
SQLite specific extension methods for DbContextOptionsBuilder. |
SqliteDbFunctionsExtensions |
Contains extension methods on DbFunctions for the Microsoft.EntityFrameworkCore.Sqlite provider. |
SqliteEntityTypeBuilderExtensions |
Entity type builder extension methods for Sqlite-specific metadata. |
SqliteEntityTypeExtensions |
Entity type extension methods for Sqlite-specific metadata. |
SqliteEntityTypeMappingFragmentExtensions |
SQLite specific extension methods for IReadOnlyEntityTypeMappingFragment. |
SqliteIndexBuilderExtensions |
SQLite specific extension methods for IndexBuilder. |
SqliteKeyBuilderExtensions |
SQLite specific extension methods for KeyBuilder. |
SqliteMetadataExtensions |
SQLite specific extension methods for metadata. |
SqliteNetTopologySuiteDbContextOptionsBuilderExtensions |
NetTopologySuite specific extension methods for SqliteDbContextOptionsBuilder. |
SqliteNetTopologySuitePropertyBuilderExtensions |
SQLite and NetTopologySuite specific extension methods for PropertyBuilder. |
SqlitePropertyBuilderExtensions |
SQLite-specific extension methods for PropertyBuilder. |
SqlitePropertyExtensions |
Extension methods for IProperty for SQLite metadata. |
SqliteReferenceCollectionBuilderExtensions |
SQLite specific extension methods for ReferenceCollectionBuilder. |
SqliteReferenceReferenceBuilderExtensions |
SQLite specific extension methods for ReferenceReferenceBuilder. |
SqliteTableBuilderExtensions |
Sqlite-specific extension methods for TableBuilder. |
SqliteTableExtensions |
SQLite specific extension methods for ITable. |
SqlServerCollectionOwnershipBuilderExtensions |
SQL Server specific extension methods for CollectionOwnershipBuilder. |
SqlServerComplexTypePrimitiveCollectionBuilderExtensions |
SQL Server specific extension methods for ComplexTypePrimitiveCollectionBuilder. |
SqlServerComplexTypePropertyBuilderExtensions |
SQL Server specific extension methods for ComplexTypePropertyBuilder. |
SqlServerDatabaseFacadeExtensions |
SQL Server specific extension methods for Database. |
SqlServerDbContextOptionsExtensions |
SQL Server specific extension methods for DbContextOptionsBuilder. |
SqlServerDbFunctionsExtensions |
Provides CLR methods that get translated to database functions when used in LINQ to Entities queries. The methods on this class are accessed via Functions. |
SqlServerDbSetExtensions |
Sql Server database specific extension methods for LINQ queries rooted in DbSet. |
SqlServerEntityTypeBuilderExtensions |
SQL Server specific extension methods for EntityTypeBuilder. |
SqlServerEntityTypeExtensions |
Entity type extension methods for SQL Server-specific metadata. |
SqlServerEntityTypeMappingFragmentExtensions |
SQL Server specific extension methods for IReadOnlyEntityTypeMappingFragment. |
SqlServerIndexBuilderExtensions |
SQL Server specific extension methods for IndexBuilder. |
SqlServerIndexExtensions |
Index extension methods for SQL Server-specific metadata. |
SqlServerKeyBuilderExtensions |
SQL Server specific extension methods for KeyBuilder. |
SqlServerKeyExtensions |
Key extension methods for SQL Server-specific metadata. |
SqlServerMetadataExtensions |
SQL Server specific extension methods for metadata. |
SqlServerModelBuilderExtensions |
SQL Server specific extension methods for ModelBuilder. |
SqlServerModelExtensions |
Model extension methods for SQL Server-specific metadata. |
SqlServerNetTopologySuiteDbContextOptionsBuilderExtensions |
NetTopologySuite specific extension methods for SqlServerDbContextOptionsBuilder. |
SqlServerPrimitiveCollectionBuilderExtensions |
SQL Server specific extension methods for PrimitiveCollectionBuilder. |
SqlServerPropertyBuilderExtensions |
SQL Server specific extension methods for PropertyBuilder. |
SqlServerPropertyExtensions |
Property extension methods for SQL Server-specific metadata. |
SqlServerReferenceCollectionBuilderExtensions |
SQL Server specific extension methods for ReferenceCollectionBuilder. |
SqlServerReferenceOwnershipBuilderExtensions |
SQL Server specific extension methods for ReferenceOwnershipBuilder. |
SqlServerReferenceReferenceBuilderExtensions |
SQL Server specific extension methods for ReferenceReferenceBuilder. |
SqlServerRetryingExecutionStrategy |
An IExecutionStrategy implementation for retrying failed executions on SQL Server. |
SqlServerTableBuilderExtensions |
SQL Server specific extension methods for TableBuilder. |
SqlServerTableExtensions |
SQL Server specific extension methods for ITable. |
TableExpressionExtensions |
Type extension methods for TableExpressionBase and related types. |
TypeBaseExtensions |
Extension methods for IReadOnlyTypeBase. |
UnicodeAttribute |
Configures the property as capable of persisting unicode characters. |
WarningConfigurationBuilderExtensions |
Relational database specific extension methods for WarningsConfigurationBuilder. |
Structs
CosmosPage<T> |
A single page of results returned from a user query; can be used to paginate through long result-sets. Returned by ToPageAsync<TSource>(IQueryable<TSource>, Int32, String, Nullable<Int32>, CancellationToken). |
DbContextId |
A unique identifier for the context instance and pool lease, if any. |
RawSqlString |
A string representing a raw SQL query. This type enables overload resolution between the regular and interpolated FromSql<TEntity>(IQueryable<TEntity>, RawSqlString, Object[]) and ExecuteSqlCommand(DatabaseFacade, RawSqlString, Object[]) |
Interfaces
IDbContextFactory<TContext> |
Defines a factory for creating DbContext instances. |
IEntityTypeConfiguration<TEntity> |
Allows configuration for an entity type to be factored into a separate class, rather than in-line in OnModelCreating(ModelBuilder). Implement this interface, applying configuration for the entity in the Configure(EntityTypeBuilder<TEntity>) method, and then apply the configuration to the model using ApplyConfiguration<TEntity>(IEntityTypeConfiguration<TEntity>) in OnModelCreating(ModelBuilder). |
IQueryTypeConfiguration<TQuery> |
Allows configuration for a query type to be factored into a separate class, rather than in-line in OnModelCreating(ModelBuilder). Implement this interface, applying configuration for the query in the Configure(QueryTypeBuilder<TQuery>) method, and then apply the configuration to the model using ApplyConfiguration<TQuery>(IQueryTypeConfiguration<TQuery>) in OnModelCreating(ModelBuilder). |
Enums
AutoTransactionBehavior |
Indicates whether a transaction will be created automatically by SaveChanges() if a user transaction wasn't created via 'BeginTransaction' or provided via 'UseTransaction'. |
ChangeTrackingStrategy |
Indicates how the context detects changes to properties for an instance of the entity type. |
DataCompressionType |
Indicates type of data compression used on a index. |
DeleteBehavior |
Indicates how a delete operation is applied to dependent entities in a relationship when the principal is deleted or the relationship is severed. |
EntityState |
The state in which an entity is being tracked by a context. |
PropertyAccessMode |
Pass a value from this enum to UsePropertyAccessMode(PropertyAccessMode), UsePropertyAccessMode(PropertyAccessMode), or UsePropertyAccessMode(PropertyAccessMode) to change whether the property or backing field will be used when reading and writing to a property or field. |
QuerySplittingBehavior |
Indicates how the related collections in a query should be loaded from database. |
QueryTrackingBehavior |
Indicates how the results of a query are tracked by the ChangeTracker. |
WarningBehavior |
The runtime behavior of warnings generated by Entity Framework |