SqlServerEntityTypeBuilderExtensions.UseHistoryTableSchema Method

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore

Assembly:: Microsoft.EntityFrameworkCore.SqlServer.dll

Package:: Microsoft.EntityFrameworkCore.SqlServer v6.0.0

Package:: Microsoft.EntityFrameworkCore.SqlServer v7.0.0

Package:: Microsoft.EntityFrameworkCore.SqlServer v8.0.0

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.

Configures a history table schema for the entity mapped to a temporal table.

public static Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionEntityTypeBuilder? UseHistoryTableSchema (this Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionEntityTypeBuilder entityTypeBuilder, string? schema, bool fromDataAnnotation = false);

static member UseHistoryTableSchema : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionEntityTypeBuilder * string * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionEntityTypeBuilder

<Extension()>
Public Function UseHistoryTableSchema (entityTypeBuilder As IConventionEntityTypeBuilder, schema As String, Optional fromDataAnnotation As Boolean = false) As IConventionEntityTypeBuilder

Parameters

entityTypeBuilder: IConventionEntityTypeBuilder

The builder for the entity being configured.

schema: String

The schema of the history table.

fromDataAnnotation: Boolean

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionEntityTypeBuilder

The same builder instance if the configuration was applied, null otherwise.

Remarks

See Using SQL Server temporal tables with EF Core for more information and examples.

Applies to