Fix routine load statements documentation docs

apache · Jan 23, 2025 · 8be4887 · 8be4887
1 parent 52702e1
commit 8be4887
Show file tree

Hide file tree

Showing 48 changed files with 4,108 additions and 3,657 deletions.
diff --git a/...l-manual/sql-statements/data-modification/load-and-export/ALTER-ROUTINE-LOAD.md b/...l-manual/sql-statements/data-modification/load-and-export/ALTER-ROUTINE-LOAD.md
@@ -27,98 +27,96 @@ under the License.
 
 ## Description
 
-This syntax is used to modify an already created routine import job.
+This syntax is used to modify an existing routine load job. Only jobs in PAUSED state can be modified.
 
-Only jobs in the PAUSED state can be modified.
-
-grammar:
+## Syntax
 
 ```sql
-ALTER ROUTINE LOAD FOR [db.]job_name
-[job_properties]
-FROM data_source
-[data_source_properties]
+ALTER ROUTINE LOAD FOR [<db.>]<job_name>
+[<job_properties>]
+FROM <data_source>
+[<data_source_properties>]
 ```
 
-1. `[db.]job_name`
-
-   Specifies the job name to modify.
-
-2. `tbl_name`
-
-   Specifies the name of the table to be imported.
-
-3. `job_properties`
-
-   Specifies the job parameters that need to be modified. Currently, only the modification of the following parameters is supported:
-
-   1. `desired_concurrent_number`
-   2. `max_error_number`
-   3. `max_batch_interval`
-   4. `max_batch_rows`
-   5. `max_batch_size`
-   6. `jsonpaths`
-   7. `json_root`
-   8. `strip_outer_array`
-   9. `strict_mode`
-   10. `timezone`
-   11. `num_as_string`
-   12. `fuzzy_parse`
-   13. `partial_columns`
-   14. `max_filter_ratio`
-
-
-4. `data_source`
-
-   The type of data source. Currently supports:
-
-   KAFKA
-
-5. `data_source_properties`
-
-   Relevant properties of the data source. Currently only supports:
-
-   1. `kafka_partitions`
-   2. `kafka_offsets`
-   3. `kafka_broker_list`
-   4. `kafka_topic`
-   5. Custom properties, such as `property.group.id`
-
-   Note:
-
-   1. `kafka_partitions` and `kafka_offsets` are used to modify the offset of the kafka partition to be consumed, only the currently consumed partition can be modified. Cannot add partition.
-
-## Example
-
-1. Change `desired_concurrent_number` to 1
-
-   ```sql
-   ALTER ROUTINE LOAD FOR db1.label1
-   PROPERTIES
-   (
-       "desired_concurrent_number" = "1"
-   );
-   ```
-
-2. Modify `desired_concurrent_number` to 10, modify the offset of the partition, and modify the group id.
-
-   ```sql
-   ALTER ROUTINE LOAD FOR db1.label1
-   PROPERTIES
-   (
-       "desired_concurrent_number" = "10"
-   )
-   FROM kafka
-   (
-       "kafka_partitions" = "0, 1, 2",
-       "kafka_offsets" = "100, 200, 100",
-       "property.group.id" = "new_group"
-   );
-   ```
-
-## Keywords
-
-    ALTER, ROUTINE, LOAD
-
-## Best Practice
-
+## Required Parameters
+
+**1. `[db.]job_name`**
+
+> Specifies the name of the job to be modified. The identifier must begin with a letter character and cannot contain spaces or special characters unless the entire identifier string is enclosed in backticks.
+>
+> The identifier cannot use reserved keywords. For more details, please refer to identifier requirements and reserved keywords.
+
+**2. `job_properties`**
+
+> Specifies the job parameters to be modified. Currently supported parameters include:
+> 
+> - desired_concurrent_number
+> - max_error_number
+> - max_batch_interval
+> - max_batch_rows
+> - max_batch_size
+> - jsonpaths
+> - json_root
+> - strip_outer_array
+> - strict_mode
+> - timezone
+> - num_as_string
+> - fuzzy_parse
+> - partial_columns
+> - max_filter_ratio
+
+**3. `data_source`**
+
+> The type of data source. Currently supports:
+> 
+> - KAFKA
+
+**4. `data_source_properties`**
+
+> Properties related to the data source. Currently supports:
+> 
+> - kafka_partitions
+> - kafka_offsets
+> - kafka_broker_list
+> - kafka_topic
+> - Custom properties, such as property.group.id
+
+## Privilege Control
+
+Users executing this SQL command must have at least the following privileges:
+
+| Privilege | Object | Notes |
+| :-------- | :----- | :---- |
+| LOAD_PRIV | Table | SHOW ROUTINE LOAD requires LOAD privilege on the table |
+
+## Notes
+
+- `kafka_partitions` and `kafka_offsets` are used to modify the offset of kafka partitions to be consumed, and can only modify currently consumed partitions. New partitions cannot be added.
+
+## Examples
+
+- Modify `desired_concurrent_number` to 1
+
+    ```sql
+    ALTER ROUTINE LOAD FOR db1.label1
+    PROPERTIES
+    (
+        "desired_concurrent_number" = "1"
+    );
+    ```
+
+- Modify `desired_concurrent_number` to 10, modify partition offsets, and modify group id
+
+    ```sql
+    ALTER ROUTINE LOAD FOR db1.label1
+    PROPERTIES
+    (
+        "desired_concurrent_number" = "10"
+    )
+    FROM kafka
+    (
+        "kafka_partitions" = "0, 1, 2",
+        "kafka_offsets" = "100, 200, 100",
+        "property.group.id" = "new_group"
+    );
+    ```