SearchIndexingBufferedSender class

الحزمة:

@azure/search-documents

الفئة المستخدمة لتنفيذ عمليات مخزنة مؤقتا مقابل فهرس بحث، بما في ذلك إضافتها وتحديثها وإزالتها.

المنشئون

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

إنشاء مثيل جديد من SearchIndexingBufferedSender.

الأساليب

deleteDocuments(TModel[], OperationOptions)	حذف المستندات/إضافة المستندات إلى قائمة انتظار الحذف.
dispose()	إذا كنت تستخدم autoFlush: true، قم باستدعاء هذا لتنظيف مؤقت autoflush.
flush(OperationOptions)	مسح قائمة الانتظار يدويا.
mergeDocuments(TModel[], OperationOptions)	دمج المستندات/إضافة المستندات إلى قائمة انتظار الدمج.
mergeOrUploadDocuments(TModel[], OperationOptions)	دمج/تحميل المستندات/إضافة المستندات إلى قائمة انتظار الدمج/التحميل.
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)	فصل الحدث المضاف للدفعة
off("batchFailed", (e: RestError) => void)	فصل حدث فشل الدفعة
off("batchSucceeded", (e: IndexDocumentsResult) => void)	فصل حدث Batch Succeeded
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	فصل حدث Batch Sent
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)	إرفاق حدث الدفعة المضافة
on("batchFailed", (e: RestError) => void)	إرفاق حدث فشل الدفعة
on("batchSucceeded", (e: IndexDocumentsResult) => void)	إرفاق حدث Batch Succeeded
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)	إرفاق حدث Batch Sent
uploadDocuments(TModel[], OperationOptions)	تحميل المستندات/إضافة المستندات إلى قائمة انتظار التحميل.

تفاصيل المنشئ

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

إنشاء مثيل جديد من SearchIndexingBufferedSender.

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

المعلمات

client

IndexDocumentsClient<TModel>

عميل البحث المستخدم لاستدعاء عمليات IndexBatch الأساسية.

documentKeyRetriever

(document: TModel) => string

options

SearchIndexingBufferedSenderOptions

خيارات لتعديل المسح التلقائي.

تفاصيل الأسلوب

deleteDocuments(TModel[], OperationOptions)

حذف المستندات/إضافة المستندات إلى قائمة انتظار الحذف.

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

المعلمات

documents

TModel[]

المستندات المراد حذفها.

options

OperationOptions

خيارات التحميل.

المرتجعات

Promise<void>

dispose()

إذا كنت تستخدم autoFlush: true، قم باستدعاء هذا لتنظيف مؤقت autoflush.

function dispose(): Promise<void>

المرتجعات

Promise<void>

flush(OperationOptions)

مسح قائمة الانتظار يدويا.

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

المعلمات

options

OperationOptions

خيارات المسح.

المرتجعات

Promise<void>

mergeDocuments(TModel[], OperationOptions)

دمج المستندات/إضافة المستندات إلى قائمة انتظار الدمج.

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

المعلمات

documents

TModel[]

المستندات المراد دمجها.

options

OperationOptions

خيارات التحميل.

المرتجعات

Promise<void>

mergeOrUploadDocuments(TModel[], OperationOptions)

دمج/تحميل المستندات/إضافة المستندات إلى قائمة انتظار الدمج/التحميل.

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

المعلمات

documents

TModel[]

المستندات المراد دمجها/تحميلها.

options

OperationOptions

خيارات التحميل.

المرتجعات

Promise<void>

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

فصل الحدث المضاف للدفعة

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

المعلمات

event

"batchAdded"

الحدث الذي سيتم إصداره

listener

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

وحدة إصغاء الأحداث

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

فصل حدث فشل الدفعة

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

المعلمات

event

"batchFailed"

الحدث الذي سيتم إصداره

listener

(e: RestError) => void

وحدة إصغاء الأحداث

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

فصل حدث Batch Succeeded

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

المعلمات

event

"batchSucceeded"

الحدث الذي سيتم إصداره

listener

(e: IndexDocumentsResult) => void

وحدة إصغاء الأحداث

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

فصل حدث Batch Sent

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

المعلمات

event

"beforeDocumentSent"

الحدث الذي سيتم إصداره

listener

(e: IndexDocumentsAction<TModel>) => void

وحدة إصغاء الأحداث

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

إرفاق حدث الدفعة المضافة

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

المعلمات

event

"batchAdded"

الحدث الذي سيتم إصداره

listener

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

وحدة إصغاء الأحداث

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

إرفاق حدث فشل الدفعة

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

المعلمات

event

"batchFailed"

الحدث الذي سيتم إصداره

listener

(e: RestError) => void

وحدة إصغاء الأحداث

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

إرفاق حدث Batch Succeeded

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

المعلمات

event

"batchSucceeded"

الحدث الذي سيتم إصداره

listener

(e: IndexDocumentsResult) => void

وحدة إصغاء الأحداث

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

إرفاق حدث Batch Sent

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

المعلمات

event

"beforeDocumentSent"

الحدث الذي سيتم إصداره

listener

(e: IndexDocumentsAction<TModel>) => void

وحدة إصغاء الأحداث

uploadDocuments(TModel[], OperationOptions)

تحميل المستندات/إضافة المستندات إلى قائمة انتظار التحميل.

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

المعلمات

documents

TModel[]

المستندات التي سيتم تحميلها.

options

OperationOptions

خيارات التحميل.

المرتجعات

Promise<void>