-
Notifications
You must be signed in to change notification settings - Fork 5k
docs(taosx): kinghistorian doc #TD-38665 #33758
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,83 @@ | ||||||
| --- | ||||||
| title: "KingHistorian" | ||||||
| sidebar_label: "KingHistorian" | ||||||
| --- | ||||||
|
|
||||||
| This section describes how to create data migration/data synchronization tasks through the Explorer interface to migrate/synchronize data from KingHistorian to the current TDengine TSDB cluster. | ||||||
|
|
||||||
| ## Function Overview | ||||||
|
|
||||||
| TDengine TSDB can efficiently read data from KingHistorian and write it into TDengine TSDB to achieve historical data migration or real-time data synchronization. | ||||||
|
|
||||||
| ## Create Task | ||||||
|
|
||||||
| ### 1. Add Data Source | ||||||
|
|
||||||
| In the data writing page, click the **+Add Data Source** button to enter the Add Data Source page. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| ### 2. Configure Basic Information | ||||||
|
|
||||||
| Enter the task name in **Name**, e.g., "test_kinghistorian"; | ||||||
|
|
||||||
| Select **KingHistorian** from the **Type** dropdown list. | ||||||
|
|
||||||
| **Proxy** is optional. If needed, you can select a specific proxy from the dropdown box or click the **+Create New Proxy** button on the right. | ||||||
|
|
||||||
| Select a target database from the **Target Database** dropdown list, or click the **+Create Database** button on the right. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| ### 3. Configure Connection Information | ||||||
|
|
||||||
| Fill in the **Server Address** and **Server Port** in the **Connection Configuration** area. | ||||||
|
|
||||||
| Fill in the **Username** and **Password** in the **Authentication** area. | ||||||
|
|
||||||
| Click the **Connectivity Check** button to check if the data source is available. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| ### 4. Configure Tags | ||||||
|
|
||||||
| In the **Upload CSV Configuration File**, click **Download Data Points**, select the required **Point Group**, **Points**, and **Tags**. A CSV configuration file will be generated and downloaded locally. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This line contains a run-on sentence (comma splice), which can be confusing for readers. It should be rephrased for grammatical correctness and clarity.
Suggested change
|
||||||
| Modify the generated CSV configuration file as needed and re-upload it. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| ### 5. Configure Collection Information | ||||||
|
|
||||||
| Fill in the relevant configuration parameters for the collection task in the **Collection Configuration** area. | ||||||
|
|
||||||
| #### 5.1. Historical Data Migration | ||||||
|
|
||||||
| If you want to perform historical data migration, configure the following parameters: | ||||||
|
|
||||||
| Fill in the start time of the data migration task in **Task Start Time**. | ||||||
|
|
||||||
| Fill in the end time of the data migration task in **Task End Time**. | ||||||
|
|
||||||
| Fill in a time interval in **Query Window**. The data migration task will divide the time window according to this interval. | ||||||
|
|
||||||
| Fill in a time interval in **Out-of-Order**. Each query window will backtrack this interval. | ||||||
|
|
||||||
| Fill in a time interval in **Query Interval**. There will be a waiting interval between each query window. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| #### 5.2. Real-Time Data Synchronization | ||||||
|
|
||||||
| If you want to perform real-time data synchronization, configure the following parameters: | ||||||
|
|
||||||
| Fill in a time interval in **Minimum Interval Time**, which is the minimum subscription interval time. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| ### 6. Configure Advanced Options | ||||||
|
|
||||||
| Fill in the relevant configuration parameters in the **Advanced Options** area. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This instruction is vague. To make the documentation more helpful, consider briefly mentioning what kind of parameters can be configured in 'Advanced Options', or link to more detailed documentation if available. If there are no specific parameters to highlight, a more general phrasing would be better.
Suggested change
|
||||||
|
|
||||||
| ### 7. Completion | ||||||
|
|
||||||
| Click the **Submit** button to complete the task creation. After submitting the task, return to the **Data Writing** page to view the task status. | ||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| --- | ||
| title: "KingHistorian" | ||
| sidebar_label: "KingHistorian" | ||
| --- | ||
|
|
||
| 本节讲述如何通过 Explorer 界面创建数据迁移/数据同步任务,从 KingHistorian 迁移/同步数据到当前 TDengine TSDB 集群。 | ||
|
|
||
| ## 功能概述 | ||
|
|
||
| TDengine TSDB 可以高效地从 KingHistorian 读取数据并将其写入 TDengine TSDB,以实现历史数据迁移或实时数据同步。 | ||
|
|
||
| ## 创建任务 | ||
|
|
||
| ### 1. 新增数据源 | ||
|
|
||
| 在数据写入页面中,点击 **+新增数据源** 按钮,进入新增数据源页面。 | ||
|
|
||
|  | ||
|
|
||
| ### 2. 配置基本信息 | ||
|
|
||
| 在 **名称** 中输入任务名称,如:“test_kinghistorian”; | ||
|
|
||
| 在 **类型** 下拉列表中选择 **KingHistorian**。 | ||
|
|
||
| **代理** 是非必填项,如果需要,可以在下拉框中选择指定的代理,也可以先点击右侧的 **+创建新的代理** 按钮 | ||
zitsen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 在 **目标数据库** 下拉列表中选择一个目标数据库,也可以先点击右侧的 **+创建数据库** 按钮 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
|  | ||
|
|
||
| ### 3. 配置连接信息 | ||
|
|
||
| 在 **连接配置** 区域填写 **Server 地址** 和 **Server 端口**。 | ||
|
|
||
| 在 **认证** 区域填写 **用户名** 和 **密码**。 | ||
|
|
||
| 点击 **连通性检查** 按钮,检查数据源是否可用。 | ||
|
|
||
|  | ||
|
|
||
| ### 4. 配置 Tag | ||
|
|
||
| 在 **上传 CSV 配置文件**中,点击 **下载数据点位**,选择需要 **测点组**,**测点**,**标签**,之后会生成 CSV 配置文件,并下载到本地。 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This line is a run-on sentence (comma splice) and uses standard commas for a list of items where enumeration commas ( |
||
| 按照需求,修改生成的 CSV 配置文件,并重新上传。 | ||
|
|
||
|  | ||
|
|
||
| ### 5. 配置采集信息 | ||
|
|
||
| 在 **采集配置** 区域填写采集任务相关的配置参数。 | ||
|
|
||
| #### 5.1. 历史数据迁移 | ||
|
|
||
| 如果要进行历史数据迁移,需要配置以下参数: | ||
|
|
||
| 在 **任务开始时间** 中,填写数据迁移任务的开始时间。 | ||
|
|
||
| 在 **任务结束时间** 中,填写数据迁移任务的结束时间。 | ||
|
|
||
| 在 **查询窗口** 中,填写一个时间间隔,数据迁移任务将按照这个时间间隔划分时间窗口。 | ||
|
|
||
| 在 **乱序** 中,填写一个时间间隔,每个查询窗口都会回溯这个时间间隔。 | ||
|
|
||
| 在 **查询间隔** 中,填写一个时间间隔,每个查询窗口之间会等待这个时间间隔。 | ||
|
|
||
|  | ||
|
|
||
| #### 5.2. 实时数据同步 | ||
|
|
||
| 如果要进行实时数据同步,需要配置以下参数: | ||
|
|
||
| 在 **最小间隔时间**中,填写一个时间间隔,订阅的最小间隔时间。 | ||
|
|
||
|  | ||
|
|
||
| ### 6. 配置高级选项 | ||
|
|
||
| 在 **高级选项** 区域填写高级选项相关的配置参数。 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This instruction is vague. To make the documentation more helpful, consider briefly mentioning what kind of parameters can be configured in 'Advanced Options', or link to more detailed documentation if available. If there are no specific parameters to highlight, a more general phrasing would be better. |
||
|
|
||
| ### 7. 创建完成 | ||
|
|
||
| 点击 **提交** 按钮,完成创建任务。提交任务后,回到**数据写入**页面可以查看任务状态。 | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The semicolon at the end of this line is grammatically incorrect and inconsistent with the rest of the document. Please replace it with a period for correctness and consistency.