morrySnow commented on code in PR #1843: URL: https://github.com/apache/doris-website/pull/1843#discussion_r1919776145
########## docs/sql-manual/sql-statements/Data-Definition-Statements/Alter/CANCEL-ALTER-TABLE.md: ########## @@ -24,87 +24,91 @@ specific language governing permissions and limitations under the License. --> -## CANCEL-ALTER-TABLE +## Description -### Name +This statement is used to cancel (revoke) an ongoing ALTER TABLE operation. You can use this command to terminate an ALTER TABLE operation while it is being executed. -CANCEL ALTER TABLE - -### Description - -This statement is used to undo an ALTER operation. - -1. Undo the ALTER TABLE COLUMN operation - -grammar: +## Syntax ```sql -CANCEL ALTER TABLE COLUMN -FROM db_name.table_name +CANCEL ALTER TABLE COLUMN|ROLLUP FROM <db_name>.<table_name> [ <job_id1> [ , <job_id2> ... ]] Review Comment: ```suggestion CANCEL ALTER TABLE { COLUMN | MATERIALIZED VIEW | ROLLUP } FROM <db_name>.<table_name> [ ( <job_id1> [ , <job_id2> ... ] ) ] ``` ########## docs/sql-manual/sql-statements/Data-Definition-Statements/Alter/CANCEL-ALTER-TABLE.md: ########## @@ -24,87 +24,91 @@ specific language governing permissions and limitations under the License. --> -## CANCEL-ALTER-TABLE +## Description -### Name +This statement is used to cancel (revoke) an ongoing ALTER TABLE operation. You can use this command to terminate an ALTER TABLE operation while it is being executed. -CANCEL ALTER TABLE - -### Description - -This statement is used to undo an ALTER operation. - -1. Undo the ALTER TABLE COLUMN operation - -grammar: +## Syntax ```sql -CANCEL ALTER TABLE COLUMN -FROM db_name.table_name +CANCEL ALTER TABLE COLUMN|ROLLUP FROM <db_name>.<table_name> [ <job_id1> [ , <job_id2> ... ]] ``` -2. Undo the ALTER TABLE ROLLUP operation +## Required Parameters +**1. `COLUMN|ROLLUP`** Review Comment: ```suggestion **1. `{ COLUMN | ROLLUP }`** ``` ########## docs/sql-manual/sql-statements/Data-Definition-Statements/Alter/CANCEL-ALTER-TABLE.md: ########## @@ -24,87 +24,91 @@ specific language governing permissions and limitations under the License. --> -## CANCEL-ALTER-TABLE +## Description -### Name +This statement is used to cancel (revoke) an ongoing ALTER TABLE operation. You can use this command to terminate an ALTER TABLE operation while it is being executed. -CANCEL ALTER TABLE - -### Description - -This statement is used to undo an ALTER operation. - -1. Undo the ALTER TABLE COLUMN operation - -grammar: +## Syntax ```sql -CANCEL ALTER TABLE COLUMN -FROM db_name.table_name +CANCEL ALTER TABLE COLUMN|ROLLUP FROM <db_name>.<table_name> [ <job_id1> [ , <job_id2> ... ]] ``` -2. Undo the ALTER TABLE ROLLUP operation +## Required Parameters +**1. `COLUMN|ROLLUP`** +>Specify the type of modification to cancel, must choose one of: +>- COLUMN: Cancel table column modification operations +>- ROLLUP: Cancel materialized view modification operations -grammar: +**2.`<db_name>`** +> Specifies the identifier (that is, the name) of the database. +> +> Identifier must begin with an alphabet character (if Unicode name support is enabled, any language character is allowed), and must not contain spaces or special characters, except for the entire identifier string enclosed in quotes (e.g., `My Database`). +> +> Identifier cannot use reserved keywords. +> +> For more information, see Identifier Requirements and Reserved Keywords. -```sql -CANCEL ALTER TABLE ROLLUP -FROM db_name.table_name -``` +**3.`<table_name>`** +> Specifies the identifier (that is, the name) of the table, within its database (Database). +> +> Identifier must begin with an alphabet character (if Unicode name support is enabled, any language character is allowed), and must not contain spaces or special characters, except for the entire identifier string enclosed in quotes (e.g., `My Object`). +> +> Identifier cannot use reserved keywords. +> +> For more information, see Identifier Requirements and Reserved Keywords. -3. Batch cancel rollup operations based on job id - -grammar: - -```sql -CANCEL ALTER TABLE ROLLUP -FROM db_name.table_name (jobid,...) -``` +## Optional Parameters +**1. `<job_id>`** +> The specific job ID to cancel. +> +> If a job ID is specified, only the specified job is canceled; if not specified, all ongoing modifications of the specified type (COLUMN or ROLLUP) on the table are canceled. +> +> You can specify multiple job IDs, separated by commas. +> +> You can obtain job IDs by using the `SHOW ALTER TABLE COLUMN` or `SHOW ALTER TABLE ROLLUP` command. -Notice: -- This command is an asynchronous operation. You need to use `show alter table rollup` to check the task status to confirm whether the execution is successful or not. +## Permission Control +Users who execute this SQL command must have at least the following permissions: -4. Undo the ALTER CLUSTER operation -grammar: +| Privilege | Object | Notes | +| :---------------- | :------------- | :---------------------------- | +| ALTER_PRIV | Table | CANCEL ALTER TABLE belongs to table ALTER operation | -``` -(To be implemented...) -``` -### Example +## Notes +- This command is an asynchronous operation, and the actual execution result needs to be confirmed by using `SHOW ALTER TABLE COLUMN` or `SHOW ALTER TABLE ROLLUP` to check the status of the task. -1. Undo the ALTER COLUMN operation on my_table. +## Example - [CANCEL ALTER TABLE COLUMN] +1. Cancel ALTER TABLE COLUMN operation ```sql CANCEL ALTER TABLE COLUMN -FROM example_db.my_table; +FROM db_name.table_name ``` -1. Undo the ADD ROLLUP operation under my_table. +2. Cancel ALTER TABLE ROLLUP operation - [CANCEL ALTER TABLE ROLLUP] ```sql CANCEL ALTER TABLE ROLLUP -FROM example_db.my_table; +FROM db_name.table_name ``` -1. Undo the ADD ROLLUP operation under my_table according to the job id. +3. Cancel ALTER TABLE ROLLUP operation in batches based on job ID - [CANCEL ALTER TABLE ROLLUP] ```sql CANCEL ALTER TABLE ROLLUP -FROM example_db.my_table(12801,12802); +FROM db_name.table_name (jobid,...) ``` -### Keywords - - CANCEL, ALTER, TABLE, CANCEL ALTER -### Best Practice +4. Cancel ALTER CLUSTER operation +```sql +(To be implemented...) +``` Review Comment: 这是个未完成的TODO? -- 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: commits-unsubscr...@doris.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org For additional commands, e-mail: commits-h...@doris.apache.org