fr.gouv.vitam.common.database.server.elasticsearch

Class ElasticsearchAccess

java.lang.Object

fr.gouv.vitam.common.database.server.elasticsearch.ElasticsearchAccess

All Implemented Interfaces:

DatabaseConnection

Direct Known Subclasses:

ElasticsearchAccessFunctionalAdmin, ElasticsearchAccessMetadata, LogbookElasticsearchAccess

public class ElasticsearchAccess
extends Object
implements DatabaseConnection

Elasticsearch Access

Field Summary

Fields

Modifier and Type	Field and Description
protected org.elasticsearch.client.transport.TransportClient	client
protected String	clusterName
org.elasticsearch.common.settings.Settings.Builder	default_builder The ES Builder
protected List<ElasticsearchNode>	nodes

Constructor Summary

Constructors

Constructor and Description
ElasticsearchAccess(String clusterName, List<ElasticsearchNode> nodes) Create an ElasticSearch access

Method Summary

Modifier and Type	Method and Description
boolean	checkConnection() Check the connection of the database
void	close() Close the ElasticSearch connection
boolean	createIndexAndAliasIfAliasNotExists(String collectionName, String mapping, String type, Integer tenantId) Create an index and alias for a collection (if the alias does not exist)
String	createIndexWithoutAlias(String collectionName, String mapping, String type, Integer tenantId) Create an index without a linked alias
org.elasticsearch.client.Client	getClient()
String	getClusterName()
String	getInfo() Get information on a Database
List<ElasticsearchNode>	getNodes()
static org.elasticsearch.common.settings.Settings	getSettings(String clusterName) Production settings, see Elasticsearch production settings https://www.elastic.co/guide/en/elasticsearch/guide/current/deploy.html. Additionnal on server side: in sysctl "vm.swappiness = 1", "vm.max_map_count=262144" in elasticsearch.yml "bootstrap.mlockall: true"
org.elasticsearch.common.settings.Settings.Builder	settings() Settings method
void	switchIndex(String aliasName, String indexNameToSwitchWith) Switch index

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

default_builder

public org.elasticsearch.common.settings.Settings.Builder default_builder

The ES Builder

client

protected final org.elasticsearch.client.transport.TransportClient client

clusterName

protected final String clusterName

nodes

protected final List<ElasticsearchNode> nodes

Constructor Detail

ElasticsearchAccess

public ElasticsearchAccess(String clusterName,
                           List<ElasticsearchNode> nodes)
                    throws VitamException,
                           IOException

Create an ElasticSearch access

Parameters:

clusterName - the name of the Cluster

nodes - the elasticsearch nodes

Throws:

VitamException - when elasticseach node list is empty

IOException

Method Detail

getSettings

public static org.elasticsearch.common.settings.Settings getSettings(String clusterName)

Production settings, see Elasticsearch production settings https://www.elastic.co/guide/en/elasticsearch/guide/current/deploy.html.

Additionnal on server side:
in sysctl "vm.swappiness = 1", "vm.max_map_count=262144"
in elasticsearch.yml "bootstrap.mlockall: true"

Returns:

Settings for Elasticsearch client

close

public void close()

Close the ElasticSearch connection

getClusterName

public String getClusterName()

Returns:

the Cluster Name

getClient

public org.elasticsearch.client.Client getClient()

Returns:

the client

getNodes

public List<ElasticsearchNode> getNodes()

Returns:

the nodes

checkConnection

public boolean checkConnection()

Description copied from interface: DatabaseConnection

Check the connection of the database

Specified by:

checkConnection in interface DatabaseConnection

Returns:

True if the connection is active

getInfo

public String getInfo()

Description copied from interface: DatabaseConnection

Get information on a Database

Specified by:

getInfo in interface DatabaseConnection

Returns:

information on the database

createIndexAndAliasIfAliasNotExists

public final boolean createIndexAndAliasIfAliasNotExists(String collectionName,
                                                         String mapping,
                                                         String type,
                                                         Integer tenantId)

Create an index and alias for a collection (if the alias does not exist)

Parameters:

collectionName - the name of the collection

mapping - the mapping as a string

type - the type of the collection

tenantId - the tenant on which to create the index

Returns:

true if index is successfully created false if not

createIndexWithoutAlias

public final String createIndexWithoutAlias(String collectionName,
                                            String mapping,
                                            String type,
                                            Integer tenantId)
                                     throws DatabaseException

Create an index without a linked alias

Parameters:

collectionName -

mapping -

type -

tenantId -

Returns:

the newly created index Name

Throws:

DatabaseException

switchIndex

public final void switchIndex(String aliasName,
                              String indexNameToSwitchWith)
                       throws DatabaseException

Switch index

Parameters:

aliasName -

indexNameToSwitchWith -

Throws:

DatabaseException

settings

public org.elasticsearch.common.settings.Settings.Builder settings()
                                                            throws IOException

Settings method

Returns:

the builder

Throws:

IOException