fr.gouv.vitam.metadata.core.database.collections

Class ElasticsearchAccessMetadata

java.lang.Object

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

fr.gouv.vitam.metadata.core.database.collections.ElasticsearchAccessMetadata

All Implemented Interfaces:

DatabaseConnection

public class ElasticsearchAccessMetadata
extends ElasticsearchAccess

ElasticSearch model with MongoDB as main database

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAPPING_OBJECT_GROUP_FILE
static String	MAPPING_UNIT_FILE

Fields inherited from class fr.gouv.vitam.common.database.server.elasticsearch.ElasticsearchAccess

client, clusterName, default_builder, nodes

Constructor Summary

Constructors

Constructor and Description
ElasticsearchAccessMetadata(String clusterName, List<ElasticsearchNode> nodes)

Method Summary

Modifier and Type	Method and Description
int	addBulkEntryIndex(Map<String,String> indexes, Integer tenantId, MetadataDocument<?> document) Used for iterative reload in restore operation (using bulk).
boolean	addEntryIndex(MetadataDocument<?> document, Integer tenantId) Add one VitamDocument to indexation immediately
boolean	addIndex(MetadataCollections collection, Integer tenantId) Add a type to an index
org.elasticsearch.action.search.SearchResponse	basicSearch(MetadataCollections collection, Integer tenantId, List<org.elasticsearch.search.aggregations.AggregationBuilder> aggregations, org.elasticsearch.index.query.QueryBuilder query) Makes a search request on elasticsearch on a collection with aggregations and a query
boolean	deleteBulkOGEntriesIndexes(List<String> ids, Integer tenantId) deleteBulkOGEntriesIndexes
void	deleteBulkUnitsEntriesIndexes(List<String> ids, Integer tenantId) deleteBulkUnitEntriesIndexes
void	deleteEntryIndex(MetadataCollections collections, Integer tenantId, String type, String id)
boolean	deleteIndex(MetadataCollections collection, Integer tenantId) Delete one index
void	insertFullDocument(MetadataCollections collection, Integer tenantId, String id, MetadataDocument doc) Insert one element
void	insertFullDocuments(MetadataCollections collection, Integer tenantId, List<? extends MetadataDocument> documents)
void	refreshIndex(MetadataCollections collection, Integer tenantId) refresh an index
protected Result	search(MetadataCollections collection, Integer tenantId, String type, org.elasticsearch.index.query.QueryBuilder query, List<org.elasticsearch.search.sort.SortBuilder> sorts, int offset, Integer limit, List<org.elasticsearch.search.aggregations.AggregationBuilder> facets, String scrollId, Integer scrollTimeout)
void	updateFullDocument(MetadataCollections collection, Integer tenantId, String id, MetadataDocument doc) Update one element fully

Methods inherited from class fr.gouv.vitam.common.database.server.elasticsearch.ElasticsearchAccess

checkConnection, close, createIndexAndAliasIfAliasNotExists, createIndexWithoutAlias, getClient, getClusterName, getInfo, getNodes, getSettings, settings, switchIndex

Methods inherited from class java.lang.Object

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

Field Detail

MAPPING_UNIT_FILE

public static final String MAPPING_UNIT_FILE

See Also:

Constant Field Values

MAPPING_OBJECT_GROUP_FILE

public static final String MAPPING_OBJECT_GROUP_FILE

See Also:

Constant Field Values

Constructor Detail

ElasticsearchAccessMetadata

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

Parameters:

clusterName - cluster name

nodes - list of elasticsearch node

Throws:

VitamException - if nodes list is empty

IOException

Method Detail

deleteIndex

public final boolean deleteIndex(MetadataCollections collection,
                                 Integer tenantId)

Delete one index

Parameters:

collection - the working metadata collection

tenantId - the tenant for operation

Returns:

True if ok

addIndex

public final boolean addIndex(MetadataCollections collection,
                              Integer tenantId)

Add a type to an index

Parameters:

collection - the working metadata collection

tenantId - the tenant for operation

Returns:

True if ok

refreshIndex

public final void refreshIndex(MetadataCollections collection,
                               Integer tenantId)

refresh an index

Parameters:

collection - the workking metadata collection

tenantId - the tenant for operation

addEntryIndex

public final boolean addEntryIndex(MetadataDocument<?> document,
                                   Integer tenantId)

Add one VitamDocument to indexation immediately

Parameters:

document - the MetadataDocument for indexing

tenantId - the tenant for operation

Returns:

True if inserted in ES

addBulkEntryIndex

public final int addBulkEntryIndex(Map<String,String> indexes,
                                   Integer tenantId,
                                   MetadataDocument<?> document)

Used for iterative reload in restore operation (using bulk).

Parameters:

indexes - set of operation index

tenantId - the tenant for operation

document - the MetadataDocument for indexing

Returns:

the number of Unit incorporated (0 if none)

search

protected final Result search(MetadataCollections collection,
                              Integer tenantId,
                              String type,
                              org.elasticsearch.index.query.QueryBuilder query,
                              List<org.elasticsearch.search.sort.SortBuilder> sorts,
                              int offset,
                              Integer limit,
                              List<org.elasticsearch.search.aggregations.AggregationBuilder> facets,
                              String scrollId,
                              Integer scrollTimeout)
                       throws MetaDataExecutionException,
                              BadRequestException

Parameters:

collection -

tenantId -

type -

query - as in DSL mode "{ "fieldname" : "value" }" "{ "match" : { "fieldname" : "value" } }" "{ "ids" : { " values" : [list of id] } }"

sorts - the list of sort

facets - the list of facet

Returns:

a structure as ResultInterface

Throws:

MetaDataExecutionException

BadRequestException

basicSearch

public org.elasticsearch.action.search.SearchResponse basicSearch(MetadataCollections collection,
                                                                  Integer tenantId,
                                                                  List<org.elasticsearch.search.aggregations.AggregationBuilder> aggregations,
                                                                  org.elasticsearch.index.query.QueryBuilder query)

Makes a search request on elasticsearch on a collection with aggregations and a query

Parameters:

collection - on which the request is made

tenantId - on which the request is made

aggregations - elasticsearch

query - elasticsearch

Returns:

the elasticsearch SearchResponse

deleteEntryIndex

public final void deleteEntryIndex(MetadataCollections collections,
                                   Integer tenantId,
                                   String type,
                                   String id)
                            throws MetaDataExecutionException,
                                   MetaDataNotFoundException

Parameters:

collections - the working collection

tenantId - the tenant for operation

type - the type of document to delete

id - the id of document to delete

Throws:

MetaDataExecutionException - if query operation exception occurred

MetaDataNotFoundException - if item not found when deleting

insertFullDocument

public void insertFullDocument(MetadataCollections collection,
                               Integer tenantId,
                               String id,
                               MetadataDocument doc)
                        throws MetaDataExecutionException

Insert one element

Parameters:

collection -

tenantId -

id -

doc - full document to insert

Throws:

MetaDataExecutionException

insertFullDocuments

public void insertFullDocuments(MetadataCollections collection,
                                Integer tenantId,
                                List<? extends MetadataDocument> documents)
                         throws MetaDataExecutionException

Throws:

MetaDataExecutionException

updateFullDocument

public void updateFullDocument(MetadataCollections collection,
                               Integer tenantId,
                               String id,
                               MetadataDocument doc)
                        throws MetaDataExecutionException

Update one element fully

Parameters:

collection -

tenantId -

id -

doc - full document to update

Throws:

MetaDataExecutionException

deleteBulkOGEntriesIndexes

public boolean deleteBulkOGEntriesIndexes(List<String> ids,
                                          Integer tenantId)
                                   throws MetaDataExecutionException

deleteBulkOGEntriesIndexes

Bulk to delete entry indexes

Parameters:

ids - list of ids of OG

tenantId - the tenant for operation

Returns:

boolean true if delete ok

Throws:

MetaDataExecutionException - when delete index exception occurred

deleteBulkUnitsEntriesIndexes

public void deleteBulkUnitsEntriesIndexes(List<String> ids,
                                          Integer tenantId)
                                   throws MetaDataExecutionException

deleteBulkUnitEntriesIndexes

Bulk to delete entry indexes

Parameters:

ids - containing all Unit to be delete

tenantId - the tenant of operation

Throws:

MetaDataExecutionException - when delete exception occurred