你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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)	Merges/Uploads the documents/Adds the documents to the merge/upload queue.
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	分离批处理添加的事件
off("batchFailed", (e: RestError) => void)	分离批处理失败事件
off("batchSucceeded", (e: IndexDocumentsResult) => void)	分离批处理成功事件
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	分离批处理发送的事件
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)

Merges/Uploads the documents/Adds the documents to the merge/upload queue.

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)

分离批处理成功事件

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

参数

event

"batchSucceeded"

要发出的事件

listener

(e: IndexDocumentsResult) => void

事件侦听器

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

分离批处理发送的事件

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>