Uses of Class
com.azure.cosmos.models.PartitionKey

Packages that use PartitionKey

Package	Description
com.azure.cosmos	This package provides interfaces for interacting with Azure Cosmos DB.
com.azure.cosmos.encryption	This package provides Encryption interfaces for interacting with Azure Cosmos DB.
com.azure.cosmos.models	This package provides rest contracts for interacting with Azure Cosmos DB SQL APIs.
com.azure.spring.data.cosmos.core	This package contains the core classes of cosmos db, includes converters, query generators and mapping to cosmos entities
com.azure.spring.data.cosmos.repository	This package contains the support, query and config classes of setting up cosmosdb repositories
com.azure.spring.data.cosmos.repository.support	This package contains the support classes of setting up cosmosdb repositories and factories

Uses of PartitionKey in com.azure.cosmos

Methods in com.azure.cosmos with parameters of type PartitionKey

Modifier and Type	Method	Description
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.createItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options)	Creates an item.
<T> CosmosItemResponse<T>	CosmosContainer.createItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options)	Creates a new item synchronously and returns its respective Cosmos item response while specifying additional options.
Mono<CosmosItemResponse<Object>>	CosmosAsyncContainer.deleteAllItemsByPartitionKey(PartitionKey partitionKey, CosmosItemRequestOptions options)	Deletes all items in the Container with the specified partitionKey value.
CosmosItemResponse<Object>	CosmosContainer.deleteAllItemsByPartitionKey(PartitionKey partitionKey, CosmosItemRequestOptions options)	Deletes all items in the Container with the specified partitionKey value.
Mono<CosmosItemResponse<Object>>	CosmosAsyncContainer.deleteItem(String itemId, PartitionKey partitionKey)	Deletes an item.
Mono<CosmosItemResponse<Object>>	CosmosAsyncContainer.deleteItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options)	Deletes the item.
CosmosItemResponse<Object>	CosmosContainer.deleteItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options)	Deletes an item in the current container.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosPatchItemRequestOptions options, Class<T> itemType)	Run patch operations on an Item.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, Class<T> itemType)	Run patch operations on an Item.
<T> CosmosItemResponse<T>	CosmosContainer.patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosPatchItemRequestOptions options, Class<T> itemType)	Run patch operations on an Item.
<T> CosmosItemResponse<T>	CosmosContainer.patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, Class<T> itemType)	Run patch operations on an Item.
<T> CosmosPagedFlux<T>	CosmosAsyncContainer.readAllItems(PartitionKey partitionKey, CosmosQueryRequestOptions options, Class<T> classType)	Reads all the items of a logical partition
<T> CosmosPagedFlux<T>	CosmosAsyncContainer.readAllItems(PartitionKey partitionKey, Class<T> classType)	Reads all the items of a logical partition
<T> CosmosPagedIterable<T>	CosmosContainer.readAllItems(PartitionKey partitionKey, CosmosQueryRequestOptions options, Class<T> classType)	Reads all the items of a logical partition returning the results as CosmosPagedIterable.
<T> CosmosPagedIterable<T>	CosmosContainer.readAllItems(PartitionKey partitionKey, Class<T> classType)	Reads all the items of a logical partition returning the results as CosmosPagedIterable.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.readItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options, Class<T> itemType)	Reads an item using a configured CosmosItemRequestOptions.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.readItem(String itemId, PartitionKey partitionKey, Class<T> itemType)	Reads an item.
<T> CosmosItemResponse<T>	CosmosContainer.readItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options, Class<T> itemType)	Reads an item in the current container while specifying additional options.
<T> CosmosItemResponse<T>	CosmosContainer.readItem(String itemId, PartitionKey partitionKey, Class<T> itemType)	Reads an item in the current container.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.replaceItem(T item, String itemId, PartitionKey partitionKey)	Replaces an item with the passed in item.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.replaceItem(T item, String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options)	Replaces an item with the passed in item.
<T> CosmosItemResponse<T>	CosmosContainer.replaceItem(T item, String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options)	Replaces an item in the current container.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.upsertItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options)	Upserts an item.
<T> CosmosItemResponse<T>	CosmosContainer.upsertItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options)	Upserts a item Cosmos sync item while specifying additional options.

Uses of PartitionKey in com.azure.cosmos.encryption

Methods in com.azure.cosmos.encryption with parameters of type PartitionKey

Modifier and Type	Method	Description
<T> Mono<CosmosItemResponse<T>>	CosmosEncryptionAsyncContainer.createItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)	Creates an item.
<T> CosmosItemResponse<T>	CosmosEncryptionContainer.createItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)	Creates a new item synchronously and returns its respective Cosmos item response while specifying additional options.
Mono<CosmosItemResponse<Object>>	CosmosEncryptionAsyncContainer.deleteItem(String itemId, PartitionKey partitionKey)	Deletes an item.
Mono<CosmosItemResponse<Object>>	CosmosEncryptionAsyncContainer.deleteItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)	Deletes the item.
CosmosItemResponse<Object>	CosmosEncryptionContainer.deleteItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)	Deletes an item in the current container.
<T> Mono<CosmosItemResponse<T>>	CosmosEncryptionAsyncContainer.patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosPatchItemRequestOptions options, Class<T> itemType)	Run patch operations on an Item.
<T> CosmosItemResponse<T>	CosmosEncryptionContainer.patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosPatchItemRequestOptions options, Class<T> itemType)	Run patch operations on an Item.
<T> Mono<CosmosItemResponse<T>>	CosmosEncryptionAsyncContainer.readItem(String id, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions, Class<T> classType)	Reads an item using a configured CosmosItemRequestOptions.
<T> Mono<CosmosItemResponse<T>>	CosmosEncryptionAsyncContainer.readItem(String id, PartitionKey partitionKey, Class<T> classType)	Reads an item.
<T> CosmosItemResponse<T>	CosmosEncryptionContainer.readItem(String id, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions, Class<T> classType)	Reads an item in the current container while specifying additional options.
<T> CosmosItemResponse<T>	CosmosEncryptionContainer.readItem(String id, PartitionKey partitionKey, Class<T> classType)	Reads an item in the current container.
<T> Mono<CosmosItemResponse<T>>	CosmosEncryptionAsyncContainer.replaceItem(T item, String itemId, PartitionKey partitionKey)	Replaces an item with the passed in item and encrypts the requested fields.
<T> Mono<CosmosItemResponse<T>>	CosmosEncryptionAsyncContainer.replaceItem(T item, String itemId, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)	Replaces an item with the passed in item and encrypts the requested fields.
<T> CosmosItemResponse<T>	CosmosEncryptionContainer.replaceItem(T item, String itemId, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)	Replaces an item in the current container.
<T> Mono<CosmosItemResponse<T>>	CosmosEncryptionAsyncContainer.upsertItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)	Upserts an item.
<T> CosmosItemResponse<T>	CosmosEncryptionContainer.upsertItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)	Upserts a item Cosmos sync item while specifying additional options.

Uses of PartitionKey in com.azure.cosmos.models

Fields in com.azure.cosmos.models declared as PartitionKey

Modifier and Type	Field	Description
static final PartitionKey	PartitionKey.NONE	Partition key that represents no partition key.

Methods in com.azure.cosmos.models that return PartitionKey

Modifier and Type	Method	Description
PartitionKey	PartitionKeyBuilder.build()	Builds a new instance of the type PartitionKey with the specified Partition Key values.
PartitionKey	CosmosConflictRequestOptions.getPartitionKey()	Gets the partition key associated with the request in the Azure Cosmos DB service.
PartitionKey	CosmosItemIdentity.getPartitionKey()	Gets the partition key
PartitionKey	CosmosQueryRequestOptions.getPartitionKey()	Gets the partition key used to identify the current request's target partition.
PartitionKey	CosmosStoredProcedureRequestOptions.getPartitionKey()	Gets the partition key used to identify the current request's target partition.
PartitionKey	CosmosBatch.getPartitionKeyValue()	Return the partition key for this batch.
PartitionKey	CosmosItemOperation.getPartitionKeyValue()
PartitionKey	CosmosPermissionProperties.getResourcePartitionKey()	Gets the resource partition key associated with this permission object.

Methods in com.azure.cosmos.models with parameters of type PartitionKey

Modifier and Type	Method	Description
static CosmosBatch	CosmosBatch.createCosmosBatch(PartitionKey partitionKey)	Initializes a new instance of CosmosBatch that will contain operations to be performed across multiple items in the container with the provided partition key in a transactional manner
static FeedRange	FeedRange.forLogicalPartition(PartitionKey partitionKey)	Creates a range for a certain logical partition
static <T> CosmosItemOperation	CosmosBulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey)	Instantiate an operation for Creating item in Bulk execution.
static <T> CosmosItemOperation	CosmosBulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)	Instantiate an operation for Creating item in Bulk execution.
static <T, TContext> CosmosItemOperation	CosmosBulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)	Instantiate an operation for Creating item in Bulk execution.
static <T, TContext> CosmosItemOperation	CosmosBulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey, TContext context)	Instantiate an operation for Creating item in Bulk execution.
static CosmosItemOperation	CosmosBulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey)	Instantiate an operation for deleting item in Bulk execution.
static CosmosItemOperation	CosmosBulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)	Instantiate an operation for deleting item in Bulk execution.
static <TContext> CosmosItemOperation	CosmosBulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)	Instantiate an operation for deleting item in Bulk execution.
static <TContext> CosmosItemOperation	CosmosBulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey, TContext context)	Instantiate an operation for deleting item in Bulk execution.
static CosmosItemOperation	CosmosBulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations)	Instantiate an operation for a patch in Bulk execution.
static CosmosItemOperation	CosmosBulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosBulkPatchItemRequestOptions requestOptions)	Instantiate an operation for a patch in Bulk execution.
static <TContext> CosmosItemOperation	CosmosBulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosBulkPatchItemRequestOptions requestOptions, TContext context)	Instantiate an operation for a patch in Bulk execution.
static <TContext> CosmosItemOperation	CosmosBulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, TContext context)	Instantiate an operation for a patch in Bulk execution.
static CosmosItemOperation	CosmosBulkOperations.getReadItemOperation(String id, PartitionKey partitionKey)	Instantiate an operation for read item in Bulk execution.
static CosmosItemOperation	CosmosBulkOperations.getReadItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)	Instantiate an operation for read item in Bulk execution.
static <TContext> CosmosItemOperation	CosmosBulkOperations.getReadItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)	Instantiate an operation for read item in Bulk execution.
static <TContext> CosmosItemOperation	CosmosBulkOperations.getReadItemOperation(String id, PartitionKey partitionKey, TContext context)	Instantiate an operation for read item in Bulk execution.
static <T> CosmosItemOperation	CosmosBulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey)	Instantiate an operation for replace item in Bulk execution.
static <T> CosmosItemOperation	CosmosBulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)	Instantiate an operation for replace item in Bulk execution.
static <T, TContext> CosmosItemOperation	CosmosBulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)	Instantiate an operation for replace item in Bulk execution.
static <T, TContext> CosmosItemOperation	CosmosBulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey, TContext context)	Instantiate an operation for replace item in Bulk execution.
static <T> CosmosItemOperation	CosmosBulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey)	Instantiate an operation for upsert item in Bulk execution.
static <T> CosmosItemOperation	CosmosBulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)	Instantiate an operation for upsert item in Bulk execution.
static <T, TContext> CosmosItemOperation	CosmosBulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)	Instantiate an operation for upsert item in Bulk execution.
static <T, TContext> CosmosItemOperation	CosmosBulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey, TContext context)	Instantiate an operation for upsert item in Bulk execution.
CosmosConflictRequestOptions	CosmosConflictRequestOptions.setPartitionKey(PartitionKey partitionKey)	Sets the partition key associated with the request in the Azure Cosmos DB service.
CosmosQueryRequestOptions	CosmosQueryRequestOptions.setPartitionKey(PartitionKey partitionkey)	Sets the partition key used to identify the current request's target partition.
CosmosStoredProcedureRequestOptions	CosmosStoredProcedureRequestOptions.setPartitionKey(PartitionKey partitionKey)	Sets the partition key used to identify the current request's target partition.
CosmosPermissionProperties	CosmosPermissionProperties.setResourcePartitionKey(PartitionKey partitionKey)	Sets the resource partition key associated with this permission object.

Constructors in com.azure.cosmos.models with parameters of type PartitionKey

Modifier	Constructor	Description
	CosmosConflictRequestOptions(PartitionKey partitionKey)	Creates a new CosmosConflictRequestOptions object.
	CosmosItemIdentity(PartitionKey partitionKey, String id)	Instantiates an instance of the CosmosItemIdentity class

Uses of PartitionKey in com.azure.spring.data.cosmos.core

Methods in com.azure.spring.data.cosmos.core with parameters of type PartitionKey

Modifier and Type	Method	Description
void	CosmosOperations.deleteById(String containerName, Object id, PartitionKey partitionKey)	Delete an item by id
void	CosmosTemplate.deleteById(String containerName, Object id, PartitionKey partitionKey)	Deletes the item by id and partition key.
Mono<Void>	ReactiveCosmosOperations.deleteById(String containerName, Object id, PartitionKey partitionKey)	Delete an item by id
Mono<Void>	ReactiveCosmosTemplate.deleteById(String containerName, Object id, PartitionKey partitionKey)	Deletes the item with id and partition key.
<T> Iterable<T>	CosmosOperations.findAll(PartitionKey partitionKey, Class<T> domainType)	Find the DocumentQuery, find all the items specified by domain type in the given container.
<T> Iterable<T>	CosmosTemplate.findAll(PartitionKey partitionKey, Class<T> domainType)
<T> Flux<T>	ReactiveCosmosOperations.findAll(PartitionKey partitionKey, Class<T> domainType)	Find all items in a given container with partition key
<T> Flux<T>	ReactiveCosmosTemplate.findAll(PartitionKey partitionKey, Class<T> domainType)
<T> T	CosmosOperations.findById(Object id, Class<T> domainType, PartitionKey partitionKey)	Finds item by id
<T> T	CosmosTemplate.findById(Object id, Class<T> domainType, PartitionKey partitionKey)
<T> Mono<T>	ReactiveCosmosOperations.findById(Object id, Class<T> domainType, PartitionKey partitionKey)	Find by id
<T> Mono<T>	ReactiveCosmosTemplate.findById(Object id, Class<T> domainType, PartitionKey partitionKey)	Find by id
<T> T	CosmosOperations.insert(String containerName, T objectToSave, PartitionKey partitionKey)	Inserts item
<T> T	CosmosOperations.insert(T objectToSave, PartitionKey partitionKey)	Inserts item
<T> T	CosmosTemplate.insert(String containerName, T objectToSave, PartitionKey partitionKey)	Inserts item into the given container
<T> T	CosmosTemplate.insert(T objectToSave, PartitionKey partitionKey)	Inserts item
<T> Mono<T>	ReactiveCosmosOperations.insert(String containerName, T objectToSave, PartitionKey partitionKey)	Insert
<T> Mono<T>	ReactiveCosmosOperations.insert(T objectToSave, PartitionKey partitionKey)	Insert
<T> Mono<T>	ReactiveCosmosTemplate.insert(String containerName, T objectToSave, PartitionKey partitionKey)	Insert
<T> Mono<T>	ReactiveCosmosTemplate.insert(T objectToSave, PartitionKey partitionKey)	Insert

Uses of PartitionKey in com.azure.spring.data.cosmos.repository

Methods in com.azure.spring.data.cosmos.repository with parameters of type PartitionKey

Modifier and Type	Method	Description
void	CosmosRepository.deleteById(ID id, PartitionKey partitionKey)	Deletes an entity by its id and partition key.
Mono<Void>	ReactiveCosmosRepository.deleteById(K id, PartitionKey partitionKey)	Deletes an entity by its id and partition key.
Iterable<T>	CosmosRepository.findAll(PartitionKey partitionKey)	Returns list of items in a specific partition
Flux<T>	ReactiveCosmosRepository.findAll(PartitionKey partitionKey)	Returns Flux of items in a specific partition
Optional<T>	CosmosRepository.findById(ID id, PartitionKey partitionKey)	Retrieves an entity by its id.
Mono<T>	ReactiveCosmosRepository.findById(K id, PartitionKey partitionKey)	Retrieves an entity by its id and partition key.

Uses of PartitionKey in com.azure.spring.data.cosmos.repository.support

Methods in com.azure.spring.data.cosmos.repository.support with parameters of type PartitionKey

Modifier and Type	Method	Description
void	SimpleCosmosRepository.deleteById(ID id, PartitionKey partitionKey)
Mono<Void>	SimpleReactiveCosmosRepository.deleteById(K id, PartitionKey partitionKey)
Iterable<T>	SimpleCosmosRepository.findAll(PartitionKey partitionKey)
Flux<T>	SimpleReactiveCosmosRepository.findAll(PartitionKey partitionKey)
Optional<T>	SimpleCosmosRepository.findById(ID id, PartitionKey partitionKey)
Mono<T>	SimpleReactiveCosmosRepository.findById(K id, PartitionKey partitionKey)