CosmosAutomaticIndexingBuilder<TEntity> Class

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly:

Microsoft.EntityFrameworkCore.Cosmos.dll

Package:

Microsoft.EntityFrameworkCore.Cosmos v11.0.0

Source:

CosmosAutomaticIndexingBuilder.cs

A generic fluent builder used to configure the Cosmos container's automatic indexing policy. Returned by HasAutomaticIndexing on EntityTypeBuilder<TEntity>.

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

[<System.Runtime.CompilerServices.Nullable(0)>]
type CosmosAutomaticIndexingBuilder<'Entity (requires 'Entity : null)> = class
    inherit CosmosAutomaticIndexingBuilder

Public Class CosmosAutomaticIndexingBuilder(Of TEntity)
Inherits CosmosAutomaticIndexingBuilder

Type Parameters

TEntity

The entity type being configured.

Inheritance

Object

CosmosAutomaticIndexingBuilder

CosmosAutomaticIndexingBuilder<TEntity>

Attributes

NullableAttribute

Constructors

Name	Description
CosmosAutomaticIndexingBuilder<TEntity>(EntityTypeBuilder<TEntity>)	Creates a new CosmosAutomaticIndexingBuilder<TEntity>.

Properties

Name	Description
EntityTypeBuilder	The entity type builder used to back this automatic-indexing configuration. (Inherited from CosmosAutomaticIndexingBuilder)

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. (Inherited from CosmosAutomaticIndexingBuilder)

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.