IndexBatch.Merge<T>(IEnumerable<T>) Method

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Data.dll

Package:

Microsoft.Azure.Search.Data v10.1.0

Source:

IndexBatch.Customization.cs

Creates a new IndexBatch for merging documents into existing documents in the index.

public static Microsoft.Azure.Search.Models.IndexBatch<T> Merge<T> (System.Collections.Generic.IEnumerable<T> documents);

static member Merge : seq<'T> -> Microsoft.Azure.Search.Models.IndexBatch<'T>

Public Shared Function Merge(Of T) (documents As IEnumerable(Of T)) As IndexBatch(Of T)

Type Parameters

T

The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index.

Parameters

documents

IEnumerable<T>

The documents to merge; Set only the properties that you want to change.

Returns

IndexBatch<T>

A new IndexBatch.

Remarks

If type T contains non-nullable value-typed properties, these properties may not merge correctly. If you do not set such a property, it will automatically take its default value (for example, 0 for int or false for bool), which will override the value of the property currently stored in the index, even if this was not your intent. For this reason, it is strongly recommended that you always declare value-typed properties to be nullable in type T.

The above does not apply if you are using Document as type T.