Skip to content

Fix latest user guide doc formatting issues #1163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CritasWang merged 1 commit into from
Jun 18, 2026
Merged

Fix latest user guide doc formatting issues #1163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/UserGuide/latest-Table/AI-capability/AINode_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,21 +105,21 @@ Detailed meanings of SQL parameters:

- **Model configuration file**: Parameters related to the model structure provided during registration, which must include input and output dimensions for inference:

| **Parameter Name** | **Description** | **Example** |
| ------------ | ---------------------------- | -------- |
| input_shape | Rows and columns of model input | [96,2] |
| output_shape | Rows and columns of model output | [48,2] |
| **Parameter Name** | **Description** | **Example** |
| ------------------ | -------------------------------- | ----------- |
| input_shape | Rows and columns of model input | [96,2] |
| output_shape | Rows and columns of model output | [48,2] |

In addition to inference, data types of input and output can also be specified:

| **Parameter Name** | **Description** | **Example** |
| **Parameter Name** | **Description** | **Example** |
| ------------------ | ------------------------- | ---------------------- |
| input_type | Data type of model input | ['float32', 'float32'] |
| output_type | Data type of model output | ['float32', 'float32'] |

Additional notes can be specified for model management display:

| **Parameter Name** | **Description** | **Example** |
| **Parameter Name** | **Description** | **Example** |
| ------------------ | --------------------------------------------- | -------------------------------------------- |
| attributes | Optional notes set by users for model display | 'model_type': 'dlinear', 'kernel_size': '25' |

Expand Down Expand Up @@ -407,4 +407,4 @@ AINode uses IoTDB's authentication for permission management. Users need `USE_MO
| initialization_method | Initialization method: - `"estimated"`: Fit to estimate initial states - `"heuristic"`: Use heuristic for initial level/trend/season - `"known"`: User-provided initial values - `"legacy-heuristic"`: Legacy compatibility | "estimated" |
| optimized | Optimize parameters via maximum likelihood. | True |
| remove_bias | Remove bias to make residuals' mean zero. | False |
| use_brute | Use brute-force grid search for initial parameters. | |
| use_brute | Use brute-force grid search for initial parameters. | |
14 changes: 7 additions & 7 deletions src/UserGuide/latest-Table/AI-capability/AINode_timecho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,21 +104,21 @@ Detailed meanings of SQL parameters:

- **Model configuration file**: Parameters related to the model structure provided during registration, which must include input and output dimensions for inference:

| **Parameter Name** | **Description** | **Example** |
| ------------ | ---------------------------- | -------- |
| input_shape | Rows and columns of model input | [96,2] |
| output_shape | Rows and columns of model output | [48,2] |
| **Parameter Name** | **Description** | **Example** |
| ------------------ | -------------------------------- | ----------- |
| input_shape | Rows and columns of model input | [96,2] |
| output_shape | Rows and columns of model output | [48,2] |

In addition to inference, data types of input and output can also be specified:

| **Parameter Name** | **Description** | **Example** |
| **Parameter Name** | **Description** | **Example** |
| ------------------ | ------------------------- | ---------------------- |
| input_type | Data type of model input | ['float32', 'float32'] |
| output_type | Data type of model output | ['float32', 'float32'] |

Additional notes can be specified for model management display:

| **Parameter Name** | **Description** | **Example** |
| **Parameter Name** | **Description** | **Example** |
| ------------------ | --------------------------------------------- | -------------------------------------------- |
| attributes | Optional notes set by users for model display | 'model_type': 'dlinear', 'kernel_size': '25' |

Expand Down Expand Up @@ -479,4 +479,4 @@ AINode uses IoTDB's authentication for permission management. Users need `USE_MO
| initialization_method | Initialization method: - `"estimated"`: Fit to estimate initial states - `"heuristic"`: Use heuristic for initial level/trend/season - `"known"`: User-provided initial values - `"legacy-heuristic"`: Legacy compatibility | "estimated" |
| optimized | Optimize parameters via maximum likelihood. | True |
| remove_bias | Remove bias to make residuals' mean zero. | False |
| use_brute | Use brute-force grid search for initial parameters. | |
| use_brute | Use brute-force grid search for initial parameters. | |
4 changes: 2 additions & 2 deletions src/UserGuide/latest-Table/API/Programming-Python-Native-API_timecho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ if has_next:

| Function Name | Description | Parameters | Return Value |
|---------------|-------------|------------|--------------|
| `encode_object_cell` | Encodes a single OBJECT cell into wire-format bytes | `is_eof: bool`,<br>`offset: int`,<br>`content: bytes` | `bytes`: `|[eof 1B]|[offset 8B BE]|[payload]|` |
| `encode_object_cell` | Encodes a single OBJECT cell into wire-format bytes | `is_eof: bool`,<br>`offset: int`,<br>`content: bytes` | `bytes`: `\|[eof 1B]\|[offset 8B BE]\|[payload]\|` |
| `decode_object_cell` | Parses a wire-format cell back into `eof`, `offset`, and `payload` | `cell: bytes` (length ≥ 9) | `Tuple[bool, int, bytes]`: `(is_eof, offset, payload)` |
| `Tablet.add_value_object` | Writes an OBJECT cell at the specified row and column (internally calls `encode_object_cell`) | `row_index: int`,<br>`column_index: int`,<br>`is_eof: bool`,<br>`offset: int`,<br>`content: bytes` | `None` |
| `Tablet.add_value_object_by_name` | Same as above, locates column by name | `column_name: str`,<br>`row_index: int`,<br>`is_eof: bool`,<br>`offset: int`,<br>`content: bytes` | `None` |
Expand Down Expand Up @@ -749,4 +749,4 @@ def test_table_numpy_tablet_object_columns(table_session):

if __name__ == "__main__":
pytest.main([__file__, "-v", "-rs"])
```
```
2 changes: 1 addition & 1 deletion src/UserGuide/latest-Table/Tools-System/Schema-Export-Tool_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The schema export tool `export-schema.sh/bat` is located in the `tools` director

| **Short Param** | **Full Param** | **Description** | Required | Default |
|-----------------|--------------------------|--------------------------------------------------------------------------| ------------------------------------- |---------------------------------------------|
| `-h` | `-- host` | Hostname | No | 127.0.0.1 |
| `-h` | `--host` | Hostname | No | 127.0.0.1 |
| `-p` | `--port` | Port number | No | 6667 |
| `-u` | `--username` | Username | No | root |
| `-pw` | `--password` | Password. Supported for hidden input since V2.0.9-beta | No | root |
Expand Down
2 changes: 1 addition & 1 deletion src/UserGuide/latest-Table/Tools-System/Schema-Export-Tool_timecho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The schema export tool `export-schema.sh/bat` is located in the `tools` director

| **Short Param** | **Full Param** | **Description** | Required | Default |
|-----------------|----------------------------|-----------------------------------------------------------------------| ------------------------------------- |-----------------------------------------------|
| `-h` | `-- host` | Hostname | No | 127.0.0.1 |
| `-h` | `--host` | Hostname | No | 127.0.0.1 |
| `-p` | `--port` | Port number | No | 6667 |
| `-u` | `--username` | Username | No | root |
| `-pw` | `--password` | Password, Supported for hidden input since V2.0.9.1 | No | `TimechoDB@2021`(Before V2.0.6 it is root) |
Expand Down
2 changes: 1 addition & 1 deletion src/UserGuide/latest-Table/Tools-System/Schema-Import-Tool_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The schema import tool `import-schema.sh/bat` is located in `tools` directory.

| **Short Param** | **Full Param** | **Description** | Required | Default |
|-----------------|---------------------------|--------------------------------------------------------------------------| ---------- |-------------------------------------------|
| `-h` | `-- host` | Hostname | No | 127.0.0.1 |
| `-h` | `--host` | Hostname | No | 127.0.0.1 |
| `-p` | `--port` | Port number | No | 6667 |
| `-u` | `--username` | Username | No | root |
| `-pw` | `--password` | Password. Supported for hidden input since V2.0.9-beta | No | root |
Expand Down
2 changes: 1 addition & 1 deletion src/UserGuide/latest-Table/Tools-System/Schema-Import-Tool_timecho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The schema import tool `import-schema.sh/bat` is located in `tools` directory.

| **Short Param** | **Full Param** | **Description** | Required | Default |
|-----------------| ------------------------------- |-----------------------------------------------------------------------| ---------- |----------------------------------------------|
| `-h` | `-- host` | Hostname | No | 127.0.0.1 |
| `-h` | `--host` | Hostname | No | 127.0.0.1 |
| `-p` | `--port` | Port number | No | 6667 |
| `-u` | `--username` | Username | No | root |
| `-pw` | `--password` | Password, Supported for hidden input since V2.0.9.1 | No | `TimechoDB@2021`(Before V2.0.6 it is root) |
Expand Down
32 changes: 16 additions & 16 deletions src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,22 +84,22 @@ By declaratively configuring these three parts in an SQL statement, flexible dat
- The `pipe` and `pipe plugins` for tree modes and table modes are designed to be isolated from each other. Before creating a `pipe`, it is recommended to first use the `show` command to query the built-in plugins available under the current `-sql_dialect` parameter configuration to ensure syntax compatibility and functional support.
- When Pipe fails to write data to the sink due to field type mismatches, IoTDB automatically converts the data to the field types defined in the existing sink schema and retries the write operation to improve synchronization success rate. This feature is controlled by the parameter `sink.exception.data.convert-on-type-mismatch`. Refer to the subsequent sink parameter table for detailed parameter descriptions.

* The conversion rules for type mismatches are as follows:

| Source Type | Target Type | Conversion Rule |
|---------------------|-------------|---------------------------------------------------------------------------------|
| Numeric Type | Numeric Type| Convert to the target numeric type. Truncation, precision loss or overflow may occur. |
| Numeric Type | BOOLEAN | `0` is converted to `false`; non-zero values are converted to `true`. |
| BOOLEAN | Numeric Type| `true` is converted to `1`; `false` is converted to `0`. |
| TEXT, STRING, BLOB | BOOLEAN | Parse the string into a BOOLEAN value. |
| TEXT, STRING, BLOB | Numeric Type| Parse the string into the target numeric type. If parsing fails, write the default value `0`, `0L` or `0.0`. |
| TEXT, STRING, BLOB | TIMESTAMP | Parse the string into a TIMESTAMP value. If parsing fails, write the default value `0L`. |
| TEXT, STRING, BLOB | DATE | Parse the string into a DATE value. If parsing fails, write the default date `1970-01-01`. |
| Invalid Numeric Value | DATE | If conversion to a valid DATE fails, write the default date `1970-01-01`. |
| DATE | TIMESTAMP | Convert to the timestamp of 00:00 (UTC) on the same day. |
| TIMESTAMP | DATE | Convert to the corresponding date in UTC. |

> **Note**: Automatic conversion is performed based on the existing sink schema and will **not** modify the sink schema. This feature prioritizes continuous data synchronization, which may result in precision loss or writing of default values.
The conversion rules for type mismatches are as follows:

| Source Type | Target Type | Conversion Rule |
| --------------------- | ------------ | --------------- |
| Numeric Type | Numeric Type | Convert to the target numeric type. Truncation, precision loss, or overflow may occur. |
| Numeric Type | BOOLEAN | `0` is converted to `false`; non-zero values are converted to `true`. |
| BOOLEAN | Numeric Type | `true` is converted to `1`; `false` is converted to `0`. |
| TEXT, STRING, BLOB | BOOLEAN | Parse the string into a BOOLEAN value. |
| TEXT, STRING, BLOB | Numeric Type | Parse the string into the target numeric type. If parsing fails, write the default value `0`, `0L`, or `0.0`. |
| TEXT, STRING, BLOB | TIMESTAMP | Parse the string into a TIMESTAMP value. If parsing fails, write the default value `0L`. |
| TEXT, STRING, BLOB | DATE | Parse the string into a DATE value. If parsing fails, write the default date `1970-01-01`. |
| Invalid Numeric Value | DATE | If conversion to a valid DATE fails, write the default date `1970-01-01`. |
| DATE | TIMESTAMP | Convert to the timestamp of 00:00 (UTC) on the same day. |
| TIMESTAMP | DATE | Convert to the corresponding date in UTC. |

> **Note**: Automatic conversion is performed based on the existing sink schema and will **not** modify the sink schema. This feature prioritizes continuous data synchronization, which may result in precision loss or writing of default values.

## 2. Usage Instructions

Expand Down
Loading
Loading