Skip to main content

Glossary: IndexDefinition

Properties

NameTypeDescription
IndexIdintThe id of this index
NamestringThis is the means by which the outside world refers to this index defiintion
LockModeIndexLockModeThe index lock mode
MapstringThe map function, if there is only one
MapsHashSet<string>All the map functions for this index
ReducestringThe reduce function
IsMapReduceboolGets a value indicating whether this instance is map reduce index definition
IsCompiledboolWhether this instance is compiled
StoresIDictionary<string, FieldStorage>The stores options
IndexesIDictionary<string, FieldIndexing>The indexing options
SortOptionsIDictionary<string, SortOptions>The sort options
AnalyzersIDictionary<string, string>The analyzers options
FieldsIList<string>The fields that are queryable in the index
SuggestionsIDictionary<string, SuggestionOptions>The suggest options
TermVectorsIDictionary<string, FieldTermVector>The term vectors options
SpatialIndexesIDictionary<string, SpatialOptions>The spatial options
MaxIndexOutputsPerDocumentint?Index specific setting that limits the number of map outputs that an index is allowed to create for a one source document. If a map operation applied to the one document produces more outputs than this number then an index definition will be considered as a suspicious and the index will be marked as errored. Default value: null means that the global value from Raven configuration will be taken to detect if number of outputs was exceeded.
TypestringIndex type: Auto, Compiled or MapReduce
DisableInMemoryIndexingboolPrevent index from being kept in memory. Default: false