# C1.LiveLinq.Indexing.IndexingAlgorithm.CreateIndex ## Content

CreateIndex Method

CreateIndex<T, TKey>(IObservableSource<T>, Expression<Func<T, TKey>>, bool, CultureInfo)

Creates a new index.

Declaration
public Index<T, TKey> CreateIndex<T, TKey>(IObservableSource<T> source, Expression<Func<T, TKey>> keySelector, bool keyIsUnique, CultureInfo locale)
Public Function CreateIndex(Of T, TKey)(source As IObservableSource(Of T), keySelector As Expression(Of Func(Of T, TKey)), keyIsUnique As Boolean, locale As CultureInfo) As Index(Of T, TKey)
Parameters
Type Name Description
IObservableSource<T> source

The collection to be indexed.
Expression<Func<T, TKey>> keySelector

Key selector expression of the index, see KeySelector.
bool keyIsUnique

Specifies whether the key used in this index is a unique key for the indexed collection.
CultureInfo locale

Locale information used to compare strings in the index (default: CultureInfo.CurrentCulture).
Returns
Type Description
Index<T, TKey>

The new index.
Type Parameters
Name Description
T

The type of the elements of the collection to index.
TKey

The type of the index key.
Remarks

Normally, you don't need to use this method. Indexes are usually created in code by calling IndexCollection.Add, or their creation can be enforced in LINQ queries by using the Indexed hint. This method should be used only in special situations where all you want is to index a collection without an overhead of maintaining a collection of indexes, or you need an index that exists separately from the collection of indexes maintained by the source. Unlike the standard ways of creating indexes, this method only creates an index object and attaches it to the source (so it will be automatically synchronized with the source when the source is modified), but the created index is not added to IndexCollection<T>.

A unique index occupies less memory and performs better than a non-unique index (although the difference isn't dramatic). Therefore, for unique keys, it's recommended to specify the corresponding index as unique. But do that only if you are sure that the key is indeed unique, as it imposes a uniqueness constraint on the indexed collection. An attempt to modify the indexed collection violating the uniqueness throws an InvalidOperationException.