SearchIndexingBufferedSender class

Pakket:

@azure/search-documents

Klasse die wordt gebruikt om gebufferde bewerkingen uit te voeren op een zoekindex, waaronder het toevoegen, bijwerken en verwijderen ervan.

Constructors

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

Hiermee maakt u een nieuw exemplaar van SearchIndexingBufferedSender.

Methoden

deleteDocuments(TModel[], OperationOptions)	Hiermee verwijdert u de documenten/voegt u de documenten toe aan de verwijderingswachtrij.
dispose()	Als u autoFlush: true gebruikt, roept u deze aan om de autoflush-timer op te ruimen.
flush(OperationOptions)	Hiermee wordt de wachtrij handmatig leeggemaakt.
mergeDocuments(TModel[], OperationOptions)	Hiermee voegt u de documenten samen/voegt u de documenten toe aan de samenvoegwachtrij.
mergeOrUploadDocuments(TModel[], OperationOptions)	Hiermee worden de documenten samengevoegd/geüpload/worden de documenten toegevoegd aan de wachtrij voor samenvoegen/uploaden.
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Gebeurtenis met batch toegevoegd loskoppelen
off("batchFailed", (e: RestError) => void)	Batch mislukte gebeurtenis loskoppelen
off("batchSucceeded", (e: IndexDocumentsResult) => void)	Gebeurtenis Batch geslaagd loskoppelen
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Door batch verzonden gebeurtenis loskoppelen
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Gebeurtenis met batch toevoegen
on("batchFailed", (e: RestError) => void)	Batch mislukte gebeurtenis koppelen
on("batchSucceeded", (e: IndexDocumentsResult) => void)	Gebeurtenis batchgebeurtenis koppelen
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Batch verzonden gebeurtenis koppelen
uploadDocuments(TModel[], OperationOptions)	Uploadt de documenten/voegt de documenten toe aan de uploadwachtrij.

Constructordetails

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

Hiermee maakt u een nieuw exemplaar van SearchIndexingBufferedSender.

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

Parameters

client

IndexDocumentsClient<TModel>

Zoekclient die wordt gebruikt om de onderliggende IndexBatch-bewerkingen aan te roepen.

documentKeyRetriever

(document: TModel) => string

options

SearchIndexingBufferedSenderOptions

Opties voor het wijzigen van automatisch leegmaken.

Methodedetails

deleteDocuments(TModel[], OperationOptions)

Hiermee verwijdert u de documenten/voegt u de documenten toe aan de verwijderingswachtrij.

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

Parameters

documents

TModel[]

Documenten die moeten worden verwijderd.

options

OperationOptions

Uploadopties.

Retouren

Promise<void>

dispose()

Als u autoFlush: true gebruikt, roept u deze aan om de autoflush-timer op te ruimen.

function dispose(): Promise<void>

Retouren

Promise<void>

flush(OperationOptions)

Hiermee wordt de wachtrij handmatig leeggemaakt.

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

Parameters

options

OperationOptions

Opties voor leegmaken.

Retouren

Promise<void>

mergeDocuments(TModel[], OperationOptions)

Hiermee voegt u de documenten samen/voegt u de documenten toe aan de samenvoegwachtrij.

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

Parameters

documents

TModel[]

Documenten die moeten worden samengevoegd.

options

OperationOptions

Uploadopties.

Retouren

Promise<void>

mergeOrUploadDocuments(TModel[], OperationOptions)

Hiermee worden de documenten samengevoegd/geüpload/worden de documenten toegevoegd aan de wachtrij voor samenvoegen/uploaden.

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

Parameters

documents

TModel[]

Documenten die moeten worden samengevoegd/geüpload.

options

OperationOptions

Uploadopties.

Retouren

Promise<void>

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

Gebeurtenis met batch toegevoegd loskoppelen

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

Parameters

event

"batchAdded"

Gebeurtenis die moet worden verzonden

listener

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

Gebeurtenislistener

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

Batch mislukte gebeurtenis loskoppelen

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

Parameters

event

"batchFailed"

Gebeurtenis die moet worden verzonden

listener

(e: RestError) => void

Gebeurtenislistener

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

Gebeurtenis Batch geslaagd loskoppelen

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

Parameters

event

"batchSucceeded"

Gebeurtenis die moet worden verzonden

listener

(e: IndexDocumentsResult) => void

Gebeurtenislistener

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

Door batch verzonden gebeurtenis loskoppelen

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

Parameters

event

"beforeDocumentSent"

Gebeurtenis die moet worden verzonden

listener

(e: IndexDocumentsAction<TModel>) => void

Gebeurtenislistener

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

Gebeurtenis met batch toevoegen

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

Parameters

event

"batchAdded"

Gebeurtenis die moet worden verzonden

listener

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

Gebeurtenislistener

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

Batch mislukte gebeurtenis koppelen

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

Parameters

event

"batchFailed"

Gebeurtenis die moet worden verzonden

listener

(e: RestError) => void

Gebeurtenislistener

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

Gebeurtenis batchgebeurtenis koppelen

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

Parameters

event

"batchSucceeded"

Gebeurtenis die moet worden verzonden

listener

(e: IndexDocumentsResult) => void

Gebeurtenislistener

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

Batch verzonden gebeurtenis koppelen

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

Parameters

event

"beforeDocumentSent"

Gebeurtenis die moet worden verzonden

listener

(e: IndexDocumentsAction<TModel>) => void

Gebeurtenislistener

uploadDocuments(TModel[], OperationOptions)

Uploadt de documenten/voegt de documenten toe aan de uploadwachtrij.

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

Parameters

documents

TModel[]

Documenten die moeten worden geüpload.

options

OperationOptions

Uploadopties.

Retouren

Promise<void>