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/04/08 10:27:09 UTC
[GitHub] [shardingsphere] lanchengx opened a new issue, #16666: Refactor DistSQL document task
lanchengx opened a new issue, #16666:
URL: https://github.com/apache/shardingsphere/issues/16666
### Background
A plan to refactor DistSQL documentation is proposed in https://github.com/apache/shardingsphere/issues/15604.
This issue is used to describe how the documentation content should be written.
### Document content
The document needs to include **syntax names**, **syntax definitions**, **examples**, and if it is a query statement, **column name explanation** need to be added
#### Explanation
#### 1. Syntax names
Determined by the keyword in the grammar definition.
_E.g_
- `ADD RESOURCE datasource` syntax has the syntax name `ADD RESOURCE`
- The `CREATE SHARDING TABLE RULE rule definition` syntax is named `CREATE SHARDING TABLE RULE`
#### 2. Syntax definition
Determined by the `g4` file, which will be given in the corresponding task.
In addition, you need to modify the `ANTRL4` grammar in the g4 file to `EBNF` grammar, you can refer to [Railroad Diagram Generator](https://www.bottlecaps.de/rr/ui) or other.
_E.g_
```
addResource
: ADD RESOURCE dataSource (COMMA dataSource)*
```
needs to be adjusted to
```
AddResource ::=
'ADD' 'RESOURCE' dataSource (',' dataSource)*
```
The keywords `ADD`, `RESOURCE`, `,` are required `'`
#### 3. Example
It is necessary to show the usage of the syntax in as much detail as possible.
#### 4. Column name explanation
You can refer to the previous DistSQL syntax document.
_E.g_
[return-value-description](https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/rql/resource-query/#return-value-description)
<img width="818" alt="image" src="https://user-images.githubusercontent.com/52209337/162417663-f580a6b3-51a9-4db5-9880-7e920df3ea3d.png">
--
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.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shardingsphere] github-actions[bot] commented on issue #16666: Refactor DistSQL document task
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #16666:
URL: https://github.com/apache/shardingsphere/issues/16666#issuecomment-1272350067
Hello , this issue has not received a reply for several days.
This issue is supposed to be closed.
--
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] github-actions[bot] commented on issue #16666: Refactor DistSQL document task
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #16666:
URL: https://github.com/apache/shardingsphere/issues/16666#issuecomment-1272350067
Hello , this issue has not received a reply for several days.
This issue is supposed to be closed.
--
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 issue #16666: Refactor DistSQL document task
Posted by GitBox <gi...@apache.org>.
RaigorJiang commented on issue #16666:
URL: https://github.com/apache/shardingsphere/issues/16666#issuecomment-1383186363
Completed, thank you all!
--
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] github-actions[bot] closed issue #16666: Refactor DistSQL document task
Posted by GitBox <gi...@apache.org>.
github-actions[bot] closed issue #16666: Refactor DistSQL document task
URL: https://github.com/apache/shardingsphere/issues/16666
--
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] TeslaCN commented on issue #16666: Refactor DistSQL document task
Posted by GitBox <gi...@apache.org>.
TeslaCN commented on issue #16666:
URL: https://github.com/apache/shardingsphere/issues/16666#issuecomment-1143396648
Hi @lanchengx
Any update here?
--
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] JiekerTime commented on issue #16666: Refactor DistSQL document task
Posted by GitBox <gi...@apache.org>.
JiekerTime commented on issue #16666:
URL: https://github.com/apache/shardingsphere/issues/16666#issuecomment-1200782913
I will help to perfect the documentation ~
--
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 issue #16666: Refactor DistSQL document task
Posted by GitBox <gi...@apache.org>.
RaigorJiang commented on issue #16666:
URL: https://github.com/apache/shardingsphere/issues/16666#issuecomment-1200931165
> I will help to perfect the documentation ~
That's really nice, thank you!
--
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 closed issue #16666: Refactor DistSQL document task
Posted by GitBox <gi...@apache.org>.
RaigorJiang closed issue #16666: Refactor DistSQL document task
URL: https://github.com/apache/shardingsphere/issues/16666
--
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