TableBuilder Class

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly:

Microsoft.EntityFrameworkCore.Relational.dll

Package:

Microsoft.EntityFrameworkCore.Relational v8.0.0

Instances of this class are returned from methods when using the ModelBuilder API and it is not designed to be directly constructed in your application code.

public class TableBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Builders.EntityTypeBuilder>

type TableBuilder = class
    interface IInfrastructure<EntityTypeBuilder>

Public Class TableBuilder
Implements IInfrastructure(Of EntityTypeBuilder)

Inheritance

Object

TableBuilder

Derived

Microsoft.EntityFrameworkCore.Metadata.Builders.TableBuilder<TEntity>

Implements

IInfrastructure<EntityTypeBuilder>

Constructors

TableBuilder(Nullable<StoreObjectIdentifier>, EntityTypeBuilder)

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

Metadata	The entity type being configured.
Name	The specified table name.
Schema	The specified table schema.
StoreObject	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.

Methods

ExcludeFromMigrations(Boolean)	Configures the table to be ignored by migrations.
GetStoreObjectIdentifier()	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.
HasCheckConstraint(String, String)	Configures a database check constraint when targeting a relational database.
HasComment(String)	Configures a comment to be applied to the table
HasTrigger(String)	Configures a database trigger on the table.
Property(String)	Maps the property to a column on the current table and returns an object that can be used to provide table-specific configuration if the property is mapped to more than one table.
Property<TProperty>(String)	Maps the property to a column on the current table and returns an object that can be used to provide table-specific configuration if the property is mapped to more than one table.

Explicit Interface Implementations

IInfrastructure<EntityTypeBuilder>.Instance

Extension Methods

GetInfrastructure<T>(IInfrastructure<T>)	Gets the value from a property that is being hidden using IInfrastructure<T>. This method is typically used by database providers (and other extensions). It is generally not used in application code.
UseSqlReturningClause(TableBuilder, Boolean)	Configures whether to use the SQL RETURNING clause when saving changes to the table. The RETURNING clause is incompatible with certain Sqlite features, such as virtual tables or tables with AFTER triggers.
IsMemoryOptimized(TableBuilder, Boolean)	Configures the table that the entity maps to when targeting SQL Server as memory-optimized.
IsTemporal(TableBuilder, Action<TemporalTableBuilder>)	Configures the table as temporal.
IsTemporal(TableBuilder, Boolean)	Configures the table as temporal.
UseSqlOutputClause(TableBuilder, Boolean)	Configures whether to use the SQL OUTPUT clause when saving changes to the table. The OUTPUT clause is incompatible with certain SQL Server features, such as tables with triggers.