You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by "terrymanu (via GitHub)" <gi...@apache.org> on 2026/06/30 09:08:03 UTC

[PR] Fix documentation examples and DistSQL syntax [shardingsphere]

terrymanu opened a new pull request, #38968:
URL: https://github.com/apache/shardingsphere/pull/38968

   - Correct Java API algorithm examples and AlgorithmConfiguration fields
   - Align DistSQL grammar docs with parser rules for sharding, encrypt, mask, shadow, and migration
   - Fix RQL/RAL result examples, row counts, and CDC documentation wording


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Fix documentation examples and DistSQL syntax [shardingsphere]

Posted by "terrymanu (via GitHub)" <gi...@apache.org>.
terrymanu commented on PR #38968:
URL: https://github.com/apache/shardingsphere/pull/38968#issuecomment-4841973859

   ### Summary
   
   **Review Result: Mergeable**
   
   Reason: This is a code-scope review only. The latest PR head fixes the previous documentation blockers, and CI was not reviewed by request.
   
   ### Evidence
   
   - The Java API encrypt samples now use `AES` for the `pwd` cipher encryptor and a separate `MD5` encryptor only for assisted query. This matches `EncryptRule` checks: cipher encryptors must support decrypt, while assisted query encryptors must support equivalent filter.
   - The sharding strategy syntax docs now describe only the supported variants: `NONE`, `STANDARD`, `COMPLEX`, and `HINT`. This matches the sharding DistSQL visitor/checker behavior and removes the previously documented invalid non-`NONE` strategy forms without algorithms.
   - The previous stale grammar forms and invalid encrypt sample patterns no longer appear in the reviewed docs.
   
   ### Review Details
   
   Review Focus: Code Correctness Review; CI not reviewed by request.
   
   Reviewed Scope: PR #38968 latest head `fd2a8ee11f61fab52f432d1f1174728ee312500a`, base/merge-base `7e60293d37c2a545b66f3f5dace2394747a8ed02`. Reviewed all 80 changed files under `docs/document`; local triple-dot file list matched GitHub `/pulls/38968/files` 80/80. Target syntax area: ShardingSphere DistSQL sharding RDL docs; external DB dialect docs are not applicable because this syntax is ShardingSphere-specific. Checked related parser grammar, visitor, handler checker, and encrypt rule/algorithm source.
   
   Not Reviewed Scope: GitHub Actions/check-runs/logs, rendered website output, live Proxy runtime smoke, and full documentation site build.
   
   Verification:
   - GitHub PR metadata/files via REST API: exit 0.
   - Local/GitHub changed-file comparison: matched 80/80.
   - Targeted source and docs searches for previous invalid patterns: no matches.
   - `./mvnw spotless:check -Pcheck -T1C`: exit 0, BUILD SUCCESS.
   - `./mvnw checkstyle:check -Pcheck -T1C`: exit 0, BUILD SUCCESS.
   
   Release Note / User Docs: User docs are the changed scope and were reviewed. No separate release note is required for these documentation corrections.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Fix documentation examples and DistSQL syntax [shardingsphere]

Posted by "terrymanu (via GitHub)" <gi...@apache.org>.
terrymanu merged PR #38968:
URL: https://github.com/apache/shardingsphere/pull/38968


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org