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)	Событие "Отсоединение пакета выполнено"
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)

Объединяет/отправляет документы/добавляет документы в очередь слияния или отправки.

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>