Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

CosmosModelBuilderExtensions.HasShadowIds Method

Definition

Namespace:
Microsoft.EntityFrameworkCore
Assembly:
Microsoft.EntityFrameworkCore.Cosmos.dll
Package:
Microsoft.EntityFrameworkCore.Cosmos v10.0.0
Package:
Microsoft.EntityFrameworkCore.Cosmos v9.0.0
Source:
CosmosModelBuilderExtensions.cs
Source:
CosmosModelBuilderExtensions.cs

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.

Forces model building to always create a "__id" shadow property mapped to the JSON "id". This was the default behavior before EF Core 9.0.

public static Microsoft.EntityFrameworkCore.ModelBuilder HasShadowIds(this Microsoft.EntityFrameworkCore.ModelBuilder modelBuilder, bool? alwaysCreate = True);
static member HasShadowIds : Microsoft.EntityFrameworkCore.ModelBuilder * Nullable<bool> -> Microsoft.EntityFrameworkCore.ModelBuilder
<Extension()>
Public Function HasShadowIds (modelBuilder As ModelBuilder, Optional alwaysCreate As Nullable(Of Boolean) = True) As ModelBuilder

Parameters

modelBuilder
ModelBuilder

The model builder.

alwaysCreate
Nullable<Boolean>

true to force __id creation, false to not force __id creation, null to revert to the default setting.

Returns

Remarks

See Modeling entity types and relationships, and Accessing Azure Cosmos DB with EF Core for more information and examples.

Applies to

Feedback

Was this page helpful?