[Doc] Fix plugin related documentation #1911
Open
Conversation
This file contains 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
morrySnow
reviewed
Jan 22, 2025
|
|
||
| ```sql | ||
| INSTALL PLUGIN FROM [source] [PROPERTIES ("key"="value", ...)] | ||
| INSTALL PLUGIN FROM source [PROPERTIES ("key"="value", ...)] |
There was a problem hiding this comment.
Suggested change
| INSTALL PLUGIN FROM source [PROPERTIES ("key"="value", ...)] | |
| INSTALL PLUGIN FROM <source> [PROPERTIES ("<key>"="<value>", ...)] |
Comment on lines
40
to
44
| - source | ||
| The plugin path to be installed, supports three types： | ||
| 1. An absolute path to a zip file | ||
| 2. An absolute path to a plugin directory | ||
| 3. Points to a zip file download path with http or https protocol |
There was a problem hiding this comment.
- 使用有序列表
- 带上尖括号，使用 inline code
- 加粗
- 说明的地方使用引用
Suggested change
| - source | |
| The plugin path to be installed, supports three types： | |
| 1. An absolute path to a zip file | |
| 2. An absolute path to a plugin directory | |
| 3. Points to a zip file download path with http or https protocol | |
| ** 1. `<source>`** | |
| > The plugin path to be installed, supports three types： | |
| > 1. An absolute path to a zip file | |
| > 2. An absolute path to a plugin directory | |
| > 3. Points to a zip file download path with http or https protocol |
|
|
||
| | Permissions | Object | Notes | | ||
| |:-----------|:-----|:--------------| | ||
| | Admin_priv | The entire cluster | Requires administrative privileges for the entire cluster | |
There was a problem hiding this comment.
Suggested change
| | Admin_priv | The entire cluster | Requires administrative privileges for the entire cluster | | |
| | ADMIN_PRIV | The entire cluster | Requires administrative privileges for the entire cluster | |
Comment on lines
40
to
44
| |Description|Version|JavaVersion|ClassName|SoName|Sources|Status|Properties| | ||
| |-----------|-------|-----------|---------|------|-------|------|----------| | ||
| |builtin audit loader, to load audit log to internal table|2.1.0|1.8.31|org.apache.doris.plugin.audit.AuditLoader||Builtin|INSTALLED|{}| | ||
| |builtin audit logger|0.12.0|1.8.31|org.apache.doris.plugin.audit.AuditLogBuilder||Builtin|INSTALLED|{}| | ||
| |builtin sql dialect converter|2.1.0|1.8.31|org.apache.doris.plugin.dialect.HttpDialectConverterPlugin||Builtin|INSTALLED|{}| |
There was a problem hiding this comment.
这里是要说明返回的结果，每一列的含义。而不是给一个返回值的示例
Comment on lines
58
to
60
| ```SQL | ||
| SHOW PLUGINS; | ||
| ``` |
There was a problem hiding this comment.
这个后面，要把SHOW PLUGINS; 的结果写出来
| @@ -29,27 +29,33 @@ under the License. | |||
|
|
|||
| This statement is used to uninstall a plugin. | |||
|
|
|||
| grammar: | |||
| ## Syntax： | |||
|
|
|||
| ```sql | |||
| UNINSTALL PLUGIN plugin_name; | |||
There was a problem hiding this comment.
Suggested change
| UNINSTALL PLUGIN plugin_name; | |
| UNINSTALL PLUGIN <plugin_name>; |
|
|
||
| Only non-builtin plugins can be uninstalled. | ||
| - plugin_name |
morrySnow
reviewed
Jan 24, 2025
|
|
||
| ## Optional parameters | ||
|
|
||
| ** 1. `<PROPERTIES>`** |
There was a problem hiding this comment.
Suggested change
| ** 1. `<PROPERTIES>`** | |
| ** 1. `[PROPERTIES ("<key>"="<value>", ...)]`** |
morrySnow
reviewed
Jan 24, 2025
Comment on lines
40
to
42
| |Description| Version | JavaVersion | ClassName | SoName | Sources | Status | Properties | | ||
| |-----------|---------|-------------|------|----------|------|------|-------| | ||
| |Corresponding plug-in description| Plug-in corresponding version number | Corresponding Java version number | Program class name | Program shared object name | Plugin Source | Installation Status | Plugin Properties | |
There was a problem hiding this comment.
| Column | Description |
| ------ | ----------- |
| Description | Corresponding plug-in description |
| .... | .... |
| Properties | Plugin Properties |
Comment on lines
61
to
65
| |Description|Version|JavaVersion|ClassName|SoName|Sources|Status|Properties| | ||
| |-----------|-------|-----------|---------|------|-------|------|----------| | ||
| |builtin audit loader, to load audit log to internal table|2.1.0|1.8.31|org.apache.doris.plugin.audit.AuditLoader||Builtin|INSTALLED|{}| | ||
| |builtin audit logger|0.12.0|1.8.31|org.apache.doris.plugin.audit.AuditLogBuilder||Builtin|INSTALLED|{}| | ||
| |builtin sql dialect converter|2.1.0|1.8.31|org.apache.doris.plugin.dialect.HttpDialectConverterPlugin||Builtin|INSTALLED|{}| |
There was a problem hiding this comment.
这个地方要用 mysql 客户端执行出来的返回结果。形如
+----+-----+
| .. | ... |
....
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Versions
Languages
Docs Checklist