SearchIndexingBufferedSender class

Paquete:

@azure/search-documents

Clase que se usa para realizar operaciones almacenadas en búfer en un índice de búsqueda, incluida la adición, actualización y eliminación de ellos.

Constructores

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

Crea una nueva instancia de SearchIndexingBufferedSender.

Métodos

deleteDocuments(TModel[], OperationOptions)	Elimina los documentos o agrega los documentos a la cola de eliminación.
dispose()	Si usa autoFlush: true, llame a esto para limpiar el temporizador de autoflush.
flush(OperationOptions)	Vacía la cola manualmente.
mergeDocuments(TModel[], OperationOptions)	Combina los documentos o agrega los documentos a la cola de mezcla.
mergeOrUploadDocuments(TModel[], OperationOptions)	Combina o carga los documentos/Agrega los documentos a la cola de mezcla y carga.
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Evento de desasociación de Batch Agregado
off("batchFailed", (e: RestError) => void)	Evento de error de desasociación de Batch
off("batchSucceeded", (e: IndexDocumentsResult) => void)	Evento Desasociación correcta de Batch
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Evento de desasociación de Batch Sent
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Adjuntar evento agregado de Batch
on("batchFailed", (e: RestError) => void)	Evento de error de attach Batch
on("batchSucceeded", (e: IndexDocumentsResult) => void)	Evento Attach Batch Succeeded
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Adjuntar evento enviado por lotes
uploadDocuments(TModel[], OperationOptions)	Carga los documentos o agrega los documentos a la cola de carga.

Detalles del constructor

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

Crea una nueva instancia de SearchIndexingBufferedSender.

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

Parámetros

client

IndexDocumentsClient<TModel>

Cliente de búsqueda usado para llamar a las operaciones de IndexBatch subyacentes.

documentKeyRetriever

(document: TModel) => string

options

SearchIndexingBufferedSenderOptions

Opciones para modificar el vaciado automático.

Detalles del método

deleteDocuments(TModel[], OperationOptions)

Elimina los documentos o agrega los documentos a la cola de eliminación.

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

Parámetros

documents

TModel[]

Documentos que se van a eliminar.

options

OperationOptions

Opciones de carga.

Devoluciones

Promise<void>

dispose()

Si usa autoFlush: true, llame a esto para limpiar el temporizador de autoflush.

function dispose(): Promise<void>

Devoluciones

Promise<void>

flush(OperationOptions)

Vacía la cola manualmente.

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

Parámetros

options

OperationOptions

Opciones de vaciado.

Devoluciones

Promise<void>

mergeDocuments(TModel[], OperationOptions)

Combina los documentos o agrega los documentos a la cola de mezcla.

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

Parámetros

documents

TModel[]

Documentos que se van a combinar.

options

OperationOptions

Opciones de carga.

Devoluciones

Promise<void>

mergeOrUploadDocuments(TModel[], OperationOptions)

Combina o carga los documentos/Agrega los documentos a la cola de mezcla y carga.

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

Parámetros

documents

TModel[]

Documentos que se van a combinar o cargar.

options

OperationOptions

Opciones de carga.

Devoluciones

Promise<void>

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

Evento de desasociación de Batch Agregado

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

Parámetros

event

"batchAdded"

Evento que se va a emitir

listener

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

Escucha de eventos

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

Evento de error de desasociación de Batch

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

Parámetros

event

"batchFailed"

Evento que se va a emitir

listener

(e: RestError) => void

Escucha de eventos

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

Evento Desasociación correcta de Batch

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

Parámetros

event

"batchSucceeded"

Evento que se va a emitir

listener

(e: IndexDocumentsResult) => void

Escucha de eventos

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

Evento de desasociación de Batch Sent

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

Parámetros

event

"beforeDocumentSent"

Evento que se va a emitir

listener

(e: IndexDocumentsAction<TModel>) => void

Escucha de eventos

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

Adjuntar evento agregado de Batch

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

Parámetros

event

"batchAdded"

Evento que se va a emitir

listener

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

Escucha de eventos

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

Evento de error de attach Batch

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

Parámetros

event

"batchFailed"

Evento que se va a emitir

listener

(e: RestError) => void

Escucha de eventos

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

Evento Attach Batch Succeeded

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

Parámetros

event

"batchSucceeded"

Evento que se va a emitir

listener

(e: IndexDocumentsResult) => void

Escucha de eventos

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

Adjuntar evento enviado por lotes

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

Parámetros

event

"beforeDocumentSent"

Evento que se va a emitir

listener

(e: IndexDocumentsAction<TModel>) => void

Escucha de eventos

uploadDocuments(TModel[], OperationOptions)

Carga los documentos o agrega los documentos a la cola de carga.

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

Parámetros

documents

TModel[]

Documentos que se van a cargar.

options

OperationOptions

Opciones de carga.

Devoluciones

Promise<void>