fr.gouv.vitam.common.database.api

Interface VitamRepository

All Known Implementing Classes:

VitamElasticsearchRepository, VitamMongoRepository

public interface VitamRepository

This repository is a specification of vitam data management

Method Summary

Modifier and Type	Method and Description
com.mongodb.client.FindIterable<org.bson.Document>	findByFieldsDocuments(Map<String,String> fields, int mongoBatchSize, Integer tenant) Return iterable over document for the given collection for a specific tenant and fields
Optional<org.bson.Document>	findByIdentifier(String identifier) Find by identifier for collections cross tenant
Optional<org.bson.Document>	findByIdentifierAndTenant(String identifier, Integer tenant) find by identifier for all tenant
com.mongodb.client.FindIterable<org.bson.Document>	findDocuments(int mongoBatchSize) Return iterable over document for the given collection
com.mongodb.client.FindIterable<org.bson.Document>	findDocuments(int mongoBatchSize, Integer tenant) Return iterable over document for the given collection for a specific tenant
Optional<org.bson.Document>	getByID(String id, Integer tenant) Get vitam document by id
long	purge() Remove by tenant for collection cross-tenant
long	purge(Integer tenant) Remove by tenant for collection multi-tenant
void	remove(String id, Integer tenant) Remove document by id
void	removeByNameAndTenant(String name, Integer tenant) Remove collection by name and tenant
void	save(org.bson.Document document) Save vitam document
void	save(List<org.bson.Document> documents) Save a list of vitam documents
VitamRepositoryStatus	saveOrUpdate(org.bson.Document document) Save or updatevitam document
void	saveOrUpdate(List<org.bson.Document> documents) Save or update a list of vitam documents

Method Detail

save

void save(org.bson.Document document)
   throws DatabaseException

Save vitam document

Parameters:

document - the document to be saved

Throws:

DatabaseException - in case error with database occurs

saveOrUpdate

VitamRepositoryStatus saveOrUpdate(org.bson.Document document)
                            throws DatabaseException

Save or updatevitam document

Parameters:

document - the document to be saved

Returns:

status CREATED or UPDATED

Throws:

DatabaseException - in case error with database occurs

save

void save(List<org.bson.Document> documents)
   throws DatabaseException

Save a list of vitam documents

Parameters:

documents - the list of documents to be saved

Throws:

DatabaseException - in case error with database occurs

saveOrUpdate

void saveOrUpdate(List<org.bson.Document> documents)
           throws DatabaseException

Save or update a list of vitam documents

Parameters:

documents - the list of document to be saved orupdated

Throws:

DatabaseException - in case error with database occurs

remove

void remove(String id,
            Integer tenant)
     throws DatabaseException

Remove document by id

Parameters:

id - the id of the document to be removed

tenant - the tenant of the document to be removed

Throws:

DatabaseException - in case error with database occurs

removeByNameAndTenant

void removeByNameAndTenant(String name,
                           Integer tenant)
                    throws DatabaseException

Remove collection by name and tenant

Parameters:

name - the name of the collection to be removed

tenant - the tenant of the collection to be removed

Throws:

DatabaseException - in case error with database occurs

purge

long purge(Integer tenant)
    throws DatabaseException

Remove by tenant for collection multi-tenant

Parameters:

tenant - the tenant

Returns:

the number of deleted documents

Throws:

DatabaseException - in case error with database occurs

purge

long purge()
    throws DatabaseException

Remove by tenant for collection cross-tenant

Returns:

number of purged documents

Throws:

DatabaseException - in case error with database occurs

getByID

Optional<org.bson.Document> getByID(String id,
                                    Integer tenant)
                             throws DatabaseException

Get vitam document by id

Parameters:

id - the document id

tenant - the tenant of the document

Returns:

the document if found

Throws:

DatabaseException - in case error with database occurs

findByIdentifierAndTenant

Optional<org.bson.Document> findByIdentifierAndTenant(String identifier,
                                                      Integer tenant)
                                               throws DatabaseException

find by identifier for all tenant

Parameters:

identifier - the identifier of the document

tenant - the tenant of the document

Returns:

the document if found

Throws:

DatabaseException - in case error with database occurs

findByIdentifier

Optional<org.bson.Document> findByIdentifier(String identifier)
                                      throws DatabaseException

Find by identifier for collections cross tenant

Parameters:

identifier - the identifier of the document

Returns:

the document if found

Throws:

DatabaseException - in case error with database occurs

findDocuments

com.mongodb.client.FindIterable<org.bson.Document> findDocuments(int mongoBatchSize,
                                                                 Integer tenant)

Return iterable over document for the given collection for a specific tenant

Parameters:

mongoBatchSize - mongoBatchSize

tenant - tenant id

Returns:

iterable over document for the given collection

findByFieldsDocuments

com.mongodb.client.FindIterable<org.bson.Document> findByFieldsDocuments(Map<String,String> fields,
                                                                         int mongoBatchSize,
                                                                         Integer tenant)

Return iterable over document for the given collection for a specific tenant and fields

Parameters:

fields - list of fields for filter

mongoBatchSize - mongoBatchSize

tenant - tenant id

Returns:

iterable over document for the given collection

findDocuments

com.mongodb.client.FindIterable<org.bson.Document> findDocuments(int mongoBatchSize)

Return iterable over document for the given collection

Parameters:

mongoBatchSize - mongoBatchSize

Returns:

iterable over document for the given collection