Class TableBuilder<TEntity>

Namespace

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly

Microsoft.EntityFrameworkCore.Relational.dll

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

public class TableBuilder<TEntity> : TableBuilder, IInfrastructure<EntityTypeBuilder>, IInfrastructure<EntityTypeBuilder<TEntity>> where TEntity : class

Type Parameters

TEntity

The entity type being configured.

Inheritance

object

TableBuilder

TableBuilder<TEntity>

Implements

IInfrastructure<EntityTypeBuilder>

IInfrastructure<EntityTypeBuilder<TEntity>>

Inherited Members

TableBuilder.HasTrigger(string)

TableBuilder.HasCheckConstraint(string, string)

TableBuilder.Property(string)

TableBuilder.Property<TProperty>(string)

TableBuilder.GetStoreObjectIdentifier()

TableBuilder.Name

TableBuilder.Schema

TableBuilder.StoreObject

TableBuilder.Metadata

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

TableBuilder(in StoreObjectIdentifier?, EntityTypeBuilder<TEntity>)

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.

public TableBuilder(in StoreObjectIdentifier? storeObject, EntityTypeBuilder<TEntity> entityTypeBuilder)

Parameters

storeObject StoreObjectIdentifier?

entityTypeBuilder EntityTypeBuilder<TEntity>

Methods

ExcludeFromMigrations(bool)

Configures the table to be ignored by migrations.

public virtual TableBuilder<TEntity> ExcludeFromMigrations(bool excluded = true)

Parameters

excluded bool

A value indicating whether the table should be managed by migrations.

Returns

TableBuilder<TEntity>

The same builder instance so that multiple calls can be chained.

Remarks

See Database migrations for more information and examples.

HasComment(string?)

Configures a comment to be applied to the table

public virtual TableBuilder<TEntity> HasComment(string? comment)

Parameters

comment string

The comment for the table.

Returns

TableBuilder<TEntity>

A builder to further configure the table.

Remarks

See Modeling entity types and relationships for more information and examples.

Property<TProperty>(Expression<Func<TEntity, TProperty>>)

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.

public virtual ColumnBuilder<TProperty> Property<TProperty>(Expression<Func<TEntity, TProperty>> propertyExpression)

Parameters

propertyExpression Expression<Func<TEntity, TProperty>>

A lambda expression representing the property to be configured (blog => blog.Url).

Returns

ColumnBuilder<TProperty>

An object that can be used to configure the property.

Type Parameters

TProperty