SearchIndexingBufferedSender class
Klass som används för att utföra buffrade åtgärder mot ett sökindex, inklusive att lägga till, uppdatera och ta bort dem.
Konstruktorer
Search |
Skapar en ny instans av SearchIndexingBufferedSender. |
Metoder
Konstruktorinformation
SearchIndexingBufferedSender<TModel>(IndexDocumentsClient<TModel>, (document: TModel) => string, SearchIndexingBufferedSenderOptions)
Skapar en ny instans av SearchIndexingBufferedSender.
new SearchIndexingBufferedSender(client: IndexDocumentsClient<TModel>, documentKeyRetriever: (document: TModel) => string, options?: SearchIndexingBufferedSenderOptions)
Parametrar
- client
-
IndexDocumentsClient<TModel>
Sökklienten som används för att anropa underliggande IndexBatch-åtgärder.
- documentKeyRetriever
-
(document: TModel) => string
Alternativ för att ändra automatisk tömning.
Metodinformation
deleteDocuments(TModel[], OperationOptions)
Tar bort dokumenten/Lägger till dokumenten i borttagningskön.
function deleteDocuments(documents: TModel[], options?: OperationOptions): Promise<void>
Parametrar
- documents
-
TModel[]
Dokument som ska tas bort.
- options
- OperationOptions
Uppladdningsalternativ.
Returer
Promise<void>
dispose()
Om du använder autoFlush: true anropar du detta för att rensa autoflush-timern.
function dispose(): Promise<void>
Returer
Promise<void>
flush(OperationOptions)
Rensar kön manuellt.
function flush(options?: OperationOptions): Promise<void>
Parametrar
- options
- OperationOptions
Tömningsalternativ.
Returer
Promise<void>
mergeDocuments(TModel[], OperationOptions)
Sammanfogar dokumenten/Lägger till dokumenten i sammanslagningskön.
function mergeDocuments(documents: TModel[], options?: OperationOptions): Promise<void>
Parametrar
- documents
-
TModel[]
Dokument som ska sammanfogas.
- options
- OperationOptions
Uppladdningsalternativ.
Returer
Promise<void>
mergeOrUploadDocuments(TModel[], OperationOptions)
Sammanfogar/laddar upp dokumenten/Lägger till dokumenten i kön för sammanslagning/uppladdning.
function mergeOrUploadDocuments(documents: TModel[], options?: OperationOptions): Promise<void>
Parametrar
- documents
-
TModel[]
Dokument som ska sammanfogas/laddas upp.
- options
- OperationOptions
Uppladdningsalternativ.
Returer
Promise<void>
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)
Koppla från batch tillagd händelse
function off(event: "batchAdded", listener: (e: { action: string, documents: TModel[] }) => void)
Parametrar
- event
-
"batchAdded"
Händelse som ska genereras
- listener
-
(e: { action: string, documents: TModel[] }) => void
Händelselyssnare
off("batchFailed", (e: RestError) => void)
Koppla från batchens misslyckade händelse
function off(event: "batchFailed", listener: (e: RestError) => void)
Parametrar
- event
-
"batchFailed"
Händelse som ska genereras
- listener
-
(e: RestError) => void
Händelselyssnare
off("batchSucceeded", (e: IndexDocumentsResult) => void)
Koppla från batch lyckades händelse
function off(event: "batchSucceeded", listener: (e: IndexDocumentsResult) => void)
Parametrar
- event
-
"batchSucceeded"
Händelse som ska genereras
- listener
-
(e: IndexDocumentsResult) => void
Händelselyssnare
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)
Koppla från batch-skickad händelse
function off(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<TModel>) => void)
Parametrar
- event
-
"beforeDocumentSent"
Händelse som ska genereras
- listener
-
(e: IndexDocumentsAction<TModel>) => void
Händelselyssnare
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)
Bifoga batch-tillagd händelse
function on(event: "batchAdded", listener: (e: { action: string, documents: TModel[] }) => void)
Parametrar
- event
-
"batchAdded"
Händelse som ska genereras
- listener
-
(e: { action: string, documents: TModel[] }) => void
Händelselyssnare
on("batchFailed", (e: RestError) => void)
Koppla batch-misslyckad händelse
function on(event: "batchFailed", listener: (e: RestError) => void)
Parametrar
- event
-
"batchFailed"
Händelse som ska genereras
- listener
-
(e: RestError) => void
Händelselyssnare
on("batchSucceeded", (e: IndexDocumentsResult) => void)
Bifoga batch lyckades händelse
function on(event: "batchSucceeded", listener: (e: IndexDocumentsResult) => void)
Parametrar
- event
-
"batchSucceeded"
Händelse som ska genereras
- listener
-
(e: IndexDocumentsResult) => void
Händelselyssnare
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)
Koppla batch-skickad händelse
function on(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<TModel>) => void)
Parametrar
- event
-
"beforeDocumentSent"
Händelse som ska genereras
- listener
-
(e: IndexDocumentsAction<TModel>) => void
Händelselyssnare
uploadDocuments(TModel[], OperationOptions)
Laddar upp dokumenten/Lägger till dokumenten i uppladdningskön.
function uploadDocuments(documents: TModel[], options?: OperationOptions): Promise<void>
Parametrar
- documents
-
TModel[]
Dokument som ska laddas upp.
- options
- OperationOptions
Uppladdningsalternativ.
Returer
Promise<void>