doc(toolchain): sync client with master - #476
Merged
Merged
Conversation
Correct the Java client API names that no longer exist (asUUID, T.LABEL, T.ID, getGraphNumberUsed) and document the parts of the client the page never covered: the full set of HugeClient builder options with their defaults, the manager entry points beyond schema/graph/gremlin, property key aggregate and write types, the customize-uuid id strategy, schema label ttl, multi-pair edge links and edge label types, and the GraphSpace default-role and quota methods. Applied to both the en and cn pages.
imbajin
approved these changes
Sep 6, 2026
imbajin
left a comment
imbajin
left a comment
Member
There was a problem hiding this comment.
中文部分与源码保持一致且表述清晰，评分 9.2/10，按规则可直接合并。
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
2 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.
Purpose of the PR
Sync the hugegraph-client docs (en + cn) with hugegraph-toolchain master (3b385c3d).
The client pages had three API names that do not exist on master, and were missing most of the builder surface plus several schema features. The quickstart pages (
content/{en,cn}/docs/quickstart/client/hugegraph-client.md) were checked against master too and needed no change: the Maven version 1.7.0 is still the latest release (master'srevision1.8.0 is unreleased), the JDK 11 / Java 8 target note matches.github/workflows/client-ci.yml:31andpom.xml:112, and both examples still matchhugegraph-client/src/main/java/org/apache/hugegraph/example/.asUuid(), which does not exist and would not compileasUUID()T.label; the id bullets used the literal string"T.id", which never matches the lookup keyT.LABELandT.ID, and noted thatT.LABELis the constant"label"getGraphNumber(), which does not existgetGraphNumberUsed(), and added the other property and quota accessorsconfigTimeoutandconfigUserwere shown, the other builder options were undocumentedsupports*capability checksbuild()rejects a server API version outside[0.38, 0.81)calcSum/calcMax/calcMin/calcOldtable and theaggregateType(...)setter, default noneuseCustomizeUuidId/CUSTOMIZE_UUIDto the table and to the create exampleslink(...), which can be called repeatedly, thatsourceLabel(...)is rejected afterwards, and that the single-pair getters only work on a one-pair labelasBase()/withBase(...)/asGeneral()tablesupportsGraphSpace()is falseThe primaryKeys / id-strategy constraint matrix was left as it is, since that combination is validated server side and cannot be confirmed from the toolchain repo. A sentence was added saying what the client itself checks, which is only that the id strategy is not set twice.