sql-statements: use EBNF to render syntax diagrams - third batch (pin…

…gcap#5540)
shawn0915 · Apr 26, 2021 · 4839002 · 4839002
1 parent 3e454f1
commit 4839002
Show file tree

Hide file tree

Showing 22 changed files with 330 additions and 261 deletions.
diff --git a/sql-statements/sql-statement-execute.md b/sql-statements/sql-statement-execute.md
@@ -10,9 +10,10 @@ aliases: ['/docs-cn/dev/sql-statements/sql-statement-execute/','/docs-cn/dev/ref
 
 ## 语法图
 
-**ExecuteStmt:**
-
-![ExecuteStmt](/media/sqlgram/ExecuteStmt.png)
+```ebnf+diagram
+ExecuteStmt ::=
+    'EXECUTE' Identifier ( 'USING' UserVariable ( ',' UserVariable )* )?
+```
 
 ## 示例
 

diff --git a/sql-statements/sql-statement-explain-analyze.md b/sql-statements/sql-statement-explain-analyze.md
@@ -14,17 +14,23 @@ aliases: ['/docs-cn/dev/sql-statements/sql-statement-explain-analyze/','/docs-cn
 
 ## 语法图
 
-**ExplainSym:**
-
-![ExplainSym](/media/sqlgram/ExplainSym.png)
-
-**ExplainStmt:**
-
-![ExplainStmt](/media/sqlgram/ExplainStmt.png)
-
-**ExplainableStmt:**
-
-![ExplainableStmt](/media/sqlgram/ExplainableStmt.png)
+```ebnf+diagram
+ExplainSym ::=
+    'EXPLAIN'
+|   'DESCRIBE'
+|    'DESC'
+
+ExplainStmt ::=
+    ExplainSym ( TableName ColumnName? | 'ANALYZE'? ExplainableStmt | 'FOR' 'CONNECTION' NUM | 'FORMAT' '=' ( stringLit | ExplainFormatType ) ( 'FOR' 'CONNECTION' NUM | ExplainableStmt ) )
+
+ExplainableStmt ::=
+    SelectStmt
+|   DeleteFromStmt
+|   UpdateStmt
+|   InsertIntoStmt
+|   ReplaceIntoStmt
+|   UnionStmt
+```
 
 ## EXPLAIN ANALYZE 输出格式
 
@@ -181,7 +187,7 @@ inner:{total:4.297515932s, concurrency:5, task:17, construct:97.96291ms, fetch:4
 `IndexHashJoin` 算子包含以下执行信息：
 
 ```sql
-inner:{total:4.429220003s, concurrency:5, task:17, construct:96.207725ms, fetch:4.239324006s, build:24.567801ms, join:93.607362ms} 
+inner:{total:4.429220003s, concurrency:5, task:17, construct:96.207725ms, fetch:4.239324006s, build:24.567801ms, join:93.607362ms}
 ```
 
 - `inner`：inner worker 的执行信息，具体如下：

diff --git a/sql-statements/sql-statement-explain.md b/sql-statements/sql-statement-explain.md
@@ -14,17 +14,23 @@ TiDB 支持 `EXPLAIN [options] FOR CONNECTION connection_id`，但与 MySQL 的
 
 ## 语法图
 
-**ExplainSym:**
-
-![ExplainSym](/media/sqlgram/ExplainSym.png)
-
-**ExplainStmt:**
-
-![ExplainStmt](/media/sqlgram/ExplainStmt.png)
-
-**ExplainableStmt:**
-
-![ExplainableStmt](/media/sqlgram/ExplainableStmt.png)
+```ebnf+diagram
+ExplainSym ::=
+    'EXPLAIN'
+|   'DESCRIBE'
+|   'DESC'
+
+ExplainStmt ::=
+    ExplainSym ( TableName ColumnName? | 'ANALYZE'? ExplainableStmt | 'FOR' 'CONNECTION' NUM | 'FORMAT' '=' ( stringLit | ExplainFormatType ) ( 'FOR' 'CONNECTION' NUM | ExplainableStmt ) )
+
+ExplainableStmt ::=
+    SelectStmt
+|   DeleteFromStmt
+|   UpdateStmt
+|   InsertIntoStmt
+|   ReplaceIntoStmt
+|   UnionStmt
+```
 
 ## EXPLAIN 输出格式
 
@@ -192,7 +198,7 @@ desc format = "dot" select A.a, B.b from t A join t B on A.a > B.b where A.a < 1
 +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | dot contents                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 
+|
 digraph Projection_8 {
 subgraph cluster8{
 node [style=filled, color=lightgrey]

diff --git a/sql-statements/sql-statement-flashback-table.md b/sql-statements/sql-statement-flashback-table.md
@@ -27,17 +27,16 @@ FLASHBACK TABLE table_name [TO other_table_name]
 
 ### 语法图
 
-**FlashbackTableStmt:**
+```ebnf+diagram
+FlashbackTableStmt ::=
+    'FLASHBACK' 'TABLE' TableName FlashbackToNewName
 
-![FlashbackTableStmt](/media/sqlgram/FlashbackTableStmt.png)
+TableName ::=
+    Identifier ( '.' Identifier )?
 
-**TableName:**
-
-![TableName](/media/sqlgram/TableName.png)
-
-**FlashbackToNewName:**
-
-![FlashbackToNewName](/media/sqlgram/FlashbackToNewName.png)
+FlashbackToNewName ::=
+    ( 'TO' Identifier )?
+```
 
 ## 注意事项
 

diff --git a/sql-statements/sql-statement-flush-privileges.md b/sql-statements/sql-statement-flush-privileges.md
@@ -10,17 +10,21 @@ aliases: ['/docs-cn/dev/sql-statements/sql-statement-flush-privileges/','/docs-c
 
 ## 语法图
 
-**FlushStmt:**
-
-![FlushStmt](/media/sqlgram/FlushStmt.png)
-
-**NoWriteToBinLogAliasOpt:**
-
-![NoWriteToBinLogAliasOpt](/media/sqlgram/NoWriteToBinLogAliasOpt.png)
-
-**FlushOption:**
-
-![FlushOption](/media/sqlgram/FlushOption.png)
+```ebnf+diagram
+FlushStmt ::=
+    'FLUSH' NoWriteToBinLogAliasOpt FlushOption
+
+NoWriteToBinLogAliasOpt ::=
+    ( 'NO_WRITE_TO_BINLOG' | 'LOCAL' )?
+
+FlushOption ::=
+    'PRIVILEGES'
+|   'STATUS'
+|    'TIDB' 'PLUGINS' PluginNameList
+|    'HOSTS'
+|   LogTypeOpt 'LOGS'
+|   TableOrTables TableNameListOpt WithReadLockOpt
+```
 
 ## 示例
 

diff --git a/sql-statements/sql-statement-flush-status.md b/sql-statements/sql-statement-flush-status.md
@@ -10,17 +10,21 @@ aliases: ['/docs-cn/dev/sql-statements/sql-statement-flush-status/','/docs-cn/de
 
 ## 语法图
 
-**FlushStmt:**
-
-![FlushStmt](/media/sqlgram/FlushStmt.png)
-
-**NoWriteToBinLogAliasOpt:**
-
-![NoWriteToBinLogAliasOpt](/media/sqlgram/NoWriteToBinLogAliasOpt.png)
-
-**FlushOption:**
-
-![FlushOption](/media/sqlgram/FlushOption.png)
+```ebnf+diagram
+FlushStmt ::=
+    'FLUSH' NoWriteToBinLogAliasOpt FlushOption
+
+NoWriteToBinLogAliasOpt ::=
+    ( 'NO_WRITE_TO_BINLOG' | 'LOCAL' )?
+
+FlushOption ::=
+    'PRIVILEGES'
+|   'STATUS'
+|    'TIDB' 'PLUGINS' PluginNameList
+|    'HOSTS'
+|   LogTypeOpt 'LOGS'
+|   TableOrTables TableNameListOpt WithReadLockOpt
+```
 
 ## 示例
 

diff --git a/sql-statements/sql-statement-flush-tables.md b/sql-statements/sql-statement-flush-tables.md
@@ -10,33 +10,34 @@ aliases: ['/docs-cn/dev/sql-statements/sql-statement-flush-tables/','/docs-cn/de
 
 ## 语法图
 
-**FlushStmt:**
+```ebnf+diagram
+FlushStmt ::=
+    'FLUSH' NoWriteToBinLogAliasOpt FlushOption
 
-![FlushStmt](/media/sqlgram/FlushStmt.png)
+NoWriteToBinLogAliasOpt ::=
+    ( 'NO_WRITE_TO_BINLOG' | 'LOCAL' )?
 
-**NoWriteToBinLogAliasOpt:**
+FlushOption ::=
+    'PRIVILEGES'
+|   'STATUS'
+|    'TIDB' 'PLUGINS' PluginNameList
+|    'HOSTS'
+|    LogTypeOpt 'LOGS'
+|    TableOrTables TableNameListOpt WithReadLockOpt
 
-![NoWriteToBinLogAliasOpt](/media/sqlgram/NoWriteToBinLogAliasOpt.png)
+LogTypeOpt ::=
+    ( 'BINARY' | 'ENGINE' | 'ERROR' | 'GENERAL' | 'SLOW' )?
 
-**FlushOption:**
+TableOrTables ::=
+    'TABLE'
+|   'TABLES'
 
-![FlushOption](/media/sqlgram/FlushOption.png)
+TableNameListOpt ::=
+    TableNameList?
 
-**LogTypeOpt:**
-
-![LogTypeOpt](/media/sqlgram/LogTypeOpt.png)
-
-**TableOrTables:**
-
-![TableOrTables](/media/sqlgram/TableOrTables.png)
-
-**TableNameListOpt:**
-
-![TableNameListOpt](/media/sqlgram/TableNameListOpt.png)
-
-**WithReadLockOpt:**
-
-![WithReadLockOpt](/media/sqlgram/WithReadLockOpt.png)
+WithReadLockOpt ::=
+    ( 'WITH' 'READ' 'LOCK' )?
+```
 
 ## 示例
 

diff --git a/sql-statements/sql-statement-grant-privileges.md b/sql-statements/sql-statement-grant-privileges.md
@@ -10,33 +10,52 @@ aliases: ['/docs-cn/dev/sql-statements/sql-statement-grant-privileges/','/docs-c
 
 ## 语法图
 
-**GrantStmt:**
-
-![GrantStmt](/media/sqlgram/GrantStmt.png)
-
-**PrivElemList:**
-
-![PrivElemList](/media/sqlgram/PrivElemList.png)
-
-**PrivElem:**
-
-![PrivElem](/media/sqlgram/PrivElem.png)
-
-**PrivType:**
-
-![PrivType](/media/sqlgram/PrivType.png)
-
-**ObjectType:**
-
-![ObjectType](/media/sqlgram/ObjectType.png)
-
-**PrivLevel:**
-
-![PrivLevel](/media/sqlgram/PrivLevel.png)
-
-**UserSpecList:**
-
-![UserSpecList](/media/sqlgram/UserSpecList.png)
+```ebnf+diagram
+GrantStmt ::=
+    'GRANT' PrivElemList 'ON' ObjectType PrivLevel 'TO' UserSpecList RequireClauseOpt WithGrantOptionOpt
+
+PrivElemList ::=
+    PrivElem ( ',' PrivElem )*
+
+PrivElem ::=
+    PrivType ( '(' ColumnNameList ')' )?
+
+PrivType ::=
+    'ALL' 'PRIVILEGES'?
+|    'ALTER' 'ROUTINE'?
+|   'CREATE' ( 'USER' | 'TEMPORARY' 'TABLES' | 'VIEW' | 'ROLE' | 'ROUTINE' )?
+|   'TRIGGER'
+|   'DELETE'
+|   'DROP' 'ROLE'?
+|    'PROCESS'
+|   'EXECUTE'
+|   'INDEX'
+|   'INSERT'
+|   'SELECT'
+|   'SUPER'
+|   'SHOW' ( 'DATABASES' | 'VIEW' )
+|   'UPDATE'
+|    'GRANT' 'OPTION'
+|    'REFERENCES'
+|    'REPLICATION' ( 'SLAVE' | 'CLIENT' )
+|    'USAGE'
+|   'RELOAD'
+|   'FILE'
+|   'CONFIG'
+|   'LOCK' 'TABLES'
+|   'EVENT'
+|   'SHUTDOWN'
+
+ObjectType ::=
+    'TABLE'?
+
+PrivLevel ::=
+    '*' ( '.' '*' )?
+|    Identifier ( '.' ( '*' | Identifier ) )?
+
+UserSpecList ::=
+    UserSpec ( ',' UserSpec )*
+```
 
 ## 示例
 

diff --git a/sql-statements/sql-statement-grant-role.md b/sql-statements/sql-statement-grant-role.md
@@ -9,17 +9,16 @@ summary: TiDB 数据库中 GRANT <role> 的使用概况。
 
 ## 语法图
 
-**GrantRoleStmt:**
+```ebnf+diagram
+GrantRoleStmt ::=
+    'GRANT' RolenameList 'TO' UsernameList
 
-![GrantRoleStmt](/media/sqlgram/GrantRoleStmt.png)
+RolenameList ::=
+    Rolename ( ',' Rolename )*
 
-**RolenameList:**
-
-![RolenameList](/media/sqlgram/RolenameList.png)
-
-**UsernameList:**
-
-![UsernameList](/media/sqlgram/UsernameList.png)
+UsernameList ::=
+    Username ( ',' Username )*
+```
 
 ## 示例