SearchIndexingBufferedSender class

Paquet:

@azure/search-documents

Classe utilisée pour effectuer des opérations mises en mémoire tampon sur un index de recherche, notamment l’ajout, la mise à jour et la suppression de celles-ci.

Constructeurs

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

Crée une instance de SearchIndexingBufferedSender.

Méthodes

deleteDocuments(TModel[], OperationOptions)	Supprime les documents/Ajoute les documents à la file d’attente de suppression.
dispose()	Si vous utilisez autoFlush : true, appelez-le pour nettoyer le minuteur autoflush.
flush(OperationOptions)	Vide la file d’attente manuellement.
mergeDocuments(TModel[], OperationOptions)	Fusionne les documents/ajoute les documents à la file d’attente de fusion.
mergeOrUploadDocuments(TModel[], OperationOptions)	Fusionne/charge les documents/Ajoute les documents à la file d’attente de fusion/chargement.
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Détacher l’événement Batch Added
off("batchFailed", (e: RestError) => void)	Détacher l’événement Batch Failed
off("batchSucceeded", (e: IndexDocumentsResult) => void)	Détacher l’événement Batch Succeeded
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Détacher l’événement Envoyé par lot
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Attacher l’événement Batch Added
on("batchFailed", (e: RestError) => void)	Échec de l’attachement d’un lot
on("batchSucceeded", (e: IndexDocumentsResult) => void)	Attacher un événement Batch Succeeded
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Attacher un événement Envoyé par lot
uploadDocuments(TModel[], OperationOptions)	Charge les documents/ajoute les documents à la file d’attente de chargement.

Détails du constructeur

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

Crée une instance de SearchIndexingBufferedSender.

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

Paramètres

client

IndexDocumentsClient<TModel>

Client de recherche utilisé pour appeler les opérations IndexBatch sous-jacentes.

documentKeyRetriever

(document: TModel) => string

options

SearchIndexingBufferedSenderOptions

Options de modification du vidage automatique.

Détails de la méthode

deleteDocuments(TModel[], OperationOptions)

Supprime les documents/Ajoute les documents à la file d’attente de suppression.

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

Paramètres

documents

TModel[]

Documents à supprimer.

options

OperationOptions

Options de chargement.

Retours

Promise<void>

dispose()

Si vous utilisez autoFlush : true, appelez-le pour nettoyer le minuteur autoflush.

function dispose(): Promise<void>

Retours

Promise<void>

flush(OperationOptions)

Vide la file d’attente manuellement.

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

Paramètres

options

OperationOptions

Options de vidage.

Retours

Promise<void>

mergeDocuments(TModel[], OperationOptions)

Fusionne les documents/ajoute les documents à la file d’attente de fusion.

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

Paramètres

documents

TModel[]

Documents à fusionner.

options

OperationOptions

Options de chargement.

Retours

Promise<void>

mergeOrUploadDocuments(TModel[], OperationOptions)

Fusionne/charge les documents/Ajoute les documents à la file d’attente de fusion/chargement.

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

Paramètres

documents

TModel[]

Documents à fusionner/charger.

options

OperationOptions

Options de chargement.

Retours

Promise<void>

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

Détacher l’événement Batch Added

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

Paramètres

event

"batchAdded"

Événement à émettre

listener

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

Écouteur d’événements

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

Détacher l’événement Batch Failed

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

Paramètres

event

"batchFailed"

Événement à émettre

listener

(e: RestError) => void

Écouteur d’événements

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

Détacher l’événement Batch Succeeded

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

Paramètres

event

"batchSucceeded"

Événement à émettre

listener

(e: IndexDocumentsResult) => void

Écouteur d’événements

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

Détacher l’événement Envoyé par lot

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

Paramètres

event

"beforeDocumentSent"

Événement à émettre

listener

(e: IndexDocumentsAction<TModel>) => void

Écouteur d’événements

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

Attacher l’événement Batch Added

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

Paramètres

event

"batchAdded"

Événement à émettre

listener

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

Écouteur d’événements

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

Échec de l’attachement d’un lot

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

Paramètres

event

"batchFailed"

Événement à émettre

listener

(e: RestError) => void

Écouteur d’événements

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

Attacher un événement Batch Succeeded

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

Paramètres

event

"batchSucceeded"

Événement à émettre

listener

(e: IndexDocumentsResult) => void

Écouteur d’événements

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

Attacher un événement Envoyé par lot

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

Paramètres

event

"beforeDocumentSent"

Événement à émettre

listener

(e: IndexDocumentsAction<TModel>) => void

Écouteur d’événements

uploadDocuments(TModel[], OperationOptions)

Charge les documents/ajoute les documents à la file d’attente de chargement.

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

Paramètres

documents

TModel[]

Documents à charger.

options

OperationOptions

Options de chargement.

Retours

Promise<void>