Package | Description |
---|---|
com.azure.cosmos |
This package provides interfaces for interacting with Azure Cosmos DB.
|
com.azure.cosmos.models |
This package provides rest contracts for interacting with Azure Cosmos DB SQL APIs.
|
Class and Description |
---|
BulkExecutionOptions
Deprecated.
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed.
Please use
CosmosBulkExecutionOptions |
BulkExecutionThresholds
Deprecated.
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBulkExecutionThresholdsState
Encapsulates internal state used to dynamically determine max micro batch size for bulk operations.
It allows passing this state for one `BulkProcessingOptions` to another in case bulk operations are
expected to have similar characteristics and the context for determining the micro batch size should be preserved. |
BulkItemRequestOptions
Deprecated.
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBulkItemRequestOptions
Encapsulates options that can be specified for an operation used in Bulk execution. It can be passed while
creating bulk request using BulkOperations . |
BulkPatchItemRequestOptions
Deprecated.
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBulkPatchItemRequestOptions
Encapsulates options that can be specified for an patch operation used in Bulk execution. It can be passed while
creating bulk patch request using BulkOperations . |
BulkProcessingOptions
Deprecated.
forRemoval = true, since = "4.18"
This class is not necessary anymore and will be removed. Please use one of the following overloads instead
-
CosmosAsyncContainer.processBulkOperations(Flux)
- CosmosAsyncContainer.processBulkOperations(Flux, BulkExecutionOptions)
- CosmosContainer.processBulkOperations(Iterable)
- CosmosContainer.processBulkOperations(Iterable, BulkExecutionOptions)
and to pass in a custom context use one of the BulkOperations factory methods allowing to provide
an operation specific context
Encapsulates options for executing a bulk. This is immutable once
CosmosAsyncContainer.processBulkOperations(Flux, BulkProcessingOptions) is called, changing it will have
no affect. |
BulkProcessingThresholds
Deprecated.
forRemoval = true, since = "4.18"
This class is not necessary anymore and will be removed. Please use one of the following overloads instead
-
CosmosAsyncContainer.processBulkOperations(Flux)
- CosmosAsyncContainer.processBulkOperations(Flux, BulkExecutionOptions)
- CosmosContainer.processBulkOperations(Iterable)
- CosmosContainer.processBulkOperations(Iterable, BulkExecutionOptions)
and to pass in a custom context use one of the BulkOperations factory methods allowing to provide
an operation specific context
Encapsulates internal state used to dynamically determine max micro batch size for bulk operations.
It allows passing this state for one `BulkProcessingOptions` to another in case bulk operations are
expected to have similar characteristics and the context for determining the micro batch size should be preserved. |
ChangeFeedProcessor
Simple host for distributing change feed events across observers, simplifying the process of reading the change feeds
and distributing the processing events across multiple consumers effectively.
|
ChangeFeedProcessorBuilder
Helper class to build a
ChangeFeedProcessor instance. |
ConnectionMode
Represents the connection mode to be used by the client in the Azure Cosmos DB database service.
|
ConsistencyLevel
Represents the consistency levels supported for Azure Cosmos DB client operations in the Azure Cosmos DB service.
|
CosmosAsyncClient
Provides a client-side logical representation of the Azure Cosmos DB service.
|
CosmosAsyncClientEncryptionKey
The type Cosmos async clientEncryptionKey.
|
CosmosAsyncConflict
Read and delete conflicts
|
CosmosAsyncContainer
Provides methods for reading, deleting, and replacing existing Containers.
|
CosmosAsyncDatabase
Perform read and delete databases, update database throughput, and perform operations on child resources
|
CosmosAsyncPermission
Has methods to operate on a per-User Permission to access a specific resource
|
CosmosAsyncScripts
The type Cosmos async scripts.
|
CosmosAsyncStoredProcedure
The type Cosmos async stored procedure.
|
CosmosAsyncTrigger
The type Cosmos async trigger.
|
CosmosAsyncUser
The type Cosmos async user.
|
CosmosAsyncUserDefinedFunction
The type Cosmos async user defined function.
|
CosmosBulkItemResponse
Deprecated.
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBulkItemResponse
Response of a CosmosItemOperation request when processed using Bulk by calling
CosmosAsyncContainer.processBulkOperations(Flux, BulkProcessingOptions) . |
CosmosClient
Provides a client-side logical representation of the Azure Cosmos DB service.
|
CosmosClientBuilder
Helper class to build CosmosAsyncClient
CosmosAsyncClient and CosmosClient CosmosClient
instances as logical representation of the Azure Cosmos database service. |
CosmosClientEncryptionKey
The type Cosmos clientEncryptionKey.
|
CosmosContainer
Provides synchronous methods for reading, deleting, and replacing existing Containers
Provides methods for interacting with child resources (Items, Scripts, Conflicts)
|
CosmosDatabase
Perform read and delete databases, update database throughput, and perform operations on child resources in
a synchronous way
|
CosmosDiagnostics
This class represents response diagnostic statistics associated with a request to Azure Cosmos DB
|
CosmosItemOperation
Deprecated.
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosItemOperation |
CosmosItemOperationType
Deprecated.
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosItemOperationType |
CosmosPatchOperations
Deprecated.
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosPatchOperations
Grammar is a super set of this RFC: https://tools.ietf.org/html/rfc6902#section-4.1
Contains a list of Patch operations to be applied on an item. It is applied in an atomic manner and we support all
the operation in above RFC and more.
This can be executed in 3 ways:
1. Passing this to container in container.patchItem() which requires the id of the item to be patched, partition
key, the CosmosPatchOperations instance, any CosmosItemRequestOptions and the class type for which response will be parsed.
2. Add CosmosPatchOperations instance in TransactionalBatch using batch.patchItemOperation() which requires the id of the item
to be patched, cosmos patch instance and TransactionalBatchItemRequestOptions(if-any) and follow remaining
steps for batch for it's execution.
3. Create a bulk item using BulkOperations.getPatchItemOperation which requires the id of the item to be patched,
cosmos patch instance, partition key and BulkItemRequestOptions(if-any) and follow remaining steps to
execute bulk operations.
Let's assume this is the JSON for which we want to run patch operation.
{
a : "xyz"
b : {
c : "efg:
d : 4
e : [0, 1, 2 , 3]
}
}
|
CosmosScripts
The type Cosmos sync scripts.
|
CosmosStoredProcedure
The type Cosmos sync stored procedure.
|
CosmosTrigger
The type Cosmos sync trigger.
|
CosmosUser
The type Cosmos sync user.
|
CosmosUserDefinedFunction
The type Cosmos sync user defined function.
|
DirectConnectionConfig
Represents the connection config with
ConnectionMode.DIRECT associated with Cosmos Client in the Azure Cosmos DB database service. |
GatewayConnectionConfig
Represents the connection config with
ConnectionMode.GATEWAY associated with Cosmos Client in the Azure Cosmos DB database service. |
GlobalThroughputControlConfig
This configuration is used for throughput global control mode.
|
GlobalThroughputControlConfigBuilder
Throughput global control config builder.
|
ThrottlingRetryOptions
Encapsulates retry options in the Azure Cosmos DB database service.
|
ThroughputControlGroupConfig
Throughput control group configuration.
|
ThroughputControlGroupConfigBuilder
The throughput control group config builder.
|
TransactionalBatch
Deprecated.
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBatch
Represents a batch of operations against items with the same PartitionKey in a container that will be performed
in a transactional manner at the Azure Cosmos DB service.
Use
Example
This example atomically reads a set of items as a batch.
|
TransactionalBatchItemRequestOptions
Deprecated.
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBatchItemRequestOptions
Encapsulates options that can be specified for an operation within a TransactionalBatch . |
TransactionalBatchPatchItemRequestOptions
Deprecated.
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBatchPatchItemRequestOptions
Encapsulates options that can be specified for an operation within a TransactionalBatch . |
TransactionalBatchRequestOptions
Deprecated.
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBatchRequestOptions
Encapsulates options that can be specified for a TransactionalBatch . |
TransactionalBatchResponse
Deprecated.
forRemoval = true, since = "4.19"
This class is not necessary anymore and will be removed. Please use
CosmosBatchResponse
Response of a TransactionalBatch request. |
Class and Description |
---|
ConsistencyLevel
Represents the consistency levels supported for Azure Cosmos DB client operations in the Azure Cosmos DB service.
|
CosmosDiagnostics
This class represents response diagnostic statistics associated with a request to Azure Cosmos DB
|
Copyright © 2021 Microsoft Corporation. All rights reserved.