SearchIndexingBufferedSender class

Paket:

@azure/search-documents

Klasse, die verwendet wird, um gepufferte Vorgänge für einen Suchindex auszuführen, einschließlich hinzufügen, aktualisieren und entfernen.

Konstruktoren

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

Erstellt eine neue Instanz von SearchIndexingBufferedSender.

Methoden

deleteDocuments(TModel[], OperationOptions)	Löscht die Dokumente/Fügt die Dokumente der Löschwarteschlange hinzu.
dispose()	Wenn Sie autoFlush: true verwenden, rufen Sie dies auf, um den Autoflush-Timer zu bereinigen.
flush(OperationOptions)	Leert die Warteschlange manuell.
mergeDocuments(TModel[], OperationOptions)	Führt die Dokumente zusammen/Fügt die Dokumente der Mergewarteschlange hinzu.
mergeOrUploadDocuments(TModel[], OperationOptions)	Führt die Dokumente zusammen/lädt die Dokumente hoch/fügt die Dokumente der Merge-/Upload-Warteschlange hinzu.
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Detach Batch Added-Ereignis
off("batchFailed", (e: RestError) => void)	Detach Batch Failed-Ereignis
off("batchSucceeded", (e: IndexDocumentsResult) => void)	Detach Batch Succeeded-Ereignis
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Detach Batch Sent-Ereignis
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Ereignis "Batch hinzugefügt" anfügen
on("batchFailed", (e: RestError) => void)	Ereignis "Batchfehler anfügen"
on("batchSucceeded", (e: IndexDocumentsResult) => void)	Ereignis "Batch erfolgreich anfügen"
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Anfügen eines gesendeten Batchereignisses
uploadDocuments(TModel[], OperationOptions)	Lädt die Dokumente hoch/fügt die Dokumente der Uploadwarteschlange hinzu.

Details zum Konstruktor

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

Erstellt eine neue Instanz von SearchIndexingBufferedSender.

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

Parameter

client

IndexDocumentsClient<TModel>

Suchclient, der zum Aufrufen der zugrunde liegenden IndexBatch-Vorgänge verwendet wird.

documentKeyRetriever

(document: TModel) => string

options

SearchIndexingBufferedSenderOptions

Optionen zum Ändern der automatischen Leerung.

Details zur Methode

deleteDocuments(TModel[], OperationOptions)

Löscht die Dokumente/Fügt die Dokumente der Löschwarteschlange hinzu.

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

Parameter

documents

TModel[]

Zu löschende Dokumente.

options

OperationOptions

Uploadoptionen.

Gibt zurück

Promise<void>

dispose()

Wenn Sie autoFlush: true verwenden, rufen Sie dies auf, um den Autoflush-Timer zu bereinigen.

function dispose(): Promise<void>

Gibt zurück

Promise<void>

flush(OperationOptions)

Leert die Warteschlange manuell.

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

Parameter

options

OperationOptions

Leerungsoptionen.

Gibt zurück

Promise<void>

mergeDocuments(TModel[], OperationOptions)

Führt die Dokumente zusammen/Fügt die Dokumente der Mergewarteschlange hinzu.

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

Parameter

documents

TModel[]

Dokumente, die zusammengeführt werden sollen.

options

OperationOptions

Uploadoptionen.

Gibt zurück

Promise<void>

mergeOrUploadDocuments(TModel[], OperationOptions)

Führt die Dokumente zusammen/lädt die Dokumente hoch/fügt die Dokumente der Merge-/Upload-Warteschlange hinzu.

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

Parameter

documents

TModel[]

Dokumente, die zusammengeführt/hochgeladen werden sollen.

options

OperationOptions

Uploadoptionen.

Gibt zurück

Promise<void>

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

Detach Batch Added-Ereignis

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

Parameter

event

"batchAdded"

Ereignis, das ausgegeben werden soll

listener

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

Ereignislistener

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

Detach Batch Failed-Ereignis

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

Parameter

event

"batchFailed"

Ereignis, das ausgegeben werden soll

listener

(e: RestError) => void

Ereignislistener

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

Detach Batch Succeeded-Ereignis

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

Parameter

event

"batchSucceeded"

Ereignis, das ausgegeben werden soll

listener

(e: IndexDocumentsResult) => void

Ereignislistener

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

Detach Batch Sent-Ereignis

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

Parameter

event

"beforeDocumentSent"

Ereignis, das ausgegeben werden soll

listener

(e: IndexDocumentsAction<TModel>) => void

Ereignislistener

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

Ereignis "Batch hinzugefügt" anfügen

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

Parameter

event

"batchAdded"

Ereignis, das ausgegeben werden soll

listener

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

Ereignislistener

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

Ereignis "Batchfehler anfügen"

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

Parameter

event

"batchFailed"

Ereignis, das ausgegeben werden soll

listener

(e: RestError) => void

Ereignislistener

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

Ereignis "Batch erfolgreich anfügen"

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

Parameter

event

"batchSucceeded"

Ereignis, das ausgegeben werden soll

listener

(e: IndexDocumentsResult) => void

Ereignislistener

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

Anfügen eines gesendeten Batchereignisses

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

Parameter

event

"beforeDocumentSent"

Ereignis, das ausgegeben werden soll

listener

(e: IndexDocumentsAction<TModel>) => void

Ereignislistener

uploadDocuments(TModel[], OperationOptions)

Lädt die Dokumente hoch/fügt die Dokumente der Uploadwarteschlange hinzu.

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

Parameter

documents

TModel[]

Dokumente, die hochgeladen werden sollen.

options

OperationOptions

Uploadoptionen.

Gibt zurück

Promise<void>