You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by GitBox <gi...@apache.org> on 2022/12/17 18:24:10 UTC

[GitHub] [shardingsphere] Qianyi951015 opened a new pull request, #22945: Update DistSQL documents

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

   Changes proposed in this pull request:
     - Uniform Railroad Diagram Format in DistSQL documents
     - Correct some errors in Railroad Diagram
   
   ---
   
   Before committing this PR, I'm sure that I have checked the following options:
   - [x] My code follows the [code of conduct](https://shardingsphere.apache.org/community/en/involved/conduct/code/) of this project.
   - [x] I have self-reviewed the commit code.
   - [ ] I have (or in comment I request) added corresponding labels for the pull request.
   - [ ] I have passed maven check locally : `./mvnw clean install -B -T1C -Dmaven.javadoc.skip -Dmaven.jacoco.skip -e`.
   - [ ] I have made corresponding changes to the documentation.
   - [ ] I have added corresponding unit tests for my changes.
   


-- 
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

[GitHub] [shardingsphere] RaigorJiang commented on a diff in pull request #22945: Update DistSQL documents

Posted by GitBox <gi...@apache.org>.
RaigorJiang commented on code in PR #22945:
URL: https://github.com/apache/shardingsphere/pull/22945#discussion_r1051546484


##########
docs/document/content/reference/distsql/syntax/ral/global-rule/alter-traffic-rule.cn.md:
##########
@@ -17,10 +17,13 @@ lableName ::=
   identifier
 
 trafficAlgorithmDefination ::=
-  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' = trafficAlgorithmTypeName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' trafficAlgorithmTypeName (propertiesDefination)? ')' ')'
 
 loadBalancerDefination ::=
-  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' = loadBalancerName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' '=' loadBalancerName (propertiesDefination)? ')' ')'
+
+propertiesDefination ::=
+  ',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'

Review Comment:
   Hi @Qianyi951015 ,  I think a definition should not start with a `comma`, do you agree?



-- 
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

[GitHub] [shardingsphere] Qianyi951015 commented on a diff in pull request #22945: Update DistSQL documents

Posted by GitBox <gi...@apache.org>.
Qianyi951015 commented on code in PR #22945:
URL: https://github.com/apache/shardingsphere/pull/22945#discussion_r1051546911


##########
docs/document/content/reference/distsql/syntax/ral/global-rule/alter-traffic-rule.cn.md:
##########
@@ -17,10 +17,13 @@ lableName ::=
   identifier
 
 trafficAlgorithmDefination ::=
-  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' = trafficAlgorithmTypeName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' trafficAlgorithmTypeName (propertiesDefination)? ')' ')'
 
 loadBalancerDefination ::=
-  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' = loadBalancerName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' '=' loadBalancerName (propertiesDefination)? ')' ')'
+
+propertiesDefination ::=
+  ',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'

Review Comment:
   Change like this better?
   ```
   'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' '=' loadBalancerName (',' propertiesDefination)? ')' ')'
   propertiesDefination ::=
      'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'
   ```



-- 
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

[GitHub] [shardingsphere] RaigorJiang commented on a diff in pull request #22945: Update DistSQL documents

Posted by GitBox <gi...@apache.org>.
RaigorJiang commented on code in PR #22945:
URL: https://github.com/apache/shardingsphere/pull/22945#discussion_r1051547001


##########
docs/document/content/reference/distsql/syntax/rdl/rule-definition/db-discovery/alter-db-discovery-rule.cn.md:
##########
@@ -27,6 +30,12 @@ typeName ::=
 
 discoveryHeartbeatName ::=
   identifier
+
+key ::=
+  string
+
+value ::=
+  string

Review Comment:
   Sorry, `value` is not a string, it is a literal now, please refer to #22891



-- 
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

[GitHub] [shardingsphere] RaigorJiang commented on a diff in pull request #22945: Update DistSQL documents

Posted by GitBox <gi...@apache.org>.
RaigorJiang commented on code in PR #22945:
URL: https://github.com/apache/shardingsphere/pull/22945#discussion_r1051572736


##########
docs/document/content/reference/distsql/syntax/ral/migration/register-migration-source-storage-unit.en.md:
##########
@@ -28,17 +28,14 @@ user ::=
 password ::=
   string
 
-proerties ::=
-  PROPERTIES '(' property ( ',' property )* ')'
-
-property ::=
-  key '=' value
+proertiesDefinition ::=
+  ',' 'PROPERTIES' '(' ( key  '=' value ) ( ',' key  '=' value )* ')'

Review Comment:
   need to be updated.



-- 
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

[GitHub] [shardingsphere] RaigorJiang merged pull request #22945: Update DistSQL documents

Posted by GitBox <gi...@apache.org>.
RaigorJiang merged PR #22945:
URL: https://github.com/apache/shardingsphere/pull/22945


-- 
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

[GitHub] [shardingsphere] RaigorJiang commented on a diff in pull request #22945: Update DistSQL documents

Posted by GitBox <gi...@apache.org>.
RaigorJiang commented on code in PR #22945:
URL: https://github.com/apache/shardingsphere/pull/22945#discussion_r1051572343


##########
docs/document/content/reference/distsql/syntax/ral/global-rule/create-traffic-rule.cn.md:
##########
@@ -17,10 +17,13 @@ lableName ::=
   identifier
 
 trafficAlgorithmDefination ::=
-  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' = trafficAlgorithmTypeName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' trafficAlgorithmTypeName (propertiesDefination)? ')' ')'
 
 loadBalancerDefination ::=
-  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' = loadBalancerName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' '=' loadBalancerName (propertiesDefination)? ')' ')'
+
+propertiesDefination ::=
+  ',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'

Review Comment:
   Same problem



-- 
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

[GitHub] [shardingsphere] RaigorJiang commented on a diff in pull request #22945: Update DistSQL documents

Posted by GitBox <gi...@apache.org>.
RaigorJiang commented on code in PR #22945:
URL: https://github.com/apache/shardingsphere/pull/22945#discussion_r1051546605


##########
docs/document/content/reference/distsql/syntax/ral/migration/alter-migration-rule.en.md:
##########
@@ -32,14 +32,14 @@ shardingSize ::=
   int
 
 rateLimiter ::=
-  'RATE_LIMITER' '(' 'TYPE' '(' 'NAME' '=' algorithmName ',' 'PROPERTIES' '(' propertyDefinition ')'
+  'RATE_LIMITER' '(' 'TYPE' '(' 'NAME' '=' algorithmName ',' 'PROPERTIES' '(' propertiesDefinition ')' ')' ')'
 
 algorithmName ::=
   string
 
-propertyDefinition ::=
-  ( key  '=' value ) ( ',' key  '=' value )* 
-
+propertiesDefinition ::=
+  ',' 'PROPERTIES' '(' ( key  '=' value ) ( ',' key  '=' value )* ')'

Review Comment:
   Conflicts with line 35



-- 
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

[GitHub] [shardingsphere] RaigorJiang commented on a diff in pull request #22945: Update DistSQL documents

Posted by GitBox <gi...@apache.org>.
RaigorJiang commented on code in PR #22945:
URL: https://github.com/apache/shardingsphere/pull/22945#discussion_r1051571742


##########
docs/document/content/reference/distsql/syntax/ral/global-rule/alter-traffic-rule.cn.md:
##########
@@ -17,10 +17,13 @@ lableName ::=
   identifier
 
 trafficAlgorithmDefination ::=
-  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' = trafficAlgorithmTypeName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' trafficAlgorithmTypeName (propertiesDefination)? ')' ')'
 
 loadBalancerDefination ::=
-  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' = loadBalancerName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' '=' loadBalancerName (propertiesDefination)? ')' ')'
+
+propertiesDefination ::=
+  ',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'

Review Comment:
   Yes.



-- 
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

[GitHub] [shardingsphere] RaigorJiang commented on a diff in pull request #22945: Update DistSQL documents

Posted by GitBox <gi...@apache.org>.
RaigorJiang commented on code in PR #22945:
URL: https://github.com/apache/shardingsphere/pull/22945#discussion_r1051573288


##########
docs/document/content/reference/distsql/syntax/rdl/storage-unit-definition/alter-storage-unit.en.md:
##########
@@ -37,11 +37,8 @@ user ::=
 password ::=
   string
 
-proerties ::=
-  PROPERTIES '(' property ( ',' property )* ')'
-
-property ::=
-  key '=' value
+proertiesDefinition ::=
+  ',' PROPERTIES '(' key '=' value (',' key '=' value)* ')'

Review Comment:
   need to be updated



##########
docs/document/content/reference/distsql/syntax/rdl/storage-unit-definition/register-storage-unit.en.md:
##########
@@ -37,11 +37,8 @@ user ::=
 password ::=
   string
 
-proerties ::=
-  PROPERTIES '(' property ( ',' property )* ')'
-
-property ::=
-  key '=' value
+proertiesDefinition ::=
+  ',' PROPERTIES '(' key '=' value (',' key '=' value)* ')'

Review Comment:
   need to be updated



-- 
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

[GitHub] [shardingsphere] RaigorJiang commented on a diff in pull request #22945: Update DistSQL documents

Posted by GitBox <gi...@apache.org>.
RaigorJiang commented on code in PR #22945:
URL: https://github.com/apache/shardingsphere/pull/22945#discussion_r1051572182


##########
docs/document/content/reference/distsql/syntax/ral/migration/alter-migration-rule.cn.md:
##########
@@ -20,7 +20,7 @@ writeConfiguration ::=
   'WRITE' '(' ('WORKER_THREAD' '=' workerThreadPoolSize ',')? ('BATCH_SIZE' '=' batchSize ',')? ('SHARDING_SIZE' '=' shardingSize ',')? (rateLimiter)? ')'
 
 dataChannel ::=
-  'STREAM_CHANNEL' '(' 'TYPE' '(' 'NAME' '=' algorithmName ',' 'PROPERTIES' '(' propertyDefinition ')'
+  'STREAM_CHANNEL' '(' 'TYPE' '(' 'NAME' '=' algorithmName propertyDefinition

Review Comment:
   `propertyDefinition` is removed at line 40, and comma missed after algorithmName.



-- 
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

[GitHub] [shardingsphere] RaigorJiang commented on a diff in pull request #22945: Update DistSQL documents

Posted by GitBox <gi...@apache.org>.
RaigorJiang commented on code in PR #22945:
URL: https://github.com/apache/shardingsphere/pull/22945#discussion_r1051574961


##########
docs/document/content/reference/distsql/syntax/ral/global-rule/alter-traffic-rule.cn.md:
##########
@@ -17,10 +17,13 @@ lableName ::=
   identifier
 
 trafficAlgorithmDefination ::=
-  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' = trafficAlgorithmTypeName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' trafficAlgorithmTypeName (',' propertiesDefination)? ')' ')'
 
 loadBalancerDefination ::=
-  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' = loadBalancerName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' '=' loadBalancerName (',' propertiesDefination)? ')' ')'
+
+propertiesDefination ::=

Review Comment:
   Should it be Definition?



-- 
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

[GitHub] [shardingsphere] Qianyi951015 commented on a diff in pull request #22945: Update DistSQL documents

Posted by GitBox <gi...@apache.org>.
Qianyi951015 commented on code in PR #22945:
URL: https://github.com/apache/shardingsphere/pull/22945#discussion_r1051575119


##########
docs/document/content/reference/distsql/syntax/ral/global-rule/alter-traffic-rule.cn.md:
##########
@@ -17,10 +17,13 @@ lableName ::=
   identifier
 
 trafficAlgorithmDefination ::=
-  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' = trafficAlgorithmTypeName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+  'TRAFFIC_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' trafficAlgorithmTypeName (',' propertiesDefination)? ')' ')'
 
 loadBalancerDefination ::=
-  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' = loadBalancerName (',' 'PROPERTIES' '(' key '=' value (',' key '=' value)* ')')? ')' ')'
+  'LOAD_BALANCER' '(' 'TYPE' '(' 'NAME' '=' loadBalancerName (',' propertiesDefination)? ')' ')'
+
+propertiesDefination ::=

Review Comment:
   yes😂



-- 
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

[GitHub] [shardingsphere] RaigorJiang commented on a diff in pull request #22945: Update DistSQL documents

Posted by GitBox <gi...@apache.org>.
RaigorJiang commented on code in PR #22945:
URL: https://github.com/apache/shardingsphere/pull/22945#discussion_r1051572486


##########
docs/document/content/reference/distsql/syntax/ral/migration/alter-migration-rule.en.md:
##########
@@ -32,19 +32,19 @@ shardingSize ::=
   int
 
 rateLimiter ::=
-  'RATE_LIMITER' '(' 'TYPE' '(' 'NAME' '=' algorithmName ',' 'PROPERTIES' '(' propertyDefinition ')'
+  'RATE_LIMITER' '(' 'TYPE' '(' 'NAME' '=' algorithmName ',' propertiesDefinition ')' ')'
 
 algorithmName ::=
   string
 
-propertyDefinition ::=
-  ( key  '=' value ) ( ',' key  '=' value )* 
-
+propertiesDefinition ::=
+  'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'
+  

Review Comment:
   Useless white space at line 42.



-- 
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