Java sdk v2 product sync documentation #959
Merged
Conversation
This file contains 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
lojzatran
requested changes
May 3, 2023
| ```` | ||
| By design, scaling the sync process should **not** be done by executing the batches themselves in parallel. However, it can be done either by: | ||
|
|
||
| - Changing the number of [max parallel requests](https://github.com/commercetools/commercetools-sync-java/tree/master/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L116) within the `sphereClient` configuration. It defines how many requests the client can execute in parallel. |
There was a problem hiding this comment.
Suggested change
| - Changing the number of [max parallel requests](https://github.com/commercetools/commercetools-sync-java/tree/master/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L116) within the `sphereClient` configuration. It defines how many requests the client can execute in parallel. | |
| - Changing the number of [max parallel requests](https://github.com/commercetools/commercetools-sync-java/tree/master/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L116) within the `projectApiRoot` configuration. It defines how many requests the client can execute in parallel. |
| - Changing the number of [max parallel requests](https://github.com/commercetools/commercetools-sync-java/tree/master/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L116) within the `sphereClient` configuration. It defines how many requests the client can execute in parallel. | ||
| - or changing the draft [batch size](https://commercetools.github.io/commercetools-sync-java/v/9.2.1/com/commercetools/sync/commons/BaseSyncOptionsBuilder.html#batchSize-int-). It defines how many drafts can one batch contains. | ||
|
|
||
| The current overridable default [configuration](https://github.com/commercetools/commercetools-sync-java/tree/master/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) of the `sphereClient` |
There was a problem hiding this comment.
Suggested change
| The current overridable default [configuration](https://github.com/commercetools/commercetools-sync-java/tree/master/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) of the `sphereClient` | |
| The current overridable default [configuration](https://github.com/commercetools/commercetools-sync-java/tree/master/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) of the `projectApiRoot` |
docs/sdk2/usage/PRODUCT_SYNC.md
Outdated
| | `variants.prices.customerGroup` | CustomerGroupResourceIdentifier | | ||
| | `variants.prices.custom.type` | TypeResourceIdentifier | | ||
| | `variants.assets.custom.type` | TypeResourceIdentifier | | ||
| | `variants.attributes` * | Only the attributes with type [ReferenceType](https://docs.commercetools.com/api/projects/productTypes#referencetype), [SetType](https://docs.commercetools.com/api/projects/productTypes#settype) with `elementType` as [ReferenceType](https://docs.commercetools.com/api/projects/productTypes#referencetype) and [NestedType](https://docs.commercetools.com/api/projects/productTypes#nestedtype) requires `key` on the `id` field of the `ReferenceType`. | |
There was a problem hiding this comment.
It means like in the description stated; only the attributes of types .... Any ideas to make this more clear?
There was a problem hiding this comment.
Ah I see. Maybe do not add * at all? The Description is enough to explain. With the * I was thinking there is another * that explains in depth what this line means.
docs/sdk2/usage/PRODUCT_SYNC.md
Outdated
| - For resolving `key-value-document` (custom object) references on attributes of type `Reference`, `Set` of `Reference`, `NestedType` or `Set` of `NestedType`, The `id` field of the reference in the attribute should be defined in the correct format. | ||
| The correct format must have a vertical bar `|` character between the values of the container and key. | ||
| For example, if the custom object has a container value `container` and key value `key`, the `id` field should be `container|key"`, | ||
| also, the key and container value should match the pattern `[-_~.a-zA-Z0-9]+`. |
There was a problem hiding this comment.
There is also max length for the key for custom objects (256 chars). Maybe it also matters here? https://docs.commercetools.com/api/projects/custom-objects#customobject
There was a problem hiding this comment.
Yeah, in indirect way it does matter... i will add a note.
|
Can you also write a migration guide for customers to go from v1 sdk to v2 sdk? Like what classes they need to change etc.? |
…documentation Java sdk v2 customer sync documentation
…oduct-sync-documentation
lojzatran
approved these changes
May 11, 2023
salander85
merged commit 3630601
into
java-sdk-v2-product-sync-migration
1 check failed
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.
JIRA: https://commercetools.atlassian.net/browse/DEVX-69