Class DocumentAttribute

An attribute to use to decorate class level objects you wish to store in redis.

Inheritance

System.Object

System.Attribute

DocumentAttribute

Inherited Members

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.Class)]
public class DocumentAttribute : Attribute

Properties

Filter

Gets or sets the filter to use for indexing documents.

Declaration

public string Filter { get; set; }

Property Value

Type	Description
System.String

IdGenerationStrategyName

Gets or sets the IdGenerationStrategy, will use a ULID by default.

Declaration

public string IdGenerationStrategyName { get; set; }

Property Value

Type	Description
System.String

IndexName

Gets or sets the name of the index, will default to className-idx.

Declaration

public string IndexName { get; set; }

Property Value

Type	Description
System.String

Language

Gets or sets The language the documents are stored in.

Declaration

public string Language { get; set; }

Property Value

Type	Description
System.String

LanguageField

Gets or sets the field in the document to check for the language in.

Declaration

public string LanguageField { get; set; }

Property Value

Type	Description
System.String

Prefixes

Gets or sets the prefixes to use for the Documents.

Declaration

public string[] Prefixes { get; set; }

Property Value

Type	Description
System.String[]

StorageType

Gets or sets the storage type.

Declaration

public StorageType StorageType { get; set; }

Property Value

Type	Description
StorageType

Methods

RegisterIdGenerationStrategy(String, IIdGenerationStrategy)

Registers an Id generation Strategy with the Object Mapper.

Declaration

public static void RegisterIdGenerationStrategy(string strategyName, IIdGenerationStrategy strategy)

Parameters

Type	Name	Description
System.String	strategyName	The name of the strategy, which you will reference when declaring a Document.
IIdGenerationStrategy	strategy	An instance of the Strategy class to be used by all documents to generate an id.