다음을 통해 공유


SearchIndexingBufferedSender class

추가, 업데이트 및 제거를 포함하여 검색 인덱스에 대해 버퍼링된 작업을 수행하는 데 사용되는 클래스입니다.

생성자

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)

Batch 추가 이벤트 분리

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

일괄 처리 실패 이벤트 분리

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

Batch 성공 이벤트 분리

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

Batch Sent 이벤트 분리

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

Batch 추가 이벤트 연결

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

Batch 연결 실패 이벤트

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)

Batch 추가 이벤트 분리

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 성공 이벤트 분리

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)

Batch 추가 이벤트 연결

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)

Batch 연결 실패 이벤트

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>