com.microsoft.azure.spring.data.cosmosdb.core

Class CosmosTemplate

java.lang.Object

com.microsoft.azure.spring.data.cosmosdb.core.CosmosTemplate

All Implemented Interfaces:

CosmosOperations, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class CosmosTemplate
extends Object
implements CosmosOperations, org.springframework.context.ApplicationContextAware

Field Summary

Fields

Modifier and Type	Field and Description
private com.azure.data.cosmos.CosmosClient	cosmosClient
private static String	COUNT_VALUE_KEY
private String	databaseName
private Function<Class<?>,CosmosEntityInformation<?,?>>	entityInfoCreator
private boolean	isPopulateQueryMetrics
private MappingCosmosConverter	mappingCosmosConverter
private ResponseDiagnosticsProcessor	responseDiagnosticsProcessor

Constructor Summary

Constructors

Constructor and Description
CosmosTemplate(CosmosDbFactory cosmosDbFactory, MappingCosmosConverter mappingCosmosConverter, String dbName)

Method Summary

Modifier and Type	Method and Description
private void	applyVersioning(Class<?> domainType, com.azure.data.cosmos.CosmosItemProperties cosmosItemProperties, com.azure.data.cosmos.CosmosItemRequestOptions options)
private void	assertValidId(Object id)
<T> long	count(DocumentQuery query, Class<T> domainType, String containerName)
long	count(String containerName)
com.azure.data.cosmos.CosmosContainerProperties	createCollectionIfNotExists(CosmosEntityInformation<?,?> information) Use createContainerIfNotExists() instead
com.azure.data.cosmos.CosmosContainerProperties	createContainerIfNotExists(CosmosEntityInformation<?,?> information)
<T> List<T>	delete(DocumentQuery query, Class<T> domainType, String containerName) Delete the DocumentQuery, need to query the domains at first, then delete the item from the result.
void	deleteAll(String containerName, Class<?> domainType)
void	deleteById(String containerName, Object id, com.azure.data.cosmos.PartitionKey partitionKey)
void	deleteCollection(String containerName) Use deleteContainer() instead
void	deleteContainer(String containerName)
private com.azure.data.cosmos.CosmosItemResponse	deleteItem(com.azure.data.cosmos.CosmosItemProperties cosmosItemProperties, List<String> partitionKeyNames, String containerName, Class<?> domainType)
private reactor.core.publisher.Flux<com.azure.data.cosmos.FeedResponse<com.azure.data.cosmos.CosmosItemProperties>>	executeQuery(com.azure.data.cosmos.SqlQuerySpec sqlQuerySpec, String containerName, com.azure.data.cosmos.FeedOptions options)
<T> Boolean	exists(DocumentQuery query, Class<T> domainType, String containerName)
<T> List<T>	find(DocumentQuery query, Class<T> domainType, String containerName)
<T> List<T>	findAll(Class<T> domainType)
<T> org.springframework.data.domain.Page<T>	findAll(org.springframework.data.domain.Pageable pageable, Class<T> domainType, String containerName)
<T> List<T>	findAll(com.azure.data.cosmos.PartitionKey partitionKey, Class<T> domainType)
<T> List<T>	findAll(String containerName, Class<T> domainType)
<T> T	findById(Object id, Class<T> domainType)
<T> T	findById(Object id, Class<T> domainType, com.azure.data.cosmos.PartitionKey partitionKey)
<T> T	findById(String containerName, Object id, Class<T> domainType)
<T,ID> List<T>	findByIds(Iterable<ID> ids, Class<T> domainType, String containerName)
private List<com.azure.data.cosmos.CosmosItemProperties>	findItems(DocumentQuery query, Class<?> domainType, String containerName)
String	getCollectionName(Class<?> domainType) Use getContainerName() instead
String	getContainerName(Class<?> domainType)
MappingCosmosConverter	getConverter()
private CosmosEntityInformation<?,?>	getCosmosEntityInformation(Class<?> domainType)
private Long	getCountValue(DocumentQuery query, boolean isCrossPartitionQuery, String containerName)
private List<String>	getPartitionKeyNames(Class<?> domainType)
<T> T	insert(String containerName, T objectToSave, com.azure.data.cosmos.PartitionKey partitionKey)
<T> T	insert(T objectToSave, com.azure.data.cosmos.PartitionKey partitionKey)
<T> org.springframework.data.domain.Page<T>	paginationQuery(DocumentQuery query, Class<T> domainType, String containerName)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
private <T> T	toDomainObject(Class<T> domainType, com.azure.data.cosmos.CosmosItemProperties cosmosItemProperties)
<T> void	upsert(String containerName, T object, com.azure.data.cosmos.PartitionKey partitionKey)
<T> void	upsert(T object, com.azure.data.cosmos.PartitionKey partitionKey)
<T> T	upsertAndReturnEntity(String containerName, T object, com.azure.data.cosmos.PartitionKey partitionKey)

Methods inherited from class java.lang.Object

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

Field Detail

COUNT_VALUE_KEY

private static final String COUNT_VALUE_KEY

See Also:

Constant Field Values

mappingCosmosConverter

private final MappingCosmosConverter mappingCosmosConverter

databaseName

private final String databaseName

responseDiagnosticsProcessor

private final ResponseDiagnosticsProcessor responseDiagnosticsProcessor

isPopulateQueryMetrics

private final boolean isPopulateQueryMetrics

cosmosClient

private final com.azure.data.cosmos.CosmosClient cosmosClient

entityInfoCreator

private Function<Class<?>,CosmosEntityInformation<?,?>> entityInfoCreator

Constructor Detail

CosmosTemplate

public CosmosTemplate(CosmosDbFactory cosmosDbFactory,
                      MappingCosmosConverter mappingCosmosConverter,
                      String dbName)

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

insert

public <T> T insert(T objectToSave,
                    com.azure.data.cosmos.PartitionKey partitionKey)

Specified by:

insert in interface CosmosOperations

insert

public <T> T insert(String containerName,
                    T objectToSave,
                    com.azure.data.cosmos.PartitionKey partitionKey)

Specified by:

insert in interface CosmosOperations

findById

public <T> T findById(Object id,
                      Class<T> domainType)

Specified by:

findById in interface CosmosOperations

findById

public <T> T findById(Object id,
                      Class<T> domainType,
                      com.azure.data.cosmos.PartitionKey partitionKey)

Specified by:

findById in interface CosmosOperations

findById

public <T> T findById(String containerName,
                      Object id,
                      Class<T> domainType)

Specified by:

findById in interface CosmosOperations

upsert

public <T> void upsert(T object,
                       com.azure.data.cosmos.PartitionKey partitionKey)

Specified by:

upsert in interface CosmosOperations

upsert

public <T> void upsert(String containerName,
                       T object,
                       com.azure.data.cosmos.PartitionKey partitionKey)

Specified by:

upsert in interface CosmosOperations

upsertAndReturnEntity

public <T> T upsertAndReturnEntity(String containerName,
                                   T object,
                                   com.azure.data.cosmos.PartitionKey partitionKey)

Specified by:

upsertAndReturnEntity in interface CosmosOperations

findAll

public <T> List<T> findAll(Class<T> domainType)

Specified by:

findAll in interface CosmosOperations

findAll

public <T> List<T> findAll(String containerName,
                           Class<T> domainType)

Specified by:

findAll in interface CosmosOperations

findAll

public <T> List<T> findAll(com.azure.data.cosmos.PartitionKey partitionKey,
                           Class<T> domainType)

Specified by:

findAll in interface CosmosOperations

deleteAll

public void deleteAll(@NonNull
                      String containerName,
                      @NonNull
                      Class<?> domainType)

Specified by:

deleteAll in interface CosmosOperations

deleteCollection

public void deleteCollection(@NonNull
                             String containerName)

Description copied from interface: CosmosOperations

Use deleteContainer() instead

Specified by:

deleteCollection in interface CosmosOperations

Parameters:

containerName - container name

deleteContainer

public void deleteContainer(@NonNull
                            String containerName)

Specified by:

deleteContainer in interface CosmosOperations

getCollectionName

public String getCollectionName(Class<?> domainType)

Description copied from interface: CosmosOperations

Use getContainerName() instead

Specified by:

getCollectionName in interface CosmosOperations

Parameters:

domainType - class type

Returns:

container name

getContainerName

public String getContainerName(Class<?> domainType)

Specified by:

getContainerName in interface CosmosOperations

createCollectionIfNotExists

public com.azure.data.cosmos.CosmosContainerProperties createCollectionIfNotExists(@NonNull
                                                                                   CosmosEntityInformation<?,?> information)

Description copied from interface: CosmosOperations

Use createContainerIfNotExists() instead

Specified by:

createCollectionIfNotExists in interface CosmosOperations

Parameters:

information - cosmos entity information

Returns:

created container properties

createContainerIfNotExists

public com.azure.data.cosmos.CosmosContainerProperties createContainerIfNotExists(CosmosEntityInformation<?,?> information)

Specified by:

createContainerIfNotExists in interface CosmosOperations

deleteById

public void deleteById(String containerName,
                       Object id,
                       com.azure.data.cosmos.PartitionKey partitionKey)

Specified by:

deleteById in interface CosmosOperations

findByIds

public <T,ID> List<T> findByIds(Iterable<ID> ids,
                                Class<T> domainType,
                                String containerName)

Specified by:

findByIds in interface CosmosOperations

find

public <T> List<T> find(@NonNull
                        DocumentQuery query,
                        @NonNull
                        Class<T> domainType,
                        String containerName)

Specified by:

find in interface CosmosOperations

exists

public <T> Boolean exists(@NonNull
                          DocumentQuery query,
                          @NonNull
                          Class<T> domainType,
                          String containerName)

Specified by:

exists in interface CosmosOperations

delete

public <T> List<T> delete(@NonNull
                          DocumentQuery query,
                          @NonNull
                          Class<T> domainType,
                          @NonNull
                          String containerName)

Delete the DocumentQuery, need to query the domains at first, then delete the item from the result. The cosmosdb Sql API do _NOT_ support DELETE query, we cannot add one DeleteQueryGenerator.

Specified by:

delete in interface CosmosOperations

Type Parameters:

T -

Parameters:

query - The representation for query method.

domainType - Class of domain

containerName - Container name of database

Returns:

All the deleted items as List.

findAll

public <T> org.springframework.data.domain.Page<T> findAll(org.springframework.data.domain.Pageable pageable,
                                                           Class<T> domainType,
                                                           String containerName)

Specified by:

findAll in interface CosmosOperations

paginationQuery

public <T> org.springframework.data.domain.Page<T> paginationQuery(DocumentQuery query,
                                                                   Class<T> domainType,
                                                                   String containerName)

Specified by:

paginationQuery in interface CosmosOperations

count

public long count(String containerName)

Specified by:

count in interface CosmosOperations

count

public <T> long count(DocumentQuery query,
                      Class<T> domainType,
                      String containerName)

Specified by:

count in interface CosmosOperations

getConverter

public MappingCosmosConverter getConverter()

Specified by:

getConverter in interface CosmosOperations

getCountValue

private Long getCountValue(DocumentQuery query,
                           boolean isCrossPartitionQuery,
                           String containerName)

executeQuery

private reactor.core.publisher.Flux<com.azure.data.cosmos.FeedResponse<com.azure.data.cosmos.CosmosItemProperties>> executeQuery(com.azure.data.cosmos.SqlQuerySpec sqlQuerySpec,
                                                                                                                                 String containerName,
                                                                                                                                 com.azure.data.cosmos.FeedOptions options)

getPartitionKeyNames

private List<String> getPartitionKeyNames(Class<?> domainType)

assertValidId

private void assertValidId(Object id)

findItems

private List<com.azure.data.cosmos.CosmosItemProperties> findItems(@NonNull
                                                                   DocumentQuery query,
                                                                   @NonNull
                                                                   Class<?> domainType,
                                                                   @NonNull
                                                                   String containerName)

deleteItem

private com.azure.data.cosmos.CosmosItemResponse deleteItem(@NonNull
                                                            com.azure.data.cosmos.CosmosItemProperties cosmosItemProperties,
                                                            @NonNull
                                                            List<String> partitionKeyNames,
                                                            String containerName,
                                                            @NonNull
                                                            Class<?> domainType)

toDomainObject

private <T> T toDomainObject(@NonNull
                             Class<T> domainType,
                             com.azure.data.cosmos.CosmosItemProperties cosmosItemProperties)

applyVersioning

private void applyVersioning(Class<?> domainType,
                             com.azure.data.cosmos.CosmosItemProperties cosmosItemProperties,
                             com.azure.data.cosmos.CosmosItemRequestOptions options)

getCosmosEntityInformation

private CosmosEntityInformation<?,?> getCosmosEntityInformation(Class<?> domainType)