-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Subpartitioning: Adds SDK changes to support subpartitioning. #18503
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 4 commits
8ab6ed8
d5d3b47
5459104
e1c3001
29f2cea
dd77aaf
a65e716
58c2746
4cb8cb1
036b7ec
f2905f4
24610d6
5a741c5
29bcfc9
14bd7a2
8f77d0d
741ce81
0b45b66
22fe137
5bf9d26
0c67ba6
00d5f8e
f008411
28926cf
ed325f9
b6e452e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1222,19 +1222,33 @@ private static PartitionKeyInternal extractPartitionKeyValueFromDocument( | |
| InternalObjectNode document, | ||
| PartitionKeyDefinition partitionKeyDefinition) { | ||
| if (partitionKeyDefinition != null) { | ||
| String path = partitionKeyDefinition.getPaths().iterator().next(); | ||
| List<String> parts = PathParser.getPathParts(path); | ||
| if (parts.size() >= 1) { | ||
| Object value = ModelBridgeInternal.getObjectByPathFromJsonSerializable(document, parts); | ||
| if (value == null || value.getClass() == ObjectNode.class) { | ||
| value = ModelBridgeInternal.getNonePartitionKey(partitionKeyDefinition); | ||
| } | ||
| switch (partitionKeyDefinition.getKind()) { | ||
|
SrinikhilReddy marked this conversation as resolved.
|
||
| case HASH: | ||
|
|
||
| String path = partitionKeyDefinition.getPaths().iterator().next(); | ||
| List<String> parts = PathParser.getPathParts(path); | ||
| if (parts.size() >= 1) { | ||
| Object value = ModelBridgeInternal.getObjectByPathFromJsonSerializable(document, parts); | ||
| if (value == null || value.getClass() == ObjectNode.class) { | ||
| value = ModelBridgeInternal.getNonePartitionKey(partitionKeyDefinition); | ||
| } | ||
|
|
||
| if (value instanceof PartitionKeyInternal) { | ||
| return (PartitionKeyInternal) value; | ||
| } else { | ||
| return PartitionKeyInternal.fromObjectArray(Collections.singletonList(value), false); | ||
| if (value instanceof PartitionKeyInternal) { | ||
| return (PartitionKeyInternal) value; | ||
| } else { | ||
| return PartitionKeyInternal.fromObjectArray(Collections.singletonList(value), false); | ||
| } | ||
| } | ||
| break; | ||
| case MULTI_HASH: | ||
| Object[] partitionKeyValues = new Object[partitionKeyDefinition.getPaths().size()]; | ||
| for(int path_iter = 0 ; path_iter < partitionKeyDefinition.getPaths().size(); path_iter++) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @moderakh any suggestions on elegant way of iteration.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. it is possible to use java stream. partitionKeyDefinition.getPaths().stream().map .... but not much difference functional wise. |
||
| { | ||
|
SrinikhilReddy marked this conversation as resolved.
Outdated
|
||
| String partitionPath = partitionKeyDefinition.getPaths().get(path_iter); | ||
| List<String> partitionPathParts = PathParser.getPathParts(partitionPath); | ||
| partitionKeyValues[path_iter] = ModelBridgeInternal.getObjectByPathFromJsonSerializable(document, partitionPathParts); | ||
| } | ||
| return PartitionKeyInternal.fromObjectArray(partitionKeyValues, false); | ||
| } | ||
| } | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -92,6 +92,32 @@ static public String getEffectivePartitionKeyForHashPartitioningV2(PartitionKeyI | |
| } | ||
| } | ||
|
|
||
| static String getEffectivePartitionKeyForMultiHashPartitioning(PartitionKeyInternal partitionKeyInternal) { | ||
| StringBuilder stringBuilder = new StringBuilder(); | ||
|
SrinikhilReddy marked this conversation as resolved.
Outdated
|
||
| for (int i = 0; i < partitionKeyInternal.components.size(); i++) { | ||
| try(ByteBufferOutputStream byteArrayBuffer = new ByteBufferOutputStream()) { | ||
|
kirankumarkolli marked this conversation as resolved.
|
||
|
|
||
| partitionKeyInternal.components.get(i).writeForHashingV2(byteArrayBuffer); | ||
|
|
||
|
|
||
| ByteBuffer byteBuffer = byteArrayBuffer.asByteBuffer(); | ||
| UInt128 hashAsUnit128 = MurmurHash3_128.hash128(byteBuffer.array(), byteBuffer.limit()); | ||
|
|
||
| byte[] hash = uIntToBytes(hashAsUnit128); | ||
| Bytes.reverse(hash); | ||
|
|
||
| // Reset 2 most significant bits, as max exclusive value is 'FF'. | ||
| // Plus one more just in case. | ||
| hash[0] &= 0x3F; | ||
|
|
||
| stringBuilder.append(HexConvert.bytesToHex(hash)); | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Q: How about allocate byte[] and then convert to hex at the end? |
||
| } catch (IOException e) { | ||
| throw new IllegalArgumentException(e); | ||
| } | ||
| } | ||
| return stringBuilder.toString(); | ||
|
SrinikhilReddy marked this conversation as resolved.
|
||
| } | ||
|
|
||
| static String getEffectivePartitionKeyForHashPartitioning(PartitionKeyInternal partitionKeyInternal) { | ||
| IPartitionKeyComponent[] truncatedComponents = new IPartitionKeyComponent[partitionKeyInternal.components.size()]; | ||
|
|
||
|
|
@@ -138,7 +164,7 @@ public static String getEffectivePartitionKeyString(PartitionKeyInternal partiti | |
| return MaximumExclusiveEffectivePartitionKey; | ||
| } | ||
|
|
||
| if (partitionKeyInternal.components.size() < partitionKeyDefinition.getPaths().size()) { | ||
| if (partitionKeyInternal.components.size() < partitionKeyDefinition.getPaths().size() && partitionKeyDefinition.getKind() != PartitionKind.MULTI_HASH) { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this to cover only for query? If so do we need two variations? |
||
| throw new IllegalArgumentException(RMResources.TooFewPartitionKeyComponents); | ||
| } | ||
|
|
||
|
|
@@ -161,6 +187,9 @@ public static String getEffectivePartitionKeyString(PartitionKeyInternal partiti | |
| return getEffectivePartitionKeyForHashPartitioning(partitionKeyInternal); | ||
| } | ||
|
|
||
| case MULTI_HASH: | ||
| return getEffectivePartitionKeyForMultiHashPartitioning(partitionKeyInternal); | ||
|
|
||
| default: | ||
| return toHexEncodedBinaryString(partitionKeyInternal.components); | ||
| } | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| package com.azure.cosmos.models; | ||
|
SrinikhilReddy marked this conversation as resolved.
|
||
|
|
||
| import com.azure.cosmos.implementation.Undefined; | ||
| import com.azure.cosmos.implementation.routing.PartitionKeyInternal; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| public class PartitionKeyBuilder { | ||
|
SrinikhilReddy marked this conversation as resolved.
Outdated
SrinikhilReddy marked this conversation as resolved.
Outdated
|
||
| private List<Object> partitionKeyValues; | ||
|
|
||
| /** | ||
| * Constructor. CREATE a new instance of the PartitionKeyBuilder object. | ||
| */ | ||
| public PartitionKeyBuilder() | ||
| { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: java code style '{' on the same line as method, for other new methods too.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed |
||
| this.partitionKeyValues = new ArrayList<Object>(); | ||
| } | ||
|
|
||
| public PartitionKeyBuilder Add(String value) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. java style lower camel case, same for the other methods here. |
||
| { | ||
| this.partitionKeyValues.add(value); | ||
| return this; | ||
| } | ||
|
|
||
| public PartitionKeyBuilder Add(double value) | ||
| { | ||
| this.partitionKeyValues.add(value); | ||
| return this; | ||
| } | ||
|
|
||
| public PartitionKeyBuilder Add(boolean value) | ||
| { | ||
| this.partitionKeyValues.add(value); | ||
| return this; | ||
| } | ||
|
|
||
| public PartitionKeyBuilder AddNullValue() | ||
|
SrinikhilReddy marked this conversation as resolved.
Outdated
|
||
| { | ||
| this.partitionKeyValues.add(null); | ||
| return this; | ||
| } | ||
|
|
||
| public PartitionKeyBuilder AddNoneValue() | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Code doc please. For None please cover it explicitly on targeted scenarios.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Null and None dis-ambiguration is very important in docs.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added code comments.. |
||
| { | ||
| this.partitionKeyValues.add(PartitionKey.NONE); | ||
| return this; | ||
| } | ||
|
|
||
| public PartitionKey Build() | ||
| { | ||
| // Why these checks? | ||
| // These changes are being added for SDK to support multiple paths in a partition key. | ||
| // | ||
| // Currently, when a resource does not specify a value for the PartitionKey, | ||
| // we assign a temporary value `PartitionKey.None` and later discern whether | ||
| // it is a PartitionKey.Undefined or PartitionKey.Empty based on the Collection Type. | ||
| // We retain this behaviour for single path partition keys. | ||
| // | ||
| // For collections with multiple path keys, absence of a partition key values is | ||
| // always treated as a PartitionKey.Undefined. | ||
| if(this.partitionKeyValues.size() == 0) | ||
| { | ||
| throw new IllegalArgumentException("No partition key value has been specified"); | ||
|
SrinikhilReddy marked this conversation as resolved.
|
||
| } | ||
|
|
||
| if(this.partitionKeyValues.size() == 1 && PartitionKey.NONE.equals(this.partitionKeyValues.get(0))) | ||
| { | ||
| return PartitionKey.NONE; | ||
| } | ||
|
|
||
| PartitionKeyInternal partitionKeyInternal; | ||
| Object[] valueArray = new Object[this.partitionKeyValues.size()]; | ||
| for(int i = 0; i < this.partitionKeyValues.size(); i++) | ||
| { | ||
| Object val = this.partitionKeyValues.get(i); | ||
| if(PartitionKey.NONE.equals(val)) | ||
| { | ||
| valueArray[i] = Undefined.value(); | ||
| } | ||
| else | ||
| { | ||
| valueArray[i] = val; | ||
| } | ||
| } | ||
|
|
||
| partitionKeyInternal = PartitionKeyInternal.fromObjectArray(valueArray, true); | ||
| return new PartitionKey(partitionKeyInternal); | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,16 +6,9 @@ | |
|
|
||
| package com.azure.cosmos; | ||
|
|
||
| import com.azure.cosmos.implementation.Document; | ||
| import com.azure.cosmos.implementation.HttpConstants; | ||
| import com.azure.cosmos.models.CosmosContainerProperties; | ||
| import com.azure.cosmos.models.CosmosContainerRequestOptions; | ||
| import com.azure.cosmos.models.CosmosContainerResponse; | ||
| import com.azure.cosmos.models.CosmosQueryRequestOptions; | ||
| import com.azure.cosmos.models.FeedRange; | ||
| import com.azure.cosmos.models.IndexingMode; | ||
| import com.azure.cosmos.models.IndexingPolicy; | ||
| import com.azure.cosmos.models.SqlQuerySpec; | ||
| import com.azure.cosmos.models.ThroughputProperties; | ||
| import com.azure.cosmos.models.*; | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. code style: we don't do wildcard import. You can change your intellj/eclipse default behaviour not not use wildcard import. see this: https://stackoverflow.com/questions/3348816/intellij-never-use-wildcard-imports |
||
| import com.azure.cosmos.rx.TestSuiteBase; | ||
| import com.azure.cosmos.util.CosmosPagedIterable; | ||
| import org.testng.annotations.AfterClass; | ||
|
|
@@ -26,6 +19,7 @@ | |
|
|
||
| import java.util.List; | ||
| import java.util.UUID; | ||
| import java.util.ArrayList; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
|
|
@@ -264,6 +258,40 @@ public void readAllContainers() throws Exception{ | |
| assertThat(feedResponseIterator1.iterator().hasNext()).isTrue(); | ||
| } | ||
|
|
||
| @Test(groups = { "emulator" }, timeOut = TIMEOUT) | ||
|
SrinikhilReddy marked this conversation as resolved.
|
||
| public void crudMultiHashContainer() throws Exception { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also a test case covering the NONE explicitly for above variants. |
||
| String collectionName = UUID.randomUUID().toString(); | ||
|
|
||
| PartitionKeyDefinition partitionKeyDefinition = new PartitionKeyDefinition(); | ||
| partitionKeyDefinition.setKind(PartitionKind.MULTI_HASH); | ||
| partitionKeyDefinition.setVersion(PartitionKeyDefinitionVersion.V2); | ||
| ArrayList<String> paths = new ArrayList<>(); | ||
| paths.add("/city"); | ||
| paths.add("/zipcode"); | ||
| partitionKeyDefinition.setPaths(paths); | ||
|
|
||
| CosmosContainerProperties containerProperties = getContainerDefinition(collectionName, partitionKeyDefinition); | ||
|
|
||
| //MultiHash collection create | ||
| CosmosContainerResponse containerResponse = createdDatabase.createContainer(containerProperties); | ||
| validateContainerResponse(containerProperties, containerResponse); | ||
| assertThat(containerResponse.getProperties().getPartitionKeyDefinition().getKind() == PartitionKind.MULTI_HASH); | ||
| assertThat(containerResponse.getProperties().getPartitionKeyDefinition().getPaths().size() == paths.size()); | ||
| assertThat(containerResponse.getProperties().getPartitionKeyDefinition().getPaths().get(0) == paths.get(0)); | ||
|
SrinikhilReddy marked this conversation as resolved.
|
||
| assertThat(containerResponse.getProperties().getPartitionKeyDefinition().getPaths().get(1) == paths.get(1)); | ||
|
|
||
| //MultiHash collection read | ||
| CosmosContainer multiHashContainer = createdDatabase.getContainer(collectionName); | ||
| containerResponse = multiHashContainer.read(); | ||
| validateContainerResponse(containerProperties, containerResponse); | ||
| assertThat(containerResponse.getProperties().getPartitionKeyDefinition().getKind() == PartitionKind.MULTI_HASH); | ||
| assertThat(containerResponse.getProperties().getPartitionKeyDefinition().getPaths().size() == paths.size()); | ||
| assertThat(containerResponse.getProperties().getPartitionKeyDefinition().getPaths().get(0) == paths.get(0)); | ||
| assertThat(containerResponse.getProperties().getPartitionKeyDefinition().getPaths().get(1) == paths.get(1)); | ||
|
|
||
| //MultiHash collection delete | ||
| CosmosContainerResponse deleteResponse = multiHashContainer.delete(); | ||
| } | ||
|
|
||
| @Test(groups = { "emulator" }, timeOut = TIMEOUT) | ||
| public void queryContainer() throws Exception{ | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.