SearchIndexingBufferedSender class

Paket:

@azure/search-documents

Klasse, die zum Ausführen von gepufferten Vorgängen für einen Suchindex verwendet wird, einschließlich Hinzufügen, Aktualisieren und Entfernen dieser Vorgänge.

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 AutoFlush: true verwendet wird, rufen Sie dies auf, um den AutoFlush-Timer zu bereinigen.
flush(OperationOptions)	Löscht die Warteschlange manuell.
mergeDocuments(TModel[], OperationOptions)	Führt die Dokumente zusammen/Fügt die Dokumente zur Seriendruckwarteschlange hinzu.
mergeOrUploadDocuments(TModel[], OperationOptions)	Führt die Dokumente zusammen/lädt die Dokumente hoch/fügt die Dokumente der Seriendruck-/Uploadwarteschlange hinzu.
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Batch hinzugefügtes Ereignis trennen
off("batchFailed", (e: RestError) => void)	Batchfehlerereignis trennen
off("batchSucceeded", (e: IndexDocumentsResult) => void)	Batch erfolgreich trennen-Ereignis
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Batch gesendetes Ereignis trennen
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Batch hinzugefügtes Ereignis anfügen
on("batchFailed", (e: RestError) => void)	Batchfehlerereignis anfügen
on("batchSucceeded", (e: IndexDocumentsResult) => void)	Batch erfolgreich anfügen-Ereignis
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Batch gesendetes Ereignis anfügen
uploadDocuments(TModel[], OperationOptions)	Lädt die Dokumente hoch/fügt die Dokumente in die Uploadwarteschlange ein.

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 AutoFlush: true verwendet wird, rufen Sie dies auf, um den AutoFlush-Timer zu bereinigen.

function dispose(): Promise<void>

Gibt zurück

Promise<void>

flush(OperationOptions)

Löscht 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 zur Seriendruckwarteschlange 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 Seriendruck-/Uploadwarteschlange 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)

Batch hinzugefügtes Ereignis trennen

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)

Batchfehlerereignis trennen

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)

Batch erfolgreich trennen-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)

Batch gesendetes Ereignis trennen

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)

Batch hinzugefügtes Ereignis 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)

Batchfehlerereignis 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)

Batch erfolgreich anfügen-Ereignis

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)

Batch gesendetes Ereignis anfügen

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 in die Uploadwarteschlange ein.

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

Parameter

documents

TModel[]

Dokumente, die hochgeladen werden sollen.

options

OperationOptions

Uploadoptionen.

Gibt zurück

Promise<void>