SearchIndexingBufferedSender class

套件:

@azure/search-documents

用來對搜尋索引執行緩衝作業的類別，包括新增、更新和移除它們。

建構函式

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

建立 SearchIndexingBufferedSender 的新實例。

方法

deleteDocuments(TModel[], OperationOptions)	刪除檔/將檔新增至刪除佇列。
dispose()	如果使用 autoFlush：true，請呼叫這個 來清除 autoflush 計時器。
flush(OperationOptions)	手動排清佇列。
mergeDocuments(TModel[], OperationOptions)	合併檔/將檔新增至合併佇列。
mergeOrUploadDocuments(TModel[], OperationOptions)	合併/上傳檔/將檔新增至合併/上傳佇列。
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	卸離 Batch 已新增事件
off("batchFailed", (e: RestError) => void)	中斷連結批次失敗事件
off("batchSucceeded", (e: IndexDocumentsResult) => void)	中斷連結 Batch 成功事件
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	卸離 Batch Sent 事件
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	附加 Batch 新增事件
on("batchFailed", (e: RestError) => void)	附加批次失敗事件
on("batchSucceeded", (e: IndexDocumentsResult) => void)	附加 Batch 成功事件
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	附加 Batch Sent 事件
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，請呼叫這個 來清除 autoflush 計時器。

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)

卸離 Batch 已新增事件

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 成功事件

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)

附加 Batch 新增事件

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)

附加 Batch 成功事件

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

參數

event

"batchSucceeded"

要發出的事件

listener

(e: IndexDocumentsResult) => void

事件接聽程式

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

附加 Batch Sent 事件

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>