org.nuxeo.elasticsearch.api

Interface ElasticSearchAdmin

All Known Implementing Classes:

ElasticSearchAdminImpl, ElasticSearchComponent

public interface ElasticSearchAdmin

Administration interface for Elasticsearch service

Since:

5.9.3

Method Summary

Methods

Modifier and Type	Method and Description
void	dropAndInitRepositoryIndex(String repositoryName) Reinitialize the index of a repository.
void	flush() Elasticsearch flush on all document indexes, triggers a lucene commit, empties the transaction log.
void	flushRepositoryIndex(String repositoryName) Elasticsearch flush on document index for a specific repository, triggers a lucene commit, empties the transaction log.
org.elasticsearch.client.Client	getClient() Retrieves the Client that can be used to access Elasticsearch API
int	getPendingCommands() Returns the number of indexing command that are waiting to be processed.
int	getPendingDocs() Returns the number of documents that are waiting for being indexed.
List<String>	getRepositoryNames() List repository names that has Elasticsearch support.
int	getRunningCommands() Returns the number of indexing command that are currently running
int	getTotalCommandProcessed() Returns the total number of command processed by Elasticsearch.
void	initIndexes(boolean dropIfExists) Initialize Elasticsearch indexes.
boolean	isIndexingInProgress() Returns true if there are indexing activities.
void	refresh() Refresh all document indexes, immediately after the operation occurs, so that the updated document appears in search results immediately.
void	refreshRepositoryIndex(String repositoryName) Refresh document index for the specific repository, immediately after the operation occurs, so that the updated document appears in search results immediately.

Method Detail

getClient

org.elasticsearch.client.Client getClient()

Retrieves the Client that can be used to access Elasticsearch API

Since:

5.9.3

initIndexes

void initIndexes(boolean dropIfExists)

Initialize Elasticsearch indexes. Setup the index settings and mapping for each index that has been registered.

Parameters:

dropIfExists - if {true} remove an existing index

Since:

5.9.3

dropAndInitRepositoryIndex

void dropAndInitRepositoryIndex(String repositoryName)

Reinitialize the index of a repository. This will drop the existing index, recreate it with its settings and mapping, the index will be empty.

Since:

7.1

getRepositoryNames

List<String> getRepositoryNames()

List repository names that has Elasticsearch support.

Since:

7.1

isIndexingInProgress

boolean isIndexingInProgress()

Returns true if there are indexing activities. This include currently running, scheduled and asynchronous recursive jobs.

Since:

5.9.5

refresh

void refresh()

Refresh all document indexes, immediately after the operation occurs, so that the updated document appears in search results immediately. There is no fsync thus doesn't guarantee durability.

Since:

5.9.3

refreshRepositoryIndex

void refreshRepositoryIndex(String repositoryName)

Refresh document index for the specific repository, immediately after the operation occurs, so that the updated document appears in search results immediately. There is no fsync thus doesn't guarantee durability.

Since:

5.9.4

flush

void flush()

Elasticsearch flush on all document indexes, triggers a lucene commit, empties the transaction log. Data is flushed to disk.

Since:

5.9.3

flushRepositoryIndex

void flushRepositoryIndex(String repositoryName)

Elasticsearch flush on document index for a specific repository, triggers a lucene commit, empties the transaction log. Data is flushed to disk.

Since:

5.9.4

getPendingDocs

int getPendingDocs()

Returns the number of documents that are waiting for being indexed.

Since:

5.9.3

getPendingCommands

int getPendingCommands()

Returns the number of indexing command that are waiting to be processed. This include the recursive asynchronous activities.

Since:

5.9.3

getRunningCommands

int getRunningCommands()

Returns the number of indexing command that are currently running

Since:

5.9.5

getTotalCommandProcessed

int getTotalCommandProcessed()

Returns the total number of command processed by Elasticsearch. Useful for test assertion.

Since:

5.9.4