SqlServerComplexTypePropertyBuilderExtensions.IsSparse Method

Definition

Namespace:

Microsoft.EntityFrameworkCore

Assembly:

Microsoft.EntityFrameworkCore.SqlServer.dll

Package:

Microsoft.EntityFrameworkCore.SqlServer v8.0.0

Overloads

IsSparse(ComplexTypePropertyBuilder, Boolean)	Configures whether the property's column is created as sparse when targeting SQL Server.
IsSparse<TProperty>(ComplexTypePropertyBuilder<TProperty>, Boolean)	Configures whether the property's column is created as sparse when targeting SQL Server.

IsSparse(ComplexTypePropertyBuilder, Boolean)

Configures whether the property's column is created as sparse when targeting SQL Server.

public static Microsoft.EntityFrameworkCore.Metadata.Builders.ComplexTypePropertyBuilder IsSparse (this Microsoft.EntityFrameworkCore.Metadata.Builders.ComplexTypePropertyBuilder propertyBuilder, bool sparse = true);

static member IsSparse : Microsoft.EntityFrameworkCore.Metadata.Builders.ComplexTypePropertyBuilder * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.ComplexTypePropertyBuilder

<Extension()>
Public Function IsSparse (propertyBuilder As ComplexTypePropertyBuilder, Optional sparse As Boolean = true) As ComplexTypePropertyBuilder

Parameters

propertyBuilder

ComplexTypePropertyBuilder

The builder for the property being configured.

sparse

Boolean

A value indicating whether the property's column is created as sparse.

Returns

ComplexTypePropertyBuilder

A builder to further configure the property.

Remarks

See Modeling entity types and relationships, and Accessing SQL Server and Azure SQL databases with EF Core for more information and examples. Also see Sparse columns for general information on SQL Server sparse columns.

IsSparse<TProperty>(ComplexTypePropertyBuilder<TProperty>, Boolean)

Configures whether the property's column is created as sparse when targeting SQL Server.

public static Microsoft.EntityFrameworkCore.Metadata.Builders.ComplexTypePropertyBuilder<TProperty> IsSparse<TProperty> (this Microsoft.EntityFrameworkCore.Metadata.Builders.ComplexTypePropertyBuilder<TProperty> propertyBuilder, bool sparse = true);

static member IsSparse : Microsoft.EntityFrameworkCore.Metadata.Builders.ComplexTypePropertyBuilder<'Property> * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.ComplexTypePropertyBuilder<'Property>

<Extension()>
Public Function IsSparse(Of TProperty) (propertyBuilder As ComplexTypePropertyBuilder(Of TProperty), Optional sparse As Boolean = true) As ComplexTypePropertyBuilder(Of TProperty)

Type Parameters

TProperty

Parameters

propertyBuilder

ComplexTypePropertyBuilder<TProperty>

The builder for the property being configured.

sparse

Boolean

A value indicating whether the property's column is created as sparse.

Returns

ComplexTypePropertyBuilder<TProperty>

A builder to further configure the property.

Remarks

See Modeling entity types and relationships, and Accessing SQL Server and Azure SQL databases with EF Core for more information and examples. Also see Sparse columns for general information on SQL Server sparse columns.