[Cosmos] Hash v1 Key Error Hotfix #41639
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…umber in partition key definition. Some legacy hash v1 containers don't always provide version number for partition key defintion which results in some key error exceptions. This fixes that by allowing a dictionary or PartitionKey instanced to be passed into the constructor of PartitionKeys, when done that way if no version number is available, we default the value to 1.
There was a problem hiding this comment.
Pull Request Overview
This PR provides a hotfix for legacy Cosmos DB hash v1 containers that may omit the version field in their partition key definition. Key changes include:
- Extending
PartitionKeyto accept a dict orPartitionKeyinstance and default missingversionto 1 - Replacing explicit
PartitionKey(path, kind, version)calls with the new dict overload throughout sync and async code paths - Adding sync and async tests to validate behavior when
versionis missing
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| azure/cosmos/partition_key.py | Added overload to __init__ to accept dict definitions and default version = 1 |
| azure/cosmos/container.py | Updated get_partition_key_from_properties to use new overload |
| azure/cosmos/aio/* | Simplified all explicit PartitionKey(...) instantiations to use dict overload |
| tests/test_changefeed_partition_key_variation.py | Added new sync test for missing version in partition definition |
| tests/test_changefeed_partition_key_variation_async.py | Added new async test for missing version in partition definition |
| CHANGELOG.md | Documented bug fix for missing version in legacy v1 PK definitions |
sdk/cosmos/azure-cosmos/tests/test_changefeed_partition_key_variation_async.py
Show resolved
Hide resolved
sdk/cosmos/azure-cosmos/tests/test_changefeed_partition_key_variation.py
Show resolved
Hide resolved
API Change CheckAPIView identified API level changes in this PR and created the following API reviews |
tvaron3
reviewed
Jun 18, 2025
sdk/cosmos/azure-cosmos/azure/cosmos/_cosmos_client_connection.py
Outdated
Show resolved
Hide resolved
sdk/cosmos/azure-cosmos/tests/test_changefeed_partition_key_variation.py
Show resolved
Hide resolved
Pilchie
reviewed
Jun 18, 2025
kushagraThapar
requested changes
Jun 18, 2025
kushagraThapar
approved these changes
Jun 18, 2025
xinlian12
reviewed
Jun 18, 2025
sdk/cosmos/azure-cosmos/tests/test_changefeed_partition_key_variation.py
Show resolved
Hide resolved
xinlian12
approved these changes
Jun 18, 2025
|
/azp run python - cosmos - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run python - cosmos - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/check-enforcer override CI has previously passed, latest commit is updating version |
kushagraThapar
approved these changes
Jun 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes issue related to hash v1 containers not always having version number in partition key definition.
Some legacy hash v1 containers don't always provide version number for partition key definition which results in some key error exceptions. This fixes that by allowing a dictionary or PartitionKey instanced to be passed into a helper method of PartitionKey that will return a Partitionkey from the passed in partition key definition, when done that way if no version number is available, we default the value to 1.