SearchIndexingBufferedSender class

Pacote:

@azure/search-documents

Classe usada para executar operações em buffer em um índice de pesquisa, incluindo adição, atualização e remoção delas.

Construtores

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

Cria uma nova instância de SearchIndexingBufferedSender.

Métodos

deleteDocuments(TModel[], OperationOptions)	Exclui os documentos/Adiciona os documentos à fila de exclusão.
dispose()	Se estiver usando o autoFlush: true, chame isso para limpar o temporizador de descarga automática.
flush(OperationOptions)	Libera a fila manualmente.
mergeDocuments(TModel[], OperationOptions)	Mescla os documentos/Adiciona os documentos à fila de mesclagem.
mergeOrUploadDocuments(TModel[], OperationOptions)	Mescla/Carrega os documentos/Adiciona os documentos à fila de mesclagem/carregamento.
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Desanexar evento adicionado ao lote
off("batchFailed", (e: RestError) => void)	Evento de falha de desanexação de lote
off("batchSucceeded", (e: IndexDocumentsResult) => void)	Desanexar evento de lote bem-sucedido
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Desanexar evento enviado em lote
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Anexar evento de lote adicionado
on("batchFailed", (e: RestError) => void)	Evento de falha ao anexar lote
on("batchSucceeded", (e: IndexDocumentsResult) => void)	Anexar evento de lote bem-sucedido
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Anexar evento enviado em lote
uploadDocuments(TModel[], OperationOptions)	Carrega os documentos/Adiciona os documentos à fila de carregamento.

Detalhes do Construtor

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

Cria uma nova instância de SearchIndexingBufferedSender.

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

Parâmetros

client

IndexDocumentsClient<TModel>

Search Client usado para chamar as operações IndexBatch subjacentes.

documentKeyRetriever

(document: TModel) => string

options

SearchIndexingBufferedSenderOptions

Opções para modificar a descarga automática.

Detalhes de Método

deleteDocuments(TModel[], OperationOptions)

Exclui os documentos/Adiciona os documentos à fila de exclusão.

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

Parâmetros

documents

TModel[]

Documentos a eliminar.

options

OperationOptions

Opções de upload.

Devoluções

Promise<void>

dispose()

Se estiver usando o autoFlush: true, chame isso para limpar o temporizador de descarga automática.

function dispose(): Promise<void>

Devoluções

Promise<void>

flush(OperationOptions)

Libera a fila manualmente.

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

Parâmetros

options

OperationOptions

Opções de descarga.

Devoluções

Promise<void>

mergeDocuments(TModel[], OperationOptions)

Mescla os documentos/Adiciona os documentos à fila de mesclagem.

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

Parâmetros

documents

TModel[]

Documentos a fundir.

options

OperationOptions

Opções de upload.

Devoluções

Promise<void>

mergeOrUploadDocuments(TModel[], OperationOptions)

Mescla/Carrega os documentos/Adiciona os documentos à fila de mesclagem/carregamento.

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

Parâmetros

documents

TModel[]

Documentos a serem mesclados/carregados.

options

OperationOptions

Opções de upload.

Devoluções

Promise<void>

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

Desanexar evento adicionado ao lote

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

Parâmetros

event

"batchAdded"

Evento a emitir

listener

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

Ouvinte de eventos

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

Evento de falha de desanexação de lote

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

Parâmetros

event

"batchFailed"

Evento a emitir

listener

(e: RestError) => void

Ouvinte de eventos

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

Desanexar evento de lote bem-sucedido

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

Parâmetros

event

"batchSucceeded"

Evento a emitir

listener

(e: IndexDocumentsResult) => void

Ouvinte de eventos

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

Desanexar evento enviado em lote

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

Parâmetros

event

"beforeDocumentSent"

Evento a emitir

listener

(e: IndexDocumentsAction<TModel>) => void

Ouvinte de eventos

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

Anexar evento de lote adicionado

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

Parâmetros

event

"batchAdded"

Evento a emitir

listener

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

Ouvinte de eventos

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

Evento de falha ao anexar lote

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

Parâmetros

event

"batchFailed"

Evento a emitir

listener

(e: RestError) => void

Ouvinte de eventos

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

Anexar evento de lote bem-sucedido

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

Parâmetros

event

"batchSucceeded"

Evento a emitir

listener

(e: IndexDocumentsResult) => void

Ouvinte de eventos

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

Anexar evento enviado em lote

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

Parâmetros

event

"beforeDocumentSent"

Evento a emitir

listener

(e: IndexDocumentsAction<TModel>) => void

Ouvinte de eventos

uploadDocuments(TModel[], OperationOptions)

Carrega os documentos/Adiciona os documentos à fila de carregamento.

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

Parâmetros

documents

TModel[]

Documentos a carregar.

options

OperationOptions

Opções de upload.

Devoluções

Promise<void>