SearchIndexingBufferedSender class
Classe usata per eseguire operazioni con buffer su un indice di ricerca, tra cui l'aggiunta, l'aggiornamento e la rimozione.
Costruttori
Search |
Crea una nuova istanza di SearchIndexingBufferedSender. |
Metodi
Dettagli costruttore
SearchIndexingBufferedSender<TModel>(IndexDocumentsClient<TModel>, (document: TModel) => string, SearchIndexingBufferedSenderOptions)
Crea una nuova istanza di SearchIndexingBufferedSender.
new SearchIndexingBufferedSender(client: IndexDocumentsClient<TModel>, documentKeyRetriever: (document: TModel) => string, options?: SearchIndexingBufferedSenderOptions)
Parametri
- client
-
IndexDocumentsClient<TModel>
Client di ricerca usato per chiamare le operazioni IndexBatch sottostanti.
- documentKeyRetriever
-
(document: TModel) => string
Opzioni per modificare lo scaricamento automatico.
Dettagli metodo
deleteDocuments(TModel[], OperationOptions)
Elimina i documenti/Aggiunge i documenti alla coda di eliminazione.
function deleteDocuments(documents: TModel[], options?: OperationOptions): Promise<void>
Parametri
- documents
-
TModel[]
Documenti da eliminare.
- options
- OperationOptions
Opzioni di caricamento.
Restituisce
Promise<void>
dispose()
Se si usa autoFlush: true, chiamare questa operazione per pulire il timer diflush automatico.
function dispose(): Promise<void>
Restituisce
Promise<void>
flush(OperationOptions)
Scarica manualmente la coda.
function flush(options?: OperationOptions): Promise<void>
Parametri
- options
- OperationOptions
Opzioni di scaricamento.
Restituisce
Promise<void>
mergeDocuments(TModel[], OperationOptions)
Unione dei documenti/Aggiunge i documenti alla coda di unione.
function mergeDocuments(documents: TModel[], options?: OperationOptions): Promise<void>
Parametri
- documents
-
TModel[]
Documenti da unire.
- options
- OperationOptions
Opzioni di caricamento.
Restituisce
Promise<void>
mergeOrUploadDocuments(TModel[], OperationOptions)
Merges/Carica i documenti/Aggiunge i documenti alla coda merge/upload.
function mergeOrUploadDocuments(documents: TModel[], options?: OperationOptions): Promise<void>
Parametri
- documents
-
TModel[]
Documenti da unire/caricare.
- options
- OperationOptions
Opzioni di caricamento.
Restituisce
Promise<void>
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)
Scollegare l'evento Aggiunto batch
function off(event: "batchAdded", listener: (e: { action: string, documents: TModel[] }) => void)
Parametri
- event
-
"batchAdded"
Evento da generare
- listener
-
(e: { action: string, documents: TModel[] }) => void
Listener di eventi
off("batchFailed", (e: RestError) => void)
Evento Scollega batch non riuscito
function off(event: "batchFailed", listener: (e: RestError) => void)
Parametri
- event
-
"batchFailed"
Evento da generare
- listener
-
(e: RestError) => void
Listener di eventi
off("batchSucceeded", (e: IndexDocumentsResult) => void)
Scollegare l'evento Batch riuscito
function off(event: "batchSucceeded", listener: (e: IndexDocumentsResult) => void)
Parametri
- event
-
"batchSucceeded"
Evento da generare
- listener
-
(e: IndexDocumentsResult) => void
Listener di eventi
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)
Scollegare l'evento Inviato batch
function off(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<TModel>) => void)
Parametri
- event
-
"beforeDocumentSent"
Evento da generare
- listener
-
(e: IndexDocumentsAction<TModel>) => void
Listener di eventi
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)
Collegare l'evento Aggiunto batch
function on(event: "batchAdded", listener: (e: { action: string, documents: TModel[] }) => void)
Parametri
- event
-
"batchAdded"
Evento da generare
- listener
-
(e: { action: string, documents: TModel[] }) => void
Listener di eventi
on("batchFailed", (e: RestError) => void)
Evento Attach Batch non riuscito
function on(event: "batchFailed", listener: (e: RestError) => void)
Parametri
- event
-
"batchFailed"
Evento da generare
- listener
-
(e: RestError) => void
Listener di eventi
on("batchSucceeded", (e: IndexDocumentsResult) => void)
Evento Attach Batch Successed
function on(event: "batchSucceeded", listener: (e: IndexDocumentsResult) => void)
Parametri
- event
-
"batchSucceeded"
Evento da generare
- listener
-
(e: IndexDocumentsResult) => void
Listener di eventi
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)
Collegare l'evento Inviato batch
function on(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<TModel>) => void)
Parametri
- event
-
"beforeDocumentSent"
Evento da generare
- listener
-
(e: IndexDocumentsAction<TModel>) => void
Listener di eventi
uploadDocuments(TModel[], OperationOptions)
Carica i documenti/Aggiunge i documenti alla coda di caricamento.
function uploadDocuments(documents: TModel[], options?: OperationOptions): Promise<void>
Parametri
- documents
-
TModel[]
Documenti da caricare.
- options
- OperationOptions
Opzioni di caricamento.
Restituisce
Promise<void>