DslIndexDefinition Class

The index definition contains a set of properties that controls the creation of the index.

Definition

Namespace: Casewhere.Runtime.DSL
Assembly: Casewhere.Runtime (in Casewhere.Runtime.dll) Version: 2.9.8.6
C#
[SerializableAttribute]
public class DslIndexDefinition
Inheritance
Object    DslIndexDefinition

Constructors

DslIndexDefinition Initializes a new instance of the DslIndexDefinition class

Properties

Background Optional. If specified, the index will be created in a background.
ExpireAfter Optional. Specifies a value, in seconds via TimeSpan, as a time to live (TTL) to control how long data source retains data objects in data source. This property only applies to TTL indexes.
Keys The list of index key definition (Attributes Name and Index type).
Name The name of the index.
PartialFilterExpression Optional. If specified, the index only references data objects that match the filter expression. A filter expression can include: $eq, $exists: true, $gt, $gte, $lt, $lte, $type, $and, $or, $in.
Unique Optional. Creates a unique index so that the data source will not accept insertion or update of data object where the index key value matches an existing value in the index.
WildcardProjection Optional. If specified, Wildcard indexes will include/exclude fileds in this option. A wildcard projection is a Json object: {includeFieldName:1,excludeFieldName:0}

See Also