Fix: Allow tuples to be used for hierarchical partition key values.#38136
Merged
bambriz merged 15 commits intoAzure:mainfrom Nov 12, 2024
Merged
Fix: Allow tuples to be used for hierarchical partition key values.#38136bambriz merged 15 commits intoAzure:mainfrom
bambriz merged 15 commits intoAzure:mainfrom
Conversation
Allows the usage of tuples alongside lists to be used for hierarchical partition key values. Both get serialized to json arrays. Previous behaviour would give an error that a prefix query was attempted which is incorrect behaviour.
Member
Author
|
/azp run python - cosmos - tests |
Member
Author
|
/azp run python - cosmos - tests |
xinlian12
reviewed
Oct 29, 2024
simorenoh
approved these changes
Oct 29, 2024
kushagraThapar
previously requested changes
Oct 29, 2024
Member
kushagraThapar
left a comment
kushagraThapar
left a comment
There was a problem hiding this comment.
I am curious, why tests are not running on this PR?
Blocking because of testing. @scbedd did we change anything?
Member
|
@bambriz can you please re-run the CI before merging this PR. |
Member
kushagraThapar
left a comment
kushagraThapar
left a comment
There was a problem hiding this comment.
Curious about couple of things.
Member
Author
|
/azp run python - cosmos - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Member
Author
|
/azp run python - cosmos - ci |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Collaborator
|
API change check API changes are not detected in this pull request. |
optimization
Member
Author
|
/azp run python - cosmos - ci |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Member
Author
|
/azp run python - cosmos - ci |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Member
Author
|
/azp run python - cosmos - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
allenkim0129
reviewed
Nov 4, 2024
Changes the type hint of partition key to be sequence instead of explicitly tuple and list.
Member
Author
|
/azp run python - cosmos - ci |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Member
Author
|
/azp run python - cosmos - tests |
|
Pull request contains merge conflicts. |
Member
Author
|
/azp run python - cosmos - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
allenkim0129
approved these changes
Nov 6, 2024
Member
Author
|
/azp run python - cosmos - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Member
Author
|
/azp run python - cosmos - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Member
Author
|
/azp run python - cosmos - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Member
Author
|
/azp run python - cosmos - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Member
Author
|
/azp run python - cosmos - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
update version to 4.8.0
l0lawrence
pushed a commit
to l0lawrence/azure-sdk-for-python
that referenced
this pull request
Feb 19, 2025
…zure#38136) * Fix support for allowing tuples to be used for subapartition Allows the usage of tuples alongside lists to be used for hierarchical partition key values. Both get serialized to json arrays. Previous behaviour would give an error that a prefix query was attempted which is incorrect behaviour. * update docstrings * Update CHANGELOG.md * Update partition_key.py * Update partition_key.py optimization * Update partition_key.py * Update partition_key.py * Update partition_key.py * Update type hint of partition key Changes the type hint of partition key to be sequence instead of explicitly tuple and list. * update version update version to 4.8.0
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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
This PR fixes an issue where passing in a tuple will cause the following error to be thrown: ValueError: 2 partition key components provided. Expected less than 2 components (number of container partition key definition components).
Which should only occur when doing a prefix partition query. This pr allows passing in tuples and not just lists for subpartitioning. Both tuples and lists are serialized to json arrays and json arrays are ultimately deserialized to lists by default. This also updates type hinting to show tuples can be used the same as lists for pk values.
This pr fixes: Issue 37638