SqlServerIndexBuilderExtensions.CanSetIncludeProperties Method

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore

Assembly:: Microsoft.EntityFrameworkCore.SqlServer.dll

Package:: Microsoft.EntityFrameworkCore.SqlServer v3.0.0

Package:: Microsoft.EntityFrameworkCore.SqlServer v3.1.0

Package:: Microsoft.EntityFrameworkCore.SqlServer v5.0.0

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.

Returns a value indicating whether the given include properties can be set.

public static bool CanSetIncludeProperties (this Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder indexBuilder, System.Collections.Generic.IReadOnlyList<string> propertyNames, bool fromDataAnnotation = false);

public static bool CanSetIncludeProperties (this Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder indexBuilder, System.Collections.Generic.IReadOnlyList<string>? propertyNames, bool fromDataAnnotation = false);

static member CanSetIncludeProperties : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionIndexBuilder * System.Collections.Generic.IReadOnlyList<string> * bool -> bool

<Extension()>
Public Function CanSetIncludeProperties (indexBuilder As IConventionIndexBuilder, propertyNames As IReadOnlyList(Of String), Optional fromDataAnnotation As Boolean = false) As Boolean

Parameters

indexBuilder: IConventionIndexBuilder

The builder for the index being configured.

propertyNames: IReadOnlyList<String>

An array of property names to be used in 'include' clause.

fromDataAnnotation: Boolean

Indicates whether the configuration was specified using a data annotation.

Returns

Boolean

true if the given include properties can be set.

Remarks

See Modeling entity types and relationships, and Accessing SQL Server and Azure SQL databases with EF Core for more information and examples.

Applies to