SearchIndexingBufferedSender class

Paket:

@azure/search-documents

Arama dizininde arabelleğe alınan işlemleri gerçekleştirmek için kullanılan sınıf; bunları ekleme, güncelleştirme ve kaldırma da dahil olmak üzere.

Oluşturucular

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

SearchIndexingBufferedSender'ın yeni bir örneğini oluşturur.

Yöntemler

deleteDocuments(TModel[], OperationOptions)	Belgeleri siler/Belgeleri silme kuyruğuna ekler.
dispose()	autoFlush: true kullanıyorsanız autoflush zamanlayıcısını temizlemek için bunu çağırın.
flush(OperationOptions)	Kuyruğu el ile boşaltır.
mergeDocuments(TModel[], OperationOptions)	Belgeleri birleştirir/Belgeleri birleştirme kuyruğuna ekler.
mergeOrUploadDocuments(TModel[], OperationOptions)	Belgeleri birleştirir/karşıya yükler/Belgeleri birleştirme/karşıya yükleme kuyruğuna ekler.
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Toplu Ekleme Olayını Ayırma
off("batchFailed", (e: RestError) => void)	Toplu İşlemi Ayırma Başarısız Olayı
off("batchSucceeded", (e: IndexDocumentsResult) => void)	Toplu İşlemi Ayırma Başarılı Olayı
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Toplu Gönderilen Olayı Ayırma
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	Batch Ekleme Olayı Eklendi
on("batchFailed", (e: RestError) => void)	Toplu İş Ekleme Başarısız Olayı
on("batchSucceeded", (e: IndexDocumentsResult) => void)	Toplu İş Ekleme Başarılı Olayı
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	Toplu Gönderilen Olayı Ekle
uploadDocuments(TModel[], OperationOptions)	Belgeleri karşıya yükler/Belgeleri karşıya yükleme kuyruğuna ekler.

Oluşturucu Ayrıntıları

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

SearchIndexingBufferedSender'ın yeni bir örneğini oluşturur.

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

Parametreler

client

IndexDocumentsClient<TModel>

Temel alınan IndexBatch işlemlerini çağırmak için kullanılan Arama İstemcisi.

documentKeyRetriever

(document: TModel) => string

options

SearchIndexingBufferedSenderOptions

Otomatik temizlemeyi değiştirme seçenekleri.

Yöntem Ayrıntıları

deleteDocuments(TModel[], OperationOptions)

Belgeleri siler/Belgeleri silme kuyruğuna ekler.

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

Parametreler

documents

TModel[]

Silinecek belgeler.

options

OperationOptions

Karşıya yükleme seçenekleri.

Döndürülenler

Promise<void>

dispose()

autoFlush: true kullanıyorsanız autoflush zamanlayıcısını temizlemek için bunu çağırın.

function dispose(): Promise<void>

Döndürülenler

Promise<void>

flush(OperationOptions)

Kuyruğu el ile boşaltır.

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

Parametreler

options

OperationOptions

Boşaltma seçenekleri.

Döndürülenler

Promise<void>

mergeDocuments(TModel[], OperationOptions)

Belgeleri birleştirir/Belgeleri birleştirme kuyruğuna ekler.

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

Parametreler

documents

TModel[]

Birleştirilecek belgeler.

options

OperationOptions

Karşıya yükleme seçenekleri.

Döndürülenler

Promise<void>

mergeOrUploadDocuments(TModel[], OperationOptions)

Belgeleri birleştirir/karşıya yükler/Belgeleri birleştirme/karşıya yükleme kuyruğuna ekler.

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

Parametreler

documents

TModel[]

Birleştirilecek/karşıya yüklenecek belgeler.

options

OperationOptions

Karşıya yükleme seçenekleri.

Döndürülenler

Promise<void>

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

Toplu Ekleme Olayını Ayırma

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

Parametreler

event

"batchAdded"

Yayılacak olay

listener

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

Olay Dinleyicisi

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

Toplu İşlemi Ayırma Başarısız Olayı

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

Parametreler

event

"batchFailed"

Yayılacak olay

listener

(e: RestError) => void

Olay Dinleyicisi

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

Toplu İşlemi Ayırma Başarılı Olayı

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

Parametreler

event

"batchSucceeded"

Yayılacak olay

listener

(e: IndexDocumentsResult) => void

Olay Dinleyicisi

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

Toplu Gönderilen Olayı Ayırma

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

Parametreler

event

"beforeDocumentSent"

Yayılacak olay

listener

(e: IndexDocumentsAction<TModel>) => void

Olay Dinleyicisi

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

Batch Ekleme Olayı Eklendi

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

Parametreler

event

"batchAdded"

Yayılacak olay

listener

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

Olay Dinleyicisi

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

Toplu İş Ekleme Başarısız Olayı

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

Parametreler

event

"batchFailed"

Yayılacak olay

listener

(e: RestError) => void

Olay Dinleyicisi

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

Toplu İş Ekleme Başarılı Olayı

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

Parametreler

event

"batchSucceeded"

Yayılacak olay

listener

(e: IndexDocumentsResult) => void

Olay Dinleyicisi

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

Toplu Gönderilen Olayı Ekle

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

Parametreler

event

"beforeDocumentSent"

Yayılacak olay

listener

(e: IndexDocumentsAction<TModel>) => void

Olay Dinleyicisi

uploadDocuments(TModel[], OperationOptions)

Belgeleri karşıya yükler/Belgeleri karşıya yükleme kuyruğuna ekler.

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

Parametreler

documents

TModel[]

Karşıya yüklenecek belgeler.

options

OperationOptions

Karşıya yükleme seçenekleri.

Döndürülenler

Promise<void>