CosmosAutomaticIndexingBuilder Class

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly:

Microsoft.EntityFrameworkCore.Cosmos.dll

Package:

Microsoft.EntityFrameworkCore.Cosmos v11.0.0

Source:

CosmosAutomaticIndexingBuilder.cs

A fluent builder used to configure the Cosmos container's automatic indexing policy. Returned by HasAutomaticIndexing on EntityTypeBuilder; each call to Except(String) adds a path to the container's ExcludedPaths.

[System.Runtime.CompilerServices.Nullable(0)]
public class CosmosAutomaticIndexingBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionEntityTypeBuilder>

[<System.Runtime.CompilerServices.Nullable(0)>]
type CosmosAutomaticIndexingBuilder = class
    interface IInfrastructure<IConventionEntityTypeBuilder>

Public Class CosmosAutomaticIndexingBuilder
Implements IInfrastructure(Of IConventionEntityTypeBuilder)

Inheritance

Object

CosmosAutomaticIndexingBuilder

Derived

Microsoft.EntityFrameworkCore.Metadata.Builders.CosmosAutomaticIndexingBuilder<TEntity>

Attributes

NullableAttribute

Implements

IInfrastructure<IConventionEntityTypeBuilder>

Remarks

See Indexing policies in Azure Cosmos DB for more information.

Constructors

Name	Description
CosmosAutomaticIndexingBuilder(EntityTypeBuilder)	Creates a new CosmosAutomaticIndexingBuilder. Typically obtained via HasAutomaticIndexing(EntityTypeBuilder, Boolean) rather than constructed directly.

Properties

Name	Description
EntityTypeBuilder	The entity type builder used to back this automatic-indexing configuration.

Methods

Name	Description
Except(String)	Adds a path to the container's ExcludedPaths. The path must use Cosmos indexing-policy syntax (e.g., /secret/? for a leaf, /items/[]/* for an array sub-tree). Throws if automatic indexing was disabled via HasAutomaticIndexing(false).

Explicit Interface Implementations

Name	Description
IInfrastructure<IConventionEntityTypeBuilder>.Instance	Gets the value of the property being hidden.

Extension Methods

Name	Description
GetInfrastructure<T>(IInfrastructure<T>)	Gets the value from a property that is being hidden using IInfrastructure<T>. This method is typically used by database providers (and other extensions). It is generally not used in application code.