Class TableBuilder

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 : IInfrastructure<EntityTypeBuilder>

Inheritance

object

TableBuilder

Implements

IInfrastructure<EntityTypeBuilder>

Derived

TableBuilder<TEntity>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

TableBuilder(in 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.

public TableBuilder(in StoreObjectIdentifier? storeObject, EntityTypeBuilder entityTypeBuilder)

Parameters

storeObject StoreObjectIdentifier?

entityTypeBuilder EntityTypeBuilder

Properties

Metadata

The entity type being configured.

public virtual IMutableEntityType Metadata { get; }

Property Value

IMutableEntityType

Name

The specified table name.

public virtual string? Name { get; }

Property Value

string

Schema

The specified table schema.

public virtual string? Schema { get; }

Property Value

string

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.

protected virtual StoreObjectIdentifier? StoreObject { get; }

Property Value

StoreObjectIdentifier?

Methods

ExcludeFromMigrations(bool)

Configures the table to be ignored by migrations.

public virtual TableBuilder ExcludeFromMigrations(bool excluded = true)

Parameters

excluded bool

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

Returns

TableBuilder

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

Remarks

See Database migrations for more information and examples.

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.

protected virtual StoreObjectIdentifier GetStoreObjectIdentifier()

Returns

StoreObjectIdentifier

HasCheckConstraint(string, string?)

Configures a database check constraint when targeting a relational database.

public virtual CheckConstraintBuilder HasCheckConstraint(string name, string? sql)

Parameters

name string

The name of the check constraint.

sql string

The logical constraint sql used in the check constraint.

Returns

CheckConstraintBuilder

A builder to configure the check constraint.

Remarks

See Database check constraints for more information and examples.

HasComment(string?)

Configures a comment to be applied to the table

public virtual TableBuilder HasComment(string? comment)

Parameters

comment string

The comment for the table.

Returns

TableBuilder

A builder to further configure the table.

Remarks

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

HasTrigger(string)

Configures a database trigger on the table.

public virtual TableTriggerBuilder HasTrigger(string modelName)

Parameters

modelName string

The name of the trigger.

Returns

TableTriggerBuilder

A builder that can be used to configure the database trigger.

Remarks

See Database triggers for more information and examples.

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.

public virtual ColumnBuilder Property(string propertyName)

Parameters

propertyName string

The name of the property to be configured.

Returns

ColumnBuilder

An object that can be used to configure the property.

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.

public virtual ColumnBuilder<TProperty> Property<TProperty>(string propertyName)

Parameters

propertyName string

The name of the property to be configured.

Returns

ColumnBuilder<TProperty>

An object that can be used to configure the property.

Type Parameters

TProperty

The type of the property to be configured.