RavenDB.Client by Hibernating Rhinos

<PackageReference Include="RavenDB.Client" Version="6.0.102" />

.NET API 2,988,544 bytes

 AbstractIndexCreationTaskBase<TIndexDefinition>

public abstract class AbstractIndexCreationTaskBase<TIndexDefinition> : AbstractCommonApiForIndexes, IAbstractIndexCreationTask where TIndexDefinition : IndexDefinition
Base class for creating indexes
public ArchivedDataProcessingBehavior? ArchivedDataProcessingBehavior { get; set; }

Set whether archived, unarchived or all documents will be indexed

public List<string[]> CompoundFieldsStrings { get; set; }

Expert: List of compound fields that Corax can use to optimize certain queries

public DocumentConventions Conventions { get; set; }

Gets or sets the conventions that should be used when index definition is created.

public IndexDeploymentMode? DeploymentMode { get; set; }

public IndexLockMode? LockMode { get; set; }

public IndexPriority? Priority { get; set; }

index can have a priority that controls how much power of the indexing process it is allowed to consume. index priority can be forced by the user. There are four available values that you can set: Normal, Idle, Disabled, Abandoned

Default value: null means that the priority of the index is Normal.

public SearchEngineType? SearchEngineType { get; set; }

Set search engine for index.

Default value: null means that the configuration from the database will be used.

public IndexState? State { get; set; }

Index state

protected AbstractIndexCreationTaskBase()

protected void CompoundField(string firstField, string secondField)

protected object CreateField(string name, object value, CreateFieldOptions options)

Provide a way to dynamically index values with runtime known values

protected object CreateField(string name, object value, bool stored, bool analyzed)

Provide a way to dynamically index values with runtime known values

protected object CreateField(string name, object value)

Provide a way to dynamically index values with runtime known values

public abstract TIndexDefinition CreateIndexDefinition()

Creates the index definition.

public object CreateSpatialField(double? lat, double? lng)

Generates a spatial field in the index, generating a Point from the provided lat/lng coordinates

public object CreateSpatialField(string shapeWkt)

Generates a spatial field in the index, generating a Point from the provided lat/lng coordinates

public virtual void Execute(IDocumentStore store, DocumentConventions conventions = null, string database = null)

Executes the index creation against the specified document database using the specified conventions

public virtual Task ExecuteAsync(IDocumentStore store, DocumentConventions conventions = null, string database = null, CancellationToken token = default)

Executes the index creation against the specified document store.