Class SearchFieldAttribute

Decorates a field that you want to index.

Inheritance

System.Object

System.Attribute

RedisFieldAttribute

SearchFieldAttribute

IndexedAttribute

SearchableAttribute

Inherited Members

RedisFieldAttribute.PropertyName

System.Attribute.Equals(System.Object)

System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Module)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.GetHashCode()

System.Attribute.IsDefaultAttribute()

System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)

System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)

System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.Module, System.Type)

System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)

System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.Match(System.Object)

System.Attribute.TypeId

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Redis.OM.Modeling

Assembly: Redis.OM.dll

Syntax

[AttributeUsage(AttributeTargets.Property, AllowMultiple = true)]
public abstract class SearchFieldAttribute : RedisFieldAttribute

Properties

Aggregatable

Gets or sets a value indicating whether the field will be aggregatable.

Declaration

public bool Aggregatable { get; set; }

Property Value

Type	Description
System.Boolean

CascadeDepth

Gets or sets the depth into the object graph to automatically generate the index.

Declaration

public int CascadeDepth { get; set; }

Property Value

Type	Description
System.Int32

JsonPath

Gets or sets the JSON path to the desired attribute to index. This is used for indexing individual fields within objects. Defaults to ".", which assumes the entire field will be indexed If the indexed field is a scalar, it will only index that field. If that index is an object the index will be recursively built based off the CascadeDepth.

Declaration

public string JsonPath { get; set; }

Property Value

Type	Description
System.String

Normalize

Gets or sets a value indicating whether text will be normalized when indexed (sent to lower case with no diacritics). Defaults to true.

Declaration

public bool Normalize { get; set; }

Property Value

Type	Description
System.Boolean

Sortable

Gets or sets a value indicating whether the field will be sortable.

Declaration

public bool Sortable { get; set; }

Property Value

Type	Description
System.Boolean