SearchIndexingBufferedSender class

Paket:

@azure/search-documents

Kelas yang digunakan untuk melakukan operasi buffer terhadap indeks pencarian, termasuk menambahkan, memperbarui, dan menghapusnya.

Konstruktor

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

Membuat instans baru SearchIndexingBufferedSender.

Metode

deleteDocuments(TModel[], OperationOptions)	Menghapus dokumen/Menambahkan dokumen ke antrean penghapusan.
dispose()	Jika menggunakan autoFlush: true, panggil ini untuk membersihkan timer autoflush.
flush(OperationOptions)	Bersihkan antrean secara manual.
mergeDocuments(TModel[], OperationOptions)	Menggabungkan dokumen/Menambahkan dokumen ke antrean gabungan.
mergeOrUploadDocuments(TModel[], OperationOptions)	Menggabungkan/Mengunggah dokumen/Menambahkan dokumen ke antrean gabung/unggah.
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Lepaskan Peristiwa Yang Ditambahkan Batch
off("batchFailed", (e: RestError) => void)	Lepaskan Batch Kejadian Gagal
off("batchSucceeded", (e: IndexDocumentsResult) => void)	Lepaskan Peristiwa Berhasil Batch
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Lepaskan Peristiwa Terkirim Batch
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Lampirkan Peristiwa Yang Ditambahkan Batch
on("batchFailed", (e: RestError) => void)	Lampirkan Peristiwa Gagal Batch
on("batchSucceeded", (e: IndexDocumentsResult) => void)	Lampirkan Peristiwa Berhasil Batch
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Lampirkan Peristiwa Terkirim Batch
uploadDocuments(TModel[], OperationOptions)	Mengunggah dokumen/Menambahkan dokumen ke antrean unggahan.

Detail Konstruktor

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

Membuat instans baru SearchIndexingBufferedSender.

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

Parameter

client

IndexDocumentsClient<TModel>

Klien Pencarian digunakan untuk memanggil operasi IndexBatch yang mendasar.

documentKeyRetriever

(document: TModel) => string

options

SearchIndexingBufferedSenderOptions

Opsi untuk memodifikasi flush otomatis.

Detail Metode

deleteDocuments(TModel[], OperationOptions)

Menghapus dokumen/Menambahkan dokumen ke antrean penghapusan.

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

Parameter

documents

TModel[]

Dokumen yang akan dihapus.

options

OperationOptions

Opsi unggah.

Mengembalikan

Promise<void>

dispose()

Jika menggunakan autoFlush: true, panggil ini untuk membersihkan timer autoflush.

function dispose(): Promise<void>

Mengembalikan

Promise<void>

flush(OperationOptions)

Bersihkan antrean secara manual.

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

Parameter

options

OperationOptions

Opsi flush.

Mengembalikan

Promise<void>

mergeDocuments(TModel[], OperationOptions)

Menggabungkan dokumen/Menambahkan dokumen ke antrean gabungan.

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

Parameter

documents

TModel[]

Dokumen yang akan digabungkan.

options

OperationOptions

Opsi unggah.

Mengembalikan

Promise<void>

mergeOrUploadDocuments(TModel[], OperationOptions)

Menggabungkan/Mengunggah dokumen/Menambahkan dokumen ke antrean gabung/unggah.

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

Parameter

documents

TModel[]

Dokumen yang akan digabungkan/diunggah.

options

OperationOptions

Opsi unggah.

Mengembalikan

Promise<void>

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

Lepaskan Peristiwa Yang Ditambahkan Batch

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

Parameter

event

"batchAdded"

Peristiwa yang akan dipancarkan

listener

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

Pendengar Peristiwa

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

Lepaskan Batch Kejadian Gagal

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

Parameter

event

"batchFailed"

Peristiwa yang akan dipancarkan

listener

(e: RestError) => void

Pendengar Peristiwa

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

Lepaskan Peristiwa Berhasil Batch

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

Parameter

event

"batchSucceeded"

Peristiwa yang akan dipancarkan

listener

(e: IndexDocumentsResult) => void

Pendengar Peristiwa

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

Lepaskan Peristiwa Terkirim Batch

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

Parameter

event

"beforeDocumentSent"

Peristiwa yang akan dipancarkan

listener

(e: IndexDocumentsAction<TModel>) => void

Pendengar Peristiwa

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

Lampirkan Peristiwa Yang Ditambahkan Batch

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

Parameter

event

"batchAdded"

Peristiwa yang akan dipancarkan

listener

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

Pendengar Peristiwa

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

Lampirkan Peristiwa Gagal Batch

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

Parameter

event

"batchFailed"

Peristiwa yang akan dipancarkan

listener

(e: RestError) => void

Pendengar Peristiwa

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

Lampirkan Peristiwa Berhasil Batch

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

Parameter

event

"batchSucceeded"

Peristiwa yang akan dipancarkan

listener

(e: IndexDocumentsResult) => void

Pendengar Peristiwa

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

Lampirkan Peristiwa Terkirim Batch

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

Parameter

event

"beforeDocumentSent"

Peristiwa yang akan dipancarkan

listener

(e: IndexDocumentsAction<TModel>) => void

Pendengar Peristiwa

uploadDocuments(TModel[], OperationOptions)

Mengunggah dokumen/Menambahkan dokumen ke antrean unggahan.

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

Parameter

documents

TModel[]

Dokumen yang akan diunggah.

options

OperationOptions

Opsi unggah.

Mengembalikan

Promise<void>