SearchIndexingBufferedSender class

パッケージ:

@azure/search-documents

検索インデックスに対してバッファー処理を実行するために使用されるクラス (追加、更新、削除など)。

コンストラクター

SearchIndexingBufferedSender<TModel>(IndexDocumentsClient<TModel>, (document: TModel) => string, SearchIndexingBufferedSenderOptions)

SearchIndexingBufferedSender の新しいインスタンスを作成します。

メソッド

deleteDocuments(TModel[], OperationOptions)	ドキュメントを削除/削除キューにドキュメントを追加します。
dispose()	autoFlush: true を使用している場合は、これを呼び出して自動フラッシュ タイマーをクリーンアップします。
flush(OperationOptions)	キューを手動でフラッシュします。
mergeDocuments(TModel[], OperationOptions)	ドキュメントをマージ/マージ キューにドキュメントを追加します。
mergeOrUploadDocuments(TModel[], OperationOptions)	ドキュメントのマージ/アップロード/マージ/アップロード キューにドキュメントを追加します。
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	バッチ追加イベントのデタッチ
off("batchFailed", (e: RestError) => void)	バッチのデタッチに失敗したイベント
off("batchSucceeded", (e: IndexDocumentsResult) => void)	Batch Succeeded イベントのデタッチ
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Batch Sent イベントをデタッチする
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	バッチ追加イベントのアタッチ
on("batchFailed", (e: RestError) => void)	バッチのアタッチに失敗したイベント
on("batchSucceeded", (e: IndexDocumentsResult) => void)	バッチのアタッチ成功イベント
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	バッチ送信イベントのアタッチ
uploadDocuments(TModel[], OperationOptions)	ドキュメントをアップロードする/アップロード キューにドキュメントを追加します。

コンストラクターの詳細

SearchIndexingBufferedSender<TModel>(IndexDocumentsClient<TModel>, (document: TModel) => string, SearchIndexingBufferedSenderOptions)

SearchIndexingBufferedSender の新しいインスタンスを作成します。

new SearchIndexingBufferedSender(client: IndexDocumentsClient<TModel>, documentKeyRetriever: (document: TModel) => string, options?: SearchIndexingBufferedSenderOptions)

パラメーター

client

IndexDocumentsClient<TModel>

基になる IndexBatch 操作の呼び出しに使用される検索クライアント。

documentKeyRetriever

(document: TModel) => string

options

SearchIndexingBufferedSenderOptions

自動フラッシュを変更するオプション。

メソッドの詳細

deleteDocuments(TModel[], OperationOptions)

ドキュメントを削除/削除キューにドキュメントを追加します。

function deleteDocuments(documents: TModel[], options?: OperationOptions): Promise<void>

パラメーター

documents

TModel[]

削除するドキュメント。

options

OperationOptions

アップロード オプション。

戻り値

Promise<void>

dispose()

autoFlush: true を使用している場合は、これを呼び出して自動フラッシュ タイマーをクリーンアップします。

function dispose(): Promise<void>

戻り値

Promise<void>

flush(OperationOptions)

キューを手動でフラッシュします。

function flush(options?: OperationOptions): Promise<void>

パラメーター

options

OperationOptions

フラッシュ オプション。

戻り値

Promise<void>

mergeDocuments(TModel[], OperationOptions)

ドキュメントをマージ/マージ キューにドキュメントを追加します。

function mergeDocuments(documents: TModel[], options?: OperationOptions): Promise<void>

パラメーター

documents

TModel[]

結合するドキュメント。

options

OperationOptions

アップロード オプション。

戻り値

Promise<void>

mergeOrUploadDocuments(TModel[], OperationOptions)

ドキュメントのマージ/アップロード/マージ/アップロード キューにドキュメントを追加します。

function mergeOrUploadDocuments(documents: TModel[], options?: OperationOptions): Promise<void>

パラメーター

documents

TModel[]

差し込み/アップロードするドキュメント。

options

OperationOptions

アップロード オプション。

戻り値

Promise<void>

off("batchAdded", (e: { action: string, documents: TModel[] }) => void)

バッチ追加イベントのデタッチ

function off(event: "batchAdded", listener: (e: { action: string, documents: TModel[] }) => void)

パラメーター

event

"batchAdded"

生成されるイベント

listener

(e: { action: string, documents: TModel[] }) => void

イベント リスナー

off("batchFailed", (e: RestError) => void)

バッチのデタッチに失敗したイベント

function off(event: "batchFailed", listener: (e: RestError) => void)

パラメーター

event

"batchFailed"

生成されるイベント

listener

(e: RestError) => void

イベント リスナー

off("batchSucceeded", (e: IndexDocumentsResult) => void)

Batch Succeeded イベントのデタッチ

function off(event: "batchSucceeded", listener: (e: IndexDocumentsResult) => void)

パラメーター

event

"batchSucceeded"

生成されるイベント

listener

(e: IndexDocumentsResult) => void

イベント リスナー

off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)

Batch Sent イベントをデタッチする

function off(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<TModel>) => void)

パラメーター

event

"beforeDocumentSent"

生成されるイベント

listener

(e: IndexDocumentsAction<TModel>) => void

イベント リスナー

on("batchAdded", (e: { action: string, documents: TModel[] }) => void)

バッチ追加イベントのアタッチ

function on(event: "batchAdded", listener: (e: { action: string, documents: TModel[] }) => void)

パラメーター

event

"batchAdded"

生成されるイベント

listener

(e: { action: string, documents: TModel[] }) => void

イベント リスナー

on("batchFailed", (e: RestError) => void)

バッチのアタッチに失敗したイベント

function on(event: "batchFailed", listener: (e: RestError) => void)

パラメーター

event

"batchFailed"

生成されるイベント

listener

(e: RestError) => void

イベント リスナー

on("batchSucceeded", (e: IndexDocumentsResult) => void)

バッチのアタッチ成功イベント

function on(event: "batchSucceeded", listener: (e: IndexDocumentsResult) => void)

パラメーター

event

"batchSucceeded"

生成されるイベント

listener

(e: IndexDocumentsResult) => void

イベント リスナー

on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)

バッチ送信イベントのアタッチ

function on(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<TModel>) => void)

パラメーター

event

"beforeDocumentSent"

生成されるイベント

listener

(e: IndexDocumentsAction<TModel>) => void

イベント リスナー

uploadDocuments(TModel[], OperationOptions)

ドキュメントをアップロードする/アップロード キューにドキュメントを追加します。

function uploadDocuments(documents: TModel[], options?: OperationOptions): Promise<void>

パラメーター

documents

TModel[]

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

options

OperationOptions

アップロード オプション。

戻り値

Promise<void>