SearchIndexingBufferedSender class

Paquet:

@azure/search-documents

Classe utilisée pour effectuer des opérations mises en mémoire tampon sur un index de recherche, y compris leur ajout, leur mise à jour et leur suppression.

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 ceci pour nettoyer le minuteur de gonflage automatique.
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)	Événement Detach 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 Réussi
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Detach Batch Sent Event
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Attacher l’événement Batch Added
on("batchFailed", (e: RestError) => void)	Événement d’échec du lot d’attachement
on("batchSucceeded", (e: IndexDocumentsResult) => void)	Événement Attacher un lot réussi
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>

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

documentKeyRetriever

(document: TModel) => string

options

SearchIndexingBufferedSenderOptions

Options permettant de modifier le 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 ceci pour nettoyer le minuteur de gonflage automatique.

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)

Événement Detach 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 Réussi

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)

Detach Batch Sent Event

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)

Événement d’échec du lot d’attachement

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)

Événement Attacher un lot réussi

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>