SearchIndexingBufferedSender class

Balíček:

@azure/search-documents

Třída používaná k provádění operací uložených ve vyrovnávací paměti vůči indexu vyhledávání, včetně přidávání, aktualizace a odebírání.

Konstruktory

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

Vytvoří novou instanci SearchIndexingBufferedSender.

Metody

deleteDocuments(TModel[], OperationOptions)	Odstraní dokumenty nebo přidá dokumenty do fronty pro odstranění.
dispose()	Pokud používáte autoFlush: true, zavolejte to pro vyčištění časovače autoflush.
flush(OperationOptions)	Vyprázdní frontu ručně.
mergeDocuments(TModel[], OperationOptions)	Sloučí dokumenty nebo přidá dokumenty do fronty hromadné korespondence.
mergeOrUploadDocuments(TModel[], OperationOptions)	Sloučí nebo nahraje dokumenty nebo přidá dokumenty do fronty pro sloučení a nahrání.
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Odpojení události přidání dávky
off("batchFailed", (e: RestError) => void)	Odpojení události selhání dávky
off("batchSucceeded", (e: IndexDocumentsResult) => void)	Odpojení úspěšné události batch
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Odpojení události odesílané dávky
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Připojit událost přidání dávky
on("batchFailed", (e: RestError) => void)	Připojení události Selhání služby Batch
on("batchSucceeded", (e: IndexDocumentsResult) => void)	Událost připojení dávky byla úspěšná
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Připojení události odeslání dávky
uploadDocuments(TModel[], OperationOptions)	Nahraje dokumenty nebo přidá dokumenty do fronty pro nahrání.

Podrobnosti konstruktoru

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

Vytvoří novou instanci SearchIndexingBufferedSender.

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

Parametry

client

IndexDocumentsClient<TModel>

Vyhledávací klient, který se používá k volání základních operací IndexBatch.

documentKeyRetriever

(document: TModel) => string

options

SearchIndexingBufferedSenderOptions

Možnosti pro úpravu automatického vyprázdnění

Podrobnosti metody

deleteDocuments(TModel[], OperationOptions)

Odstraní dokumenty nebo přidá dokumenty do fronty pro odstranění.

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

Parametry

documents

TModel[]

Dokumenty, které se mají odstranit.

options

OperationOptions

Možnosti nahrávání

Návraty

Promise<void>

dispose()

Pokud používáte autoFlush: true, zavolejte to pro vyčištění časovače autoflush.

function dispose(): Promise<void>

Návraty

Promise<void>

flush(OperationOptions)

Vyprázdní frontu ručně.

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

Parametry

options

OperationOptions

Možnosti vyprázdnění

Návraty

Promise<void>

mergeDocuments(TModel[], OperationOptions)

Sloučí dokumenty nebo přidá dokumenty do fronty hromadné korespondence.

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

Parametry

documents

TModel[]

Dokumenty, které se mají sloučit.

options

OperationOptions

Možnosti nahrávání

Návraty

Promise<void>

mergeOrUploadDocuments(TModel[], OperationOptions)

Sloučí nebo nahraje dokumenty nebo přidá dokumenty do fronty pro sloučení a nahrání.

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

Parametry

documents

TModel[]

Dokumenty, které se mají sloučit nebo nahrát

options

OperationOptions

Možnosti nahrávání

Návraty

Promise<void>

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

Odpojení události přidání dávky

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

Parametry

event

"batchAdded"

Událost, která se má generovat

listener

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

Naslouchací proces událostí

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

Odpojení události selhání dávky

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

Parametry

event

"batchFailed"

Událost, která se má generovat

listener

(e: RestError) => void

Naslouchací proces událostí

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

Odpojení úspěšné události batch

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

Parametry

event

"batchSucceeded"

Událost, která se má generovat

listener

(e: IndexDocumentsResult) => void

Naslouchací proces událostí

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

Odpojení události odesílané dávky

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

Parametry

event

"beforeDocumentSent"

Událost, která se má generovat

listener

(e: IndexDocumentsAction<TModel>) => void

Naslouchací proces událostí

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

Připojit událost přidání dávky

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

Parametry

event

"batchAdded"

Událost, která se má generovat

listener

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

Naslouchací proces událostí

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

Připojení události Selhání služby Batch

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

Parametry

event

"batchFailed"

Událost, která se má generovat

listener

(e: RestError) => void

Naslouchací proces událostí

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

Událost připojení dávky byla úspěšná

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

Parametry

event

"batchSucceeded"

Událost, která se má generovat

listener

(e: IndexDocumentsResult) => void

Naslouchací proces událostí

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

Připojení události odeslání dávky

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

Parametry

event

"beforeDocumentSent"

Událost, která se má generovat

listener

(e: IndexDocumentsAction<TModel>) => void

Naslouchací proces událostí

uploadDocuments(TModel[], OperationOptions)

Nahraje dokumenty nebo přidá dokumenty do fronty pro nahrání.

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

Parametry

documents

TModel[]

Dokumenty, které se mají nahrát.

options

OperationOptions

Možnosti nahrávání

Návraty

Promise<void>