IConventionKeyBuilder Interface

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly:: Microsoft.EntityFrameworkCore.dll

Package:: Microsoft.EntityFrameworkCore v3.0.0

Package:: Microsoft.EntityFrameworkCore v3.1.0

Package:: Microsoft.EntityFrameworkCore v5.0.0

Package:: Microsoft.EntityFrameworkCore v6.0.0

Package:: Microsoft.EntityFrameworkCore v7.0.0

Package:: Microsoft.EntityFrameworkCore 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.

Provides a simple API surface for configuring an IConventionKey from conventions.

This interface is typically used by database providers (and other extensions). It is generally not used in application code.

public interface IConventionKeyBuilder : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionAnnotatableBuilder

type IConventionKeyBuilder = interface
    interface IConventionAnnotatableBuilder

Public Interface IConventionKeyBuilder
Implements IConventionAnnotatableBuilder

Implements: IConventionAnnotatableBuilder

Remarks

See Model building conventions for more information and examples.

Properties

Metadata	Gets the key being configured.
ModelBuilder	Gets the model builder. (Inherited from IConventionAnnotatableBuilder)

Methods

CanRemoveAnnotation(String, Boolean)	Returns a value indicating whether an annotation with the given name can be removed using this configuration source. (Inherited from IConventionAnnotatableBuilder)
CanSetAnnotation(String, Object, Boolean)	Returns a value indicating whether an annotation with the given name and value can be set from this configuration source. (Inherited from IConventionAnnotatableBuilder)
HasAnnotation(String, Object, Boolean)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists with same or lower ConfigurationSource.
HasNoAnnotation(String, Boolean)	Removes the annotation with the given name from this object.
HasNonNullAnnotation(String, Object, Boolean)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists with same or lower ConfigurationSource. Removes the annotation if `null` value is specified.
RemoveAnnotation(String, Boolean)	Obsolete. Removes the annotation with the given name from this object. (Inherited from IConventionAnnotatableBuilder)
SetOrRemoveAnnotation(String, Object, Boolean)	Obsolete. Sets or removes the annotation stored under the given name. (Inherited from IConventionAnnotatableBuilder)

Extension Methods

CanSetName(IConventionKeyBuilder, String, Boolean)	Returns a value indicating whether the given name can be set for the key constraint.
HasName(IConventionKeyBuilder, String, Boolean)	Configures the name of the key constraint in the database when targeting a relational database.
CanSetIsClustered(IConventionKeyBuilder, Nullable<Boolean>, Boolean)	Returns a value indicating whether the key can be configured as clustered.
ForSqlServerIsClustered(IConventionKeyBuilder, Nullable<Boolean>, Boolean)	Obsolete. Configures whether the key is clustered when targeting SQL Server.
IsClustered(IConventionKeyBuilder, Nullable<Boolean>, Boolean)	Configures whether the key is clustered when targeting SQL Server.

Applies to