Share via

IConventionForeignKeyBuilder.IsRequired Method

  • Reference

Definition

Namespace:
Microsoft.EntityFrameworkCore.Metadata.Builders
Assembly:
Microsoft.EntityFrameworkCore.dll
Package:
Microsoft.EntityFrameworkCore v5.0.0
Package:
Microsoft.EntityFrameworkCore v6.0.0
Package:
Microsoft.EntityFrameworkCore v7.0.0
Package:
Microsoft.EntityFrameworkCore v8.0.0
Package:
Microsoft.EntityFrameworkCore v9.0.0
Source:
IConventionForeignKeyBuilder.cs
Source:
IConventionForeignKeyBuilder.cs
Source:
IConventionForeignKeyBuilder.cs

Configures whether this is a required relationship (i.e. whether none of the foreign key properties can be assigned null).

public Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionForeignKeyBuilder IsRequired (bool? required, bool fromDataAnnotation = false);
public Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionForeignKeyBuilder? IsRequired (bool? required, bool fromDataAnnotation = false);
abstract member IsRequired : Nullable<bool> * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionForeignKeyBuilder
Public Function IsRequired (required As Nullable(Of Boolean), Optional fromDataAnnotation As Boolean = false) As IConventionForeignKeyBuilder

Parameters

required
Nullable<Boolean>

A value indicating whether this is a required relationship. null to reset to default.

fromDataAnnotation
Boolean

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionForeignKeyBuilder

The same builder instance if the requiredness was configured, null otherwise.

Applies to