morrySnow commented on code in PR #2036:
URL: https://github.com/apache/doris-website/pull/2036#discussion_r1953768464
##########
docs/sql-manual/sql-statements/table-and-view/index/CREATE-INDEX.md:
##########
@@ -27,29 +27,92 @@ under the License.
## Description
-This statement is used to create an index
-grammar:
+Create a new index on a table. The table name and index name must be
specified. Optionally, you can specify the index type, properties, and comments.
+
+## Syntax
+
```sql
-CREATE INDEX [IF NOT EXISTS] index_name ON table_name (column [, ...],) [USING
INVERTED] [COMMENT 'balabala'];
+CREATE INDEX [IF NOT EXISTS] <index_name>
+ ON <table_name> (<column_name> [, ...])
+ [USING {INVERTED | NGRAM_BF}]
+ [PROPERTIES ("<key>" = "<value>"[ , ...])]
+ [COMMENT '<index_comment>']
```
-Notice:
-- INVERTED indexes are only created on a single column
-## Example
+## Required Parameters
-1. Create a inverted index for siteid on table1
+**1. `<index_name>`**
- ```sql
- CREATE INDEX [IF NOT EXISTS] index_name ON table1 (siteid) USING INVERTED
COMMENT 'balabala';
- ```
+> Specifies the identifier (i.e., name) of the index, which must be unique
within its table.
+>
+> The identifier must start with a letter character (if Unicode name support
is enabled, it can be any character from any language) and cannot contain
spaces or special characters unless the entire identifier string is enclosed in
backticks (e.g., `My Object`).
+>
+> The identifier cannot be a reserved keyword.
+>
+> For more details, refer to the requirements for identifiers and reserved
keywords.
+**2. <table_name>**
Review Comment:
后面的都没改呀，所有的参数都要加上反引号，否则尖括号在md中会有转义问题
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
