refine syntax consitency (#522)

Author: chenziliang

docs/alert.md

@@ -11,11 +11,11 @@ Alerts are often used in combination with [Scheduled Tasks](/task) and [Material
 ## Create Alert
 
 ```sql
-CREATE ALERT [IF NOT EXISTS] <db.alert-name>
+CREATE ALERT [IF NOT EXISTS] <db.alert_name>
 BATCH <N> EVENTS WITH TIMEOUT <interval>
 LIMIT <M> ALERTS PER <interval>
-CALL <python-udf-name>
-AS <streaming-select-query>;
+CALL <python_udf_name>
+AS <streaming_select_query>;
 ```
 
 :::info
@@ -126,11 +126,11 @@ SHOW ALERTS [FROM db] [SETTINGS verbose=true]
 ## Show Alert
 
 ```sql
-SHOW CREATE ALERT <db.alert-name> [SETTINGS show_multi_versions=true]
+SHOW CREATE ALERT <db.alert_name> [SETTINGS show_multi_versions=true]
 ```
 
 ## Drop Alert
 
 ```sql
-DROP ALERT <db.alert-name>
+DROP ALERT <db.alert_name>
 ```

docs/append-stream-codecs.md

@@ -101,7 +101,7 @@ CREATE STREAM mystream
 ORDER BY x;
 ```
 
-:::note
+:::info
 If compression needs to be applied, it must be explicitly specified. Otherwise, only encryption will be applied to data.
 :::
 

docs/append-stream-ttl.md

@@ -43,7 +43,7 @@ Expired data is removed only during the merge process, which runs asynchronously
 To accelerate this cleanup, you can manually trigger a merge by running the `OPTIMIZE` command. This attempts to start an unscheduled merge of data parts for a stream:
 
 ```sql
-OPTIMIZE STREAM <db.stream-name>;
+OPTIMIZE STREAM <db.stream_name>;
 ```
 
 ## Examples

docs/append-stream.md

@@ -5,13 +5,13 @@ An **Append Stream** in Timeplus is best understood as a **streaming ClickHouse
 ## Create Append Stream
 
 ```sql
-CREATE STREAM [IF NOT EXISTS] <db.stream-name>
+CREATE STREAM [IF NOT EXISTS] <db.stream_name>
 (
-    name1 [type1] [DEFAULT | ALIAS expr1] [COMMENT 'column-comment'] [compression_codec],
-    name2 [type2] [DEFAULT | ALIAS expr2] [COMMENT 'column-comment'] [compression_codec],
+    name1 [type1] [DEFAULT | ALIAS expr1] [COMMENT 'column_comment'] [compression_codec],
+    name2 [type2] [DEFAULT | ALIAS expr2] [COMMENT 'column_comment'] [compression_codec],
     ...
-    INDEX index-name1 expr1 TYPE type1(...) [GRANULARITY value1],
-    INDEX index-name2 expr2 TYPE type2(...) [GRANULARITY value1],
+    INDEX index_name1 expr1 TYPE type1(...) [GRANULARITY value1],
+    INDEX index_name2 expr2 TYPE type2(...) [GRANULARITY value1],
     ...
 )
 ORDER BY <expression>
@@ -23,25 +23,25 @@ ORDER BY <expression>
 ]
 COMMENT '<stream-comment>'
 SETTINGS
-    shards=<num-of-shards>,
-    replication_factor=<replication-factor>,
+    shards=<num_of_shards>,
+    replication_factor=<replication_factor>,
     mode=['append'|'changelog_kv'|'versioned_kv'],
-    version_column=<version-column>,
+    version_column=<version_column>,
     storage_type=['hybrid'|'streaming'|'inmemory'],
     logstore_codec=['lz4'|'zstd'|'none'],
-    logstore_retention_bytes=<retention-bytes>,
-    logstore_retention_ms=<retention-ms>,
-    placement_policies='<placement-policies>',
-    shared_disk='<shared-disk>',
+    logstore_retention_bytes=<retention_bytes>,
+    logstore_retention_ms=<retention_ms>,
+    placement_policies='<placement_policies>',
+    shared_disk='<shared_disk>',
     ingest_mode=['async'|'sync'],
     ack=['quorum'|'local'|'none'],
-    ingest_batch_max_bytes=<batch-bytes>,
-    ingest_batch_timeout_ms=<batch-timeout>,
-    fetch_threads=<remote-fetch-threads>,
-    flush_threshold_count=<batch-flush-rows>,
-    flush_threshold_ms=<batch-flush-timeout>,
-    flush_threshold_bytes=<batch-flush-size>,
-    merge_with_ttl_timeout=<timeout-in-seconds>;
+    ingest_batch_max_bytes=<batch_bytes>,
+    ingest_batch_timeout_ms=<batch_timeout>,
+    fetch_threads=<remote_fetch_threads>,
+    flush_threshold_count=<batch_flush_rows>,
+    flush_threshold_ms=<batch_flush_timeout>,
+    flush_threshold_bytes=<batch_flush_size>,
+    merge_with_ttl_timeout=<timeout_in_seconds>;
 ```
 
 ### Storage Architecture

docs/materialized-view-checkpoint.md

@@ -61,7 +61,7 @@ AS
 SELECT
     window_start AS win_start,
     s,
-    SUM(i)
+    sum(i)
 FROM tumble(source, 5s)
 GROUP BY window_start, s;
 ```

docs/materialized-view-lifecycle.md

@@ -29,13 +29,13 @@ Timeplus provides system commands to manage Materialized Views.
 ### Pause Materialized View
 
 ```sql
-SYSTEM PAUSE MATERIALIZED VIEW <db.mat-view-name> [PERMANENT];
+SYSTEM PAUSE MATERIALIZED VIEW <db.mat_view_name> [PERMANENT];
 ```
 
 When pausing a Materialized View:
 
 1. The leader triggers a checkpoint.
-2. The leader stops the query pipeline and marks the state as Paused.
+2. The leader stops the query pipeline and marks the state as `Paused`.
 3. If `PERMANENT` is specified, the system updates `pause_on_start=true` in the DDL metadata and commits it to the metastore.
    - This ensures the view remains paused even after node restarts.
    - Without `PERMANENT`, the view will resume automatically on restart.
@@ -48,7 +48,7 @@ SYSTEM PAUSE MATERIALIZED VIEW tumble_aggr_mv;
 ### Resume Materialized View
 
 ```sql
-SYSTEM RESUME MATERIALIZED VIEW <db.mat-view-name> [PERMANENT];
+SYSTEM RESUME MATERIALIZED VIEW <db.mat_view_name> [PERMANENT];
 ```
 
 When resuming a view:
@@ -70,7 +70,7 @@ Aborting is similar to pausing, but:
 - The `pause_on_start` setting is not modified in the DDL metadata.
 
 ```sql
-SYSTEM ABORT MATERIALIZED VIEW <db.mat-view-name>;
+SYSTEM ABORT MATERIALIZED VIEW <db.mat_view_name>;
 ```
 
 **Example**:
@@ -87,7 +87,7 @@ Used to recover views in the `Error` state. Recovery involves:
 3. Transitioning to ExecutingPipeline.
 
 ```sql
-SYSTEM RECOVER MATERIALIZED VIEW <db.mat-view-name>;
+SYSTEM RECOVER MATERIALIZED VIEW <db.mat_view_name>;
 ```
 
 **Example**:
@@ -100,7 +100,7 @@ SYSTEM RECOVER MATERIALIZED VIEW tumble_aggr_mv;
 For Materialized Views governed by Raft, you can transfer leadership to another replica. This helps balance workload or mitigate temporary issues.
 
 ```sql
-SYSTEM TRANSFER LEADER <db.mat-view-name> <mat-view-shard-id> FROM <leader-node> TO <follower-node>;
+SYSTEM TRANSFER LEADER <db.mat_view_name> <mat_view_shard_id> FROM <leader_node> TO <follower_node>;
 ```
 
 :::info

docs/materialized-view.md

@@ -44,8 +44,8 @@ you can build **complex, end-to-end data processing pipelines** with Materialize
 ## Create Materialized View
 
 ```sql
-CREATE MATERIALIZED VIEW [IF NOT EXISTS] <db.mat-view-name>
-[INTO <db.target-stream-or-table>]
+CREATE MATERIALIZED VIEW [IF NOT EXISTS] <db.mat_view_name>
+[INTO <db.target_stream_or_table>]
 AS
 <SELECT ...>
 [SETTINGS
@@ -320,7 +320,7 @@ DROP VIEW [IF EXISTS] db.<view_name>;
 You can modify the following Materialized View query settings using:
 
 ```sql
-ALTER VIEW <db.mat-view-name> MODIFY QUERY SETTING <key>=<value>, <key>=<value>, ...;
+ALTER VIEW <db.mat_view_name> MODIFY QUERY SETTING <key>=<value>, <key>=<value>, ...;
 ```
 
 Supported settings changes include:
@@ -341,7 +341,7 @@ ALTER VIEW tumble_aggr_mv MODIFY QUERY SETTING checkpoint_interval=-1, enable_dl
 You can update the comment associated with a Materialized View:
 
 ```sql
-ALTER VIEW <db.mat-view-name> MODIFY COMMENT '<new-comments>';
+ALTER VIEW <db.mat_view_name> MODIFY COMMENT '<new-comments>';
 ```
 
 **Example:**
@@ -420,5 +420,5 @@ GROUP BY
     window_start, s
 SETTINGS
     recovery_policy='best_effort',            -- Use 'best_effort' recovery policy
-    input_format_ignore_parsing_errors=true; -- Skip parsing errors for better resiliency
+    input_format_ignore_parsing_errors=true;  -- Skip parsing errors for better resiliency
 ```

docs/mutable-stream-indexes.md

@@ -121,7 +121,7 @@ When you do this, the system scans all existing data in the background to build
 This process is **asynchronous**, so the index becomes usable only after the build completes.
 
 ```sql
-ALTER STREAM <db.mutable-stream-name> ADD INDEX <index-name> (<columns>);
+ALTER STREAM <db.mutable_stream_name> ADD INDEX <index_name> (<columns>);
 ```
 
 **Example**:
@@ -137,7 +137,7 @@ Until the new secondary index is fully built, using it to accelerate a historica
 ## Drop Secondary Index
 
 ```sql
-ALTER STREAM <db.mutable-stream-name> DROP INDEX <index-name>;
+ALTER STREAM <db.mutable_stream_name> DROP INDEX <index_name>;
 ```
 
 **Example**:
@@ -157,7 +157,7 @@ When executing a query against a Mutable Stream, **Timeplus automatically select
 You can manually hint which secondary index to use with the query setting:
 
 ```sql
-SETTINGS use_index='<secondary-idx-name>'
+SETTINGS use_index='<secondary_idx_name>'
 ```
 
 Timeplus will still validate whether the chosen index is applicable.
@@ -206,7 +206,7 @@ The rebuild process runs **asynchronously** in the background.
 
 ```sql
 -- Clear the secondary index and then rebuild it
-ALTER STREAM <db.mutable-stream-name> MATERIALIZE INDEX <secondary-index-name> WITH CLEAR;
+ALTER STREAM <db.mutable_stream_name> MATERIALIZE INDEX <secondary_index_name> WITH CLEAR;
 ```
 
 **Example**:

docs/mutable-stream-ttl.md

@@ -20,7 +20,7 @@ If a row has not been updated for longer than `ttl_seconds`, it becomes **eligib
 ```sql
 CREATE MUTABLE STREAM ...
 SETTINGS
-    ttl_seconds=<ttl-seconds>, ...
+    ttl_seconds=<ttl_seconds>, ...
 ```
 
 ### Example
@@ -52,8 +52,8 @@ The specified **TTL column** represents the event timestamp of each row. During
 ```sql
 CREATE MUTABLE STREAM ...
 SETTINGS
-    ttl_seconds=<ttl-seconds>,
-    ttl_column=<ttl-column>, ...
+    ttl_seconds=<ttl_seconds>,
+    ttl_column=<ttl_column>, ...
 ```
 
 ### Example
@@ -85,8 +85,8 @@ You can control how frequently these compactions run by setting `periodic_compac
 ```
 CREATE MUTABLE STREAM ...
 SETTINGS
-    ttl_seconds = <ttl-seconds>,
-    ttl_column = <ttl-column>,
+    ttl_seconds = <ttl_seconds>,
+    ttl_column = <ttl_column>,
     kvstore_options = 'periodic_compaction_seconds=1800;';
 ```
 

docs/mutable-stream.md

@@ -18,43 +18,43 @@ For more details on the motivation behind Mutable Streams, see [this blog post](
 ```sql
 CREATE MUTABLE STREAM [IF NOT EXISTS] <db.mutable-stream-name>
 (
-    name1 [type1] [DEFAULT | ALIAS expr1] [COMMENT 'column-comment'],
-    name2 [type2] [DEFAULT | ALIAS expr1] [COMMENT 'column-comment'],
+    name1 [type1] [DEFAULT | ALIAS expr1] [COMMENT 'column_comment'],
+    name2 [type2] [DEFAULT | ALIAS expr1] [COMMENT 'column_comment'],
     ...
     <column definitions>,
-    INDEX <secondary-index-name1> (column, ...) [UNIQUE] STORING (column, ...),
-    INDEX <secondary-index-name2> (column, ...) [UNIQUE] STORING (column, ...),
+    INDEX <secondary_index_name1> (column, ...) [UNIQUE] STORING (column, ...),
+    INDEX <secondary_index_name2> (column, ...) [UNIQUE] STORING (column, ...),
     ...
-    FAMILY <column-family-name1> (column, ...),
-    FAMILY <column-family-name2> (column, ...),
+    FAMILY <column_family_name1> (column, ...),
+    FAMILY <column_family_name2> (column, ...),
     ...
 )
 PRIMARY KEY (column, ...)
-COMMENT '<stream-comment>'
+COMMENT '<stream_comment>'
 SETTINGS
-    shards=<num-of-shards>,
-    replication_factor=<replication-factor>,
-    version_column=<version-column>,
+    shards=<num_of_shards>,
+    replication_factor=<replication_factor>,
+    version_column=<version_column>,
     coalesced=[true|false],
     logstore_codec=['lz4'|'zstd'|'none'],
-    logstore_retention_bytes=<retention-bytes>,
-    logstore_retention_ms=<retention-ms>,
-    ttl_seconds=<ttl-seconds>,
-    ttl_column=<ttl-column>,
+    logstore_retention_bytes=<retention_bytes>,
+    logstore_retention_ms=<retention_ms>,
+    ttl_seconds=<ttl_seconds>,
+    ttl_column=<ttl_column>,
     auto_cf=[true|false],
-    placement_policies='<placement-policies>',
+    placement_policies='<placement_policies>',
     late_insert_overrides=[true|false],
-    shared_disk='<shared-disk>',
+    shared_disk='<shared_disk>',
     ingest_mode=['async'|'sync'],
     ack=['quorum'|'local'|'none'],
-    ingest_batch_max_bytes=<batch-bytes>,
-    ingest_batch_timeout_ms=<batch-timeout>,
-    fetch_threads=<remote-fetch-threads>,
-    flush_rows=<batch-flush-rows>,
-    flush_ms=<batch-flush-timeout>,
+    ingest_batch_max_bytes=<batch_bytes>,
+    ingest_batch_timeout_ms=<batch_timeout>,
+    fetch_threads=<remote_fetch_threads>,
+    flush_rows=<batch_flush_rows>,
+    flush_ms=<batch_flush_timeout>,
     log_kvstore=[true|false],
     kvstore_codec=['snappy'|'lz4'|'zstd'],
-    kvstore_options='<kvstore-options>',
+    kvstore_options='<kvstore_options>',
     enable_hash_index=[true|false],
     enable_statistics=[true|false];
 ```
@@ -348,7 +348,7 @@ Using column families can slow down ingestion speed, since each family is intern
 You can delete rows from a Mutable Stream using the `DELETE` statement:
 
 ```sql
-DELETE FROM <db.mutable-stream-name> WHERE <predicates>;
+DELETE FROM <db.mutable_stream_name> WHERE <predicates>;
 ```
 
 - If the `WHERE` predicates can leverage the primary index or a secondary index, the delete operation will be fast.