diff --git a/sdk/cosmos/azure-cosmos/CHANGELOG.md b/sdk/cosmos/azure-cosmos/CHANGELOG.md index 8a5296ca920c..169f35308d56 100644 --- a/sdk/cosmos/azure-cosmos/CHANGELOG.md +++ b/sdk/cosmos/azure-cosmos/CHANGELOG.md @@ -1,14 +1,9 @@ ## Release History -### 4.4.0b3 (Unreleased) +### 4.4.0 (2023-06-09) #### Features Added - -#### Breaking Changes - -#### Bugs Fixed - -#### Other Changes +- GA release of Patch API and Delete All Items By Partition Key ### 4.4.0b2 (2023-05-22) @@ -24,7 +19,7 @@ ### 4.4.0b1 (2023-04-11) #### Features Added - - Added **preview** delete all items by partition key functionality. See [PR 29186](https://github.com/Azure/azure-sdk-for-python/pull/29186). + - Added **preview** delete all items by partition key functionality. See [PR 29186](https://github.com/Azure/azure-sdk-for-python/pull/29186). For more information on Partition Key Delete, please see [Azure Cosmos DB Partition Key Delete](https://learn.microsoft.com/azure/cosmos-db/nosql/how-to-delete-by-partition-key?tabs=python-example). - Added **preview** partial document update (Patch API) functionality and container methods for patching items with operations. See [PR 29497](https://github.com/Azure/azure-sdk-for-python/pull/29497). For more information on Patch, please see [Azure Cosmos DB Partial Document Update](https://learn.microsoft.com/azure/cosmos-db/partial-document-update). #### Bugs Fixed diff --git a/sdk/cosmos/azure-cosmos/azure/cosmos/_version.py b/sdk/cosmos/azure-cosmos/azure/cosmos/_version.py index fafa0b68437c..c68cff03b8a2 100644 --- a/sdk/cosmos/azure-cosmos/azure/cosmos/_version.py +++ b/sdk/cosmos/azure-cosmos/azure/cosmos/_version.py @@ -19,4 +19,4 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. -VERSION = "4.4.0b3" +VERSION = "4.4.0" diff --git a/sdk/cosmos/azure-cosmos/azure/cosmos/aio/_container.py b/sdk/cosmos/azure-cosmos/azure/cosmos/aio/_container.py index 1bd5c8e24310..48582f1da1c7 100644 --- a/sdk/cosmos/azure-cosmos/azure/cosmos/aio/_container.py +++ b/sdk/cosmos/azure-cosmos/azure/cosmos/aio/_container.py @@ -545,7 +545,6 @@ async def patch_item( :keyword str pre_trigger_include: trigger id to be used as pre operation trigger. :keyword str post_trigger_include: trigger id to be used as post operation trigger. :keyword str session_token: Token for use with Session consistency. - :keyword dict[str,str] initial_headers: Initial headers to be sent as part of the request. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. @@ -815,11 +814,21 @@ async def delete_all_items_by_partition_key( partition_key: Union[str, int, float, bool], **kwargs: Any ) -> None: - """Exposes an API to delete all items with a single partition key without the user having - to explicitly call delete on each record in the partition key. + """The delete by partition key feature is an asynchronous, background operation that allows you to delete all + documents with the same logical partition key value, using the Cosmos SDK. The delete by partition key + operation is constrained to consume at most 10% of the total + available RU/s on the container each second. This helps in limiting the resources used by + this background task. :param partition_key: Partition key for the items to be deleted. :type partition_key: Any + :keyword str pre_trigger_include: trigger id to be used as pre operation trigger. + :keyword str post_trigger_include: trigger id to be used as post operation trigger. + :keyword str session_token: Token for use with Session consistency. + :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource + has changed, and act according to the condition specified by the `match_condition` parameter. + :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. + :keyword Callable response_hook: A callable invoked with the response metadata. :rtype: None """ request_options = _build_options(kwargs) diff --git a/sdk/cosmos/azure-cosmos/azure/cosmos/container.py b/sdk/cosmos/azure-cosmos/azure/cosmos/container.py index 4d5a14d12cc8..39d8be8f7ca4 100644 --- a/sdk/cosmos/azure-cosmos/azure/cosmos/container.py +++ b/sdk/cosmos/azure-cosmos/azure/cosmos/container.py @@ -593,7 +593,6 @@ def patch_item( :keyword str pre_trigger_include: trigger id to be used as pre operation trigger. :keyword str post_trigger_include: trigger id to be used as post operation trigger. :keyword str session_token: Token for use with Session consistency. - :keyword dict[str,str] initial_headers: Initial headers to be sent as part of the request. :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the `match_condition` parameter. :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. @@ -870,11 +869,21 @@ def delete_all_items_by_partition_key( partition_key: Union[str, int, float, bool], **kwargs: Any ) -> None: - """Exposes an API to delete all items with a single partition key without the user having - to explicitly call delete on each record in the partition key. + """The delete by partition key feature is an asynchronous, background operation that allows you to delete all + documents with the same logical partition key value, using the Cosmos SDK. The delete by partition key + operation is constrained to consume at most 10% of the total + available RU/s on the container each second. This helps in limiting the resources used by + this background task. :param partition_key: Partition key for the items to be deleted. :type partition_key: Any + :keyword str pre_trigger_include: trigger id to be used as pre operation trigger. + :keyword str post_trigger_include: trigger id to be used as post operation trigger. + :keyword str session_token: Token for use with Session consistency. + :keyword str etag: An ETag value, or the wildcard character (*). Used to check if the resource + has changed, and act according to the condition specified by the `match_condition` parameter. + :keyword ~azure.core.MatchConditions match_condition: The match condition to use upon the etag. + :keyword Callable response_hook: A callable invoked with the response metadata. :rtype: None """ request_options = build_options(kwargs)