SearchIndexingBufferedSender class

Csomag:

@azure/search-documents

A keresési indexek pufferelt műveleteinek végrehajtására használt osztály, beleértve a hozzáadásukat, frissítésüket és eltávolítását.

Konstruktorok

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

Létrehozza a SearchIndexingBufferedSender új példányát.

Metódusok

deleteDocuments(TModel[], OperationOptions)	Törli a dokumentumokat/Hozzáadja a dokumentumokat a törlési üzenetsorhoz.
dispose()	Ha az autoFlush: true értéket használja, hívja meg ezt az parancsot az autoflush időzítő törléséhez.
flush(OperationOptions)	Manuálisan üríti ki az üzenetsort.
mergeDocuments(TModel[], OperationOptions)	Egyesíti a dokumentumokat/felveszi a dokumentumokat az egyesítési várólistára.
mergeOrUploadDocuments(TModel[], OperationOptions)	Egyesíti/feltölti a dokumentumokat/hozzáadja a dokumentumokat az egyesítési/feltöltési üzenetsorhoz.
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Batch hozzáadott esemény leválasztása
off("batchFailed", (e: RestError) => void)	Sikertelen köteg leválasztása esemény
off("batchSucceeded", (e: IndexDocumentsResult) => void)	Sikeres kötegelt esemény leválasztása
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Elküldött kötegelt esemény leválasztása
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Batch hozzáadott esemény csatolása
on("batchFailed", (e: RestError) => void)	Sikertelen batch-esemény csatolása
on("batchSucceeded", (e: IndexDocumentsResult) => void)	Sikeres Batch-esemény csatolása
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Elküldött Batch-esemény csatolása
uploadDocuments(TModel[], OperationOptions)	Feltölti a dokumentumokat/hozzáadja a dokumentumokat a feltöltési üzenetsorhoz.

Konstruktor adatai

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

Létrehozza a SearchIndexingBufferedSender új példányát.

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

Paraméterek

client

IndexDocumentsClient<TModel>

A keresési ügyfél a mögöttes IndexBatch-műveletek meghívására szolgál.

documentKeyRetriever

(document: TModel) => string

options

SearchIndexingBufferedSenderOptions

Az automatikus kiürítés módosításának beállításai.

Metódus adatai

deleteDocuments(TModel[], OperationOptions)

Törli a dokumentumokat/Hozzáadja a dokumentumokat a törlési üzenetsorhoz.

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

Paraméterek

documents

TModel[]

A törölni kívánt dokumentumok.

options

OperationOptions

Feltöltési beállítások.

Válaszok

Promise<void>

dispose()

Ha az autoFlush: true értéket használja, hívja meg ezt az parancsot az autoflush időzítő törléséhez.

function dispose(): Promise<void>

Válaszok

Promise<void>

flush(OperationOptions)

Manuálisan üríti ki az üzenetsort.

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

Paraméterek

options

OperationOptions

Kiürítési beállítások.

Válaszok

Promise<void>

mergeDocuments(TModel[], OperationOptions)

Egyesíti a dokumentumokat/felveszi a dokumentumokat az egyesítési várólistára.

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

Paraméterek

documents

TModel[]

Az egyesítendő dokumentumok.

options

OperationOptions

Feltöltési beállítások.

Válaszok

Promise<void>

mergeOrUploadDocuments(TModel[], OperationOptions)

Egyesíti/feltölti a dokumentumokat/hozzáadja a dokumentumokat az egyesítési/feltöltési üzenetsorhoz.

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

Paraméterek

documents

TModel[]

Egyesítendő/feltöltendő dokumentumok.

options

OperationOptions

Feltöltési beállítások.

Válaszok

Promise<void>

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

Batch hozzáadott esemény leválasztása

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

Paraméterek

event

"batchAdded"

Kibocsátandó esemény

listener

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

Eseményfigyelő

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

Sikertelen köteg leválasztása esemény

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

Paraméterek

event

"batchFailed"

Kibocsátandó esemény

listener

(e: RestError) => void

Eseményfigyelő

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

Sikeres kötegelt esemény leválasztása

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

Paraméterek

event

"batchSucceeded"

Kibocsátandó esemény

listener

(e: IndexDocumentsResult) => void

Eseményfigyelő

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

Elküldött kötegelt esemény leválasztása

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

Paraméterek

event

"beforeDocumentSent"

Kibocsátandó esemény

listener

(e: IndexDocumentsAction<TModel>) => void

Eseményfigyelő

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

Batch hozzáadott esemény csatolása

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

Paraméterek

event

"batchAdded"

Kibocsátandó esemény

listener

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

Eseményfigyelő

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

Sikertelen batch-esemény csatolása

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

Paraméterek

event

"batchFailed"

Kibocsátandó esemény

listener

(e: RestError) => void

Eseményfigyelő

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

Sikeres Batch-esemény csatolása

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

Paraméterek

event

"batchSucceeded"

Kibocsátandó esemény

listener

(e: IndexDocumentsResult) => void

Eseményfigyelő

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

Elküldött Batch-esemény csatolása

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

Paraméterek

event

"beforeDocumentSent"

Kibocsátandó esemény

listener

(e: IndexDocumentsAction<TModel>) => void

Eseményfigyelő

uploadDocuments(TModel[], OperationOptions)

Feltölti a dokumentumokat/hozzáadja a dokumentumokat a feltöltési üzenetsorhoz.

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

Paraméterek

documents

TModel[]

Feltöltendő dokumentumok.

options

OperationOptions

Feltöltési beállítások.

Válaszok

Promise<void>