RelationalEntityTypeExtensions.SetComment Method

Definition

Namespace:

Microsoft.EntityFrameworkCore

Assembly:

Microsoft.EntityFrameworkCore.Relational.dll

Package:

Microsoft.EntityFrameworkCore.Relational v8.0.0

Overloads

SetComment(IMutableEntityType, String)	Configures a comment to be applied to the table this entity is mapped to.
SetComment(IConventionEntityType, String, Boolean)	Configures a comment to be applied to the table this entity is mapped to.

SetComment(IMutableEntityType, String)

Configures a comment to be applied to the table this entity is mapped to.

public static void SetComment (this Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType entityType, string? comment);

static member SetComment : Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType * string -> unit

<Extension()>
Public Sub SetComment (entityType As IMutableEntityType, comment As String)

Parameters

entityType

IMutableEntityType

The entity type.

comment

String

The comment for the table this entity is mapped to.

SetComment(IConventionEntityType, String, Boolean)

Configures a comment to be applied to the table this entity is mapped to.

public static string? SetComment (this Microsoft.EntityFrameworkCore.Metadata.IConventionEntityType entityType, string? comment, bool fromDataAnnotation = false);

static member SetComment : Microsoft.EntityFrameworkCore.Metadata.IConventionEntityType * string * bool -> string

<Extension()>
Public Function SetComment (entityType As IConventionEntityType, comment As String, Optional fromDataAnnotation As Boolean = false) As String

Parameters

entityType

IConventionEntityType

The entity type.

comment

String

The comment for the table.

fromDataAnnotation

Boolean

Indicates whether the configuration was specified using a data annotation.

Returns

String

The configured comment.