SearchIndexingBufferedSender class

Pacote:

@azure/search-documents

Classe utilizada para realizar operações em memória intermédia num índice de pesquisa, incluindo adicionar, atualizar e remover.

Construtores

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

Cria uma nova instância de SearchIndexingBufferedSender.

Métodos

deleteDocuments(TModel[], OperationOptions)	Elimina os documentos/Adiciona os documentos à fila de eliminação.
dispose()	Se utilizar autoFlush: true, chame-o para limpar o temporizador automático.
flush(OperationOptions)	Limpa a fila manualmente.
mergeDocuments(TModel[], OperationOptions)	Intercala os documentos/Adiciona os documentos à fila de impressão em série.
mergeOrUploadDocuments(TModel[], OperationOptions)	Intercala/Carrega os documentos/Adiciona os documentos à fila de intercalação/carregamento.
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Desanexar Evento Adicionado do Batch
off("batchFailed", (e: RestError) => void)	Desencaixar Evento Com Falha no Batch
off("batchSucceeded", (e: IndexDocumentsResult) => void)	Desanexar Evento com Êxito do Batch
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Desanexar Evento Enviado do Batch
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Anexar Evento Adicionado ao Batch
on("batchFailed", (e: RestError) => void)	Evento Com Falha de Anexação do Batch
on("batchSucceeded", (e: IndexDocumentsResult) => void)	Evento Anexar Batch Com Êxito
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Anexar Evento Enviado do Batch
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>

Cliente de Pesquisa utilizado para chamar as operações de IndexBatch subjacentes.

documentKeyRetriever

(document: TModel) => string

options

SearchIndexingBufferedSenderOptions

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

Detalhes de Método

deleteDocuments(TModel[], OperationOptions)

Elimina os documentos/Adiciona os documentos à fila de eliminação.

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

Parâmetros

documents

TModel[]

Documentos a eliminar.

options

OperationOptions

Opções de carregamento.

Devoluções

Promise<void>

dispose()

Se utilizar autoFlush: true, chame-o para limpar o temporizador automático.

function dispose(): Promise<void>

Devoluções

Promise<void>

flush(OperationOptions)

Limpa a fila manualmente.

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

Parâmetros

options

OperationOptions

Opções de descarga.

Devoluções

Promise<void>

mergeDocuments(TModel[], OperationOptions)

Intercala os documentos/Adiciona os documentos à fila de impressão em série.

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

Parâmetros

documents

TModel[]

Documentos a intercalar.

options

OperationOptions

Opções de carregamento.

Devoluções

Promise<void>

mergeOrUploadDocuments(TModel[], OperationOptions)

Intercala/Carrega os documentos/Adiciona os documentos à fila de intercalação/carregamento.

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

Parâmetros

documents

TModel[]

Documentos a intercalar/carregados.

options

OperationOptions

Opções de carregamento.

Devoluções

Promise<void>

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

Desanexar Evento Adicionado do Batch

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

Serviço de Escuta de Eventos

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

Desencaixar Evento Com Falha no Batch

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

Parâmetros

event

"batchFailed"

Evento a ser emitido

listener

(e: RestError) => void

Serviço de Escuta de Eventos

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

Desanexar Evento com Êxito do Batch

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

Parâmetros

event

"batchSucceeded"

Evento a ser emitido

listener

(e: IndexDocumentsResult) => void

Serviço de Escuta de Eventos

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

Desanexar Evento Enviado do Batch

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

Parâmetros

event

"beforeDocumentSent"

Evento a ser emitido

listener

(e: IndexDocumentsAction<TModel>) => void

Serviço de Escuta de Eventos

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

Anexar Evento Adicionado ao Batch

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

Serviço de Escuta de Eventos

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

Evento Com Falha de Anexação do Batch

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

Parâmetros

event

"batchFailed"

Evento a ser emitido

listener

(e: RestError) => void

Serviço de Escuta de Eventos

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

Evento Anexar Batch Com Êxito

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

Parâmetros

event

"batchSucceeded"

Evento a ser emitido

listener

(e: IndexDocumentsResult) => void

Serviço de Escuta de Eventos

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

Anexar Evento Enviado do Batch

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

Parâmetros

event

"beforeDocumentSent"

Evento a ser emitido

listener

(e: IndexDocumentsAction<TModel>) => void

Serviço de Escuta 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 carregamento.

Devoluções

Promise<void>