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 autoFlush: true, chame-o para limpar o temporizador de limpeza 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/upload.
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Desanexar evento adicionado em lote
off("batchFailed", (e: RestError) => void)	Desanexar evento com falha do lote
off("batchSucceeded", (e: IndexDocumentsResult) => void)	Desanexar evento bem-sucedido do lote
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Desanexar evento enviado em lote
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Anexar evento adicionado em lote
on("batchFailed", (e: RestError) => void)	Anexar evento com falha do lote
on("batchSucceeded", (e: IndexDocumentsResult) => void)	Anexar evento bem-sucedido do lote
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Anexar evento enviado em lote
uploadDocuments(TModel[], OperationOptions)	Carrega os documentos/Adiciona os documentos à fila de upload.

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>

Cliente de pesquisa usado para chamar as operações indexBatch subjacentes.

documentKeyRetriever

(document: TModel) => string

options

SearchIndexingBufferedSenderOptions

Opções para modificar a liberação automática.

Detalhes do 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 serem excluídos.

options

OperationOptions

Opções de upload.

Retornos

Promise<void>

dispose()

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

function dispose(): Promise<void>

Retornos

Promise<void>

flush(OperationOptions)

Libera a fila manualmente.

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

Parâmetros

options

OperationOptions

Opções de liberação.

Retornos

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 serem mesclados.

options

OperationOptions

Opções de upload.

Retornos

Promise<void>

mergeOrUploadDocuments(TModel[], OperationOptions)

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

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

Parâmetros

documents

TModel[]

Documentos a serem mesclados/carregados.

options

OperationOptions

Opções de upload.

Retornos

Promise<void>

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

Desanexar evento adicionado em lote

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

Parâmetros

event

"batchAdded"

Evento a ser emitido

listener

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

Ouvinte de Eventos

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

Desanexar evento com falha do lote

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

Parâmetros

event

"batchFailed"

Evento a ser emitido

listener

(e: RestError) => void

Ouvinte de Eventos

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

Desanexar evento bem-sucedido do lote

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

Parâmetros

event

"batchSucceeded"

Evento a ser emitido

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 ser emitido

listener

(e: IndexDocumentsAction<TModel>) => void

Ouvinte de Eventos

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

Anexar evento adicionado em lote

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

Parâmetros

event

"batchAdded"

Evento a ser emitido

listener

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

Ouvinte de Eventos

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

Anexar evento com falha do lote

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

Parâmetros

event

"batchFailed"

Evento a ser emitido

listener

(e: RestError) => void

Ouvinte de Eventos

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

Anexar evento bem-sucedido do lote

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

Parâmetros

event

"batchSucceeded"

Evento a ser emitido

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 ser emitido

listener

(e: IndexDocumentsAction<TModel>) => void

Ouvinte de Eventos

uploadDocuments(TModel[], OperationOptions)

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

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

Parâmetros

documents

TModel[]

Documentos a serem carregados.

options

OperationOptions

Opções de upload.

Retornos

Promise<void>