IndexDocumentsBatch class

パッケージ:

@azure/search-documents

インデックスに対して複数のドキュメントを含むバッチ操作を実行するために使用されるクラス。

コンストラクター

IndexDocumentsBatch<TModel>(IndexDocumentsAction<TModel>[])

プロパティ

actions

このバッチで実行されるアクションのセット。

メソッド

delete(keyof TModel, string[])	一連のドキュメントを削除します。
delete(TModel[])	一連のドキュメントを削除します。
merge(TModel[])	インデックス内の一連のドキュメントを更新します。 マージのしくみの詳細については、次を参照してください。 https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeOrUpload(TModel[])	インデックス内の一連のドキュメントを更新するか、存在しない場合はアップロードします。 マージのしくみの詳細については、次を参照してください。 https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
upload(TModel[])	ドキュメントの配列をインデックスにアップロードします。

コンストラクターの詳細

IndexDocumentsBatch<TModel>(IndexDocumentsAction<TModel>[])

new IndexDocumentsBatch(actions?: IndexDocumentsAction<TModel>[])

パラメーター

actions

IndexDocumentsAction<TModel>[]

プロパティの詳細

actions

このバッチで実行されるアクションのセット。

actions: IndexDocumentsAction<TModel>[]

プロパティ値

IndexDocumentsAction<TModel>[]

メソッドの詳細

delete(keyof TModel, string[])

一連のドキュメントを削除します。

function delete(keyName: keyof TModel, keyValues: string[])

パラメーター

keyName

keyof TModel

インデックス内の主キーの名前。

keyValues

string[]

削除するドキュメントの主キー値。

delete(TModel[])

一連のドキュメントを削除します。

function delete(documents: TModel[])

パラメーター

documents

TModel[]

削除するドキュメント。

merge(TModel[])

インデックス内の一連のドキュメントを更新します。 マージのしくみの詳細については、次を参照してください。 https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function merge(documents: TModel[])

パラメーター

documents

TModel[]

更新されたドキュメント。

mergeOrUpload(TModel[])

インデックス内の一連のドキュメントを更新するか、存在しない場合はアップロードします。 マージのしくみの詳細については、次を参照してください。 https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function mergeOrUpload(documents: TModel[])

パラメーター

documents

TModel[]

新規/更新されたドキュメント。

upload(TModel[])

ドキュメントの配列をインデックスにアップロードします。

function upload(documents: TModel[])

パラメーター

documents

TModel[]

アップロードするドキュメント。