SearchIndexingBufferedSender class

Pakiet:

@azure/search-documents

Klasa używana do wykonywania buforowanych operacji względem indeksu wyszukiwania, w tym dodawania, aktualizowania i usuwania.

Konstruktory

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

Tworzy nowe wystąpienie elementu SearchIndexingBufferedSender.

Metody

deleteDocuments(TModel[], OperationOptions)	Usuwa dokumenty/Dodaje dokumenty do kolejki usuwania.
dispose()	Jeśli używasz autoFlush: prawda, wywołaj to, aby wyczyścić czasomierz automatycznego napływu.
flush(OperationOptions)	Opróżnia kolejkę ręcznie.
mergeDocuments(TModel[], OperationOptions)	Scala dokumenty/Dodaje dokumenty do kolejki scalania.
mergeOrUploadDocuments(TModel[], OperationOptions)	Scala/przekazuje dokumenty/dodaje dokumenty do kolejki scalania/przekazywania.
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Odłącz zdarzenie dodane przez usługę Batch
off("batchFailed", (e: RestError) => void)	Odłączanie zdarzenia wsadowego, które nie powiodło się
off("batchSucceeded", (e: IndexDocumentsResult) => void)	Odłączanie zdarzenia zakończonego powodzeniem wsadu
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Odłącz zdarzenie wysłane wsadowe
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Dołączanie zdarzenia dodanego do usługi Batch
on("batchFailed", (e: RestError) => void)	Dołączanie zdarzenia niepowodzenia usługi Batch
on("batchSucceeded", (e: IndexDocumentsResult) => void)	Dołączanie zdarzenia zakończonego powodzeniem usługi Batch
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Dołączanie zdarzenia wysłanego wsadowego
uploadDocuments(TModel[], OperationOptions)	Przekazuje dokumenty/dodaje dokumenty do kolejki przekazywania.

Szczegóły konstruktora

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

Tworzy nowe wystąpienie elementu SearchIndexingBufferedSender.

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

Parametry

client

IndexDocumentsClient<TModel>

Klient wyszukiwania używany do wywoływania podstawowych operacji IndexBatch.

documentKeyRetriever

(document: TModel) => string

options

SearchIndexingBufferedSenderOptions

Opcje modyfikowania automatycznego opróżniania.

Szczegóły metody

deleteDocuments(TModel[], OperationOptions)

Usuwa dokumenty/Dodaje dokumenty do kolejki usuwania.

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

Parametry

documents

TModel[]

Dokumenty do usunięcia.

options

OperationOptions

Opcje przekazywania.

Zwraca

Promise<void>

dispose()

Jeśli używasz autoFlush: prawda, wywołaj to, aby wyczyścić czasomierz automatycznego napływu.

function dispose(): Promise<void>

Zwraca

Promise<void>

flush(OperationOptions)

Opróżnia kolejkę ręcznie.

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

Parametry

options

OperationOptions

Opcje opróżniania.

Zwraca

Promise<void>

mergeDocuments(TModel[], OperationOptions)

Scala dokumenty/Dodaje dokumenty do kolejki scalania.

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

Parametry

documents

TModel[]

Dokumenty do scalenia.

options

OperationOptions

Opcje przekazywania.

Zwraca

Promise<void>

mergeOrUploadDocuments(TModel[], OperationOptions)

Scala/przekazuje dokumenty/dodaje dokumenty do kolejki scalania/przekazywania.

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

Parametry

documents

TModel[]

Dokumenty do scalenia/przekazania.

options

OperationOptions

Opcje przekazywania.

Zwraca

Promise<void>

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

Odłącz zdarzenie dodane przez usługę Batch

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

Parametry

event

"batchAdded"

Zdarzenie, które ma być emitowane

listener

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

Odbiornik zdarzeń

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

Odłączanie zdarzenia wsadowego, które nie powiodło się

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

Parametry

event

"batchFailed"

Zdarzenie, które ma być emitowane

listener

(e: RestError) => void

Odbiornik zdarzeń

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

Odłączanie zdarzenia zakończonego powodzeniem wsadu

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

Parametry

event

"batchSucceeded"

Zdarzenie, które ma być emitowane

listener

(e: IndexDocumentsResult) => void

Odbiornik zdarzeń

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

Odłącz zdarzenie wysłane wsadowe

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

Parametry

event

"beforeDocumentSent"

Zdarzenie, które ma być emitowane

listener

(e: IndexDocumentsAction<TModel>) => void

Odbiornik zdarzeń

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

Dołączanie zdarzenia dodanego do usługi Batch

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

Parametry

event

"batchAdded"

Zdarzenie, które ma być emitowane

listener

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

Odbiornik zdarzeń

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

Dołączanie zdarzenia niepowodzenia usługi Batch

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

Parametry

event

"batchFailed"

Zdarzenie, które ma być emitowane

listener

(e: RestError) => void

Odbiornik zdarzeń

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

Dołączanie zdarzenia zakończonego powodzeniem usługi Batch

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

Parametry

event

"batchSucceeded"

Zdarzenie, które ma być emitowane

listener

(e: IndexDocumentsResult) => void

Odbiornik zdarzeń

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

Dołączanie zdarzenia wysłanego wsadowego

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

Parametry

event

"beforeDocumentSent"

Zdarzenie, które ma być emitowane

listener

(e: IndexDocumentsAction<TModel>) => void

Odbiornik zdarzeń

uploadDocuments(TModel[], OperationOptions)

Przekazuje dokumenty/dodaje dokumenty do kolejki przekazywania.

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

Parametry

documents

TModel[]

Dokumenty do przekazania.

options

OperationOptions

Opcje przekazywania.

Zwraca

Promise<void>