Skip to content

Commit 4ec8e73

Browse files
committed
docs(taosx): kinghistorian doc #TD-38665
1 parent 7a7b13f commit 4ec8e73

14 files changed

Lines changed: 248 additions & 0 deletions
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: "KingHistorian"
3+
sidebar_label: "KingHistorian"
4+
---
5+
6+
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.
7+
8+
## Function Overview
9+
10+
TDengine TSDB can efficiently read data from KingHistorian and write it into TDengine TSDB to achieve historical data migration or real-time data synchronization.
11+
12+
## Create Task
13+
14+
### 1. Add Data Source
15+
16+
In the data writing page, click the **+Add Data Source** button to enter the Add Data Source page.
17+
18+
![kinghist-01.png](../../assets/Common-en00-EnterDataSourcePage.png)
19+
20+
### 2. Configure Basic Information
21+
22+
Enter the task name in **Name**, e.g., "test_kinghistorian";
23+
24+
Select **KingHistorian** from the **Type** dropdown list.
25+
26+
**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.
27+
28+
Select a target database from the **Target Database** dropdown list, or click the **+Create Database** button on the right.
29+
30+
![kinghist-02.png](../../assets/kinghist-02.png)
31+
32+
### 3. Configure Connection Information
33+
34+
Fill in the **Server Address** and **Server Port** in the **Connection Configuration** area.
35+
36+
Fill in the **Username** and **Password** in the **Authentication** area.
37+
38+
Click the **Connectivity Check** button to check if the data source is available.
39+
40+
![kinghist-03.png](../../assets/kinghist-03.png)
41+
42+
### 4. Configure Tags
43+
44+
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.
45+
Modify the generated CSV configuration file as needed and re-upload it.
46+
47+
![kinghist-04.png](../../assets/kinghist-04.png)
48+
49+
### 5. Configure Collection Information
50+
51+
Fill in the relevant configuration parameters for the collection task in the **Collection Configuration** area.
52+
53+
#### 5.1. Historical Data Migration
54+
55+
If you want to perform historical data migration, configure the following parameters:
56+
57+
Fill in the start time of the data migration task in **Task Start Time**.
58+
59+
Fill in the end time of the data migration task in **Task End Time**.
60+
61+
Fill in a time interval in **Query Window**. The data migration task will divide the time window according to this interval.
62+
63+
Fill in a time interval in **Out-of-Order**. Each query window will backtrack this interval.
64+
65+
Fill in a time interval in **Query Interval**. There will be a waiting interval between each query window.
66+
67+
![kinghist-05.png](../../assets/kinghist-05.png)
68+
69+
#### 5.2. Real-Time Data Synchronization
70+
71+
If you want to perform real-time data synchronization, configure the following parameters:
72+
73+
Fill in a time interval in **Minimum Interval Time**, which is the minimum subscription interval time.
74+
75+
![kinghist-06.png](../../assets/kinghist-06.png)
76+
77+
### 6. Configure Advanced Options
78+
79+
Fill in the relevant configuration parameters in the **Advanced Options** area.
80+
81+
### 7. Completion
82+
83+
Click the **Submit** button to complete the task creation. After submitting the task, return to the **Data Writing** page to view the task status.
45.4 KB
Loading

docs/en/assets/kinghist-02.png

16.8 KB
Loading

docs/en/assets/kinghist-03.png

36.4 KB
Loading

docs/en/assets/kinghist-04.png

134 KB
Loading

docs/en/assets/kinghist-05.png

33.9 KB
Loading

docs/en/assets/kinghist-06.png

18.1 KB
Loading
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: "KingHistorian"
3+
sidebar_label: "KingHistorian"
4+
---
5+
6+
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.
7+
8+
## Function Overview
9+
10+
TDengine TSDB can efficiently read data from KingHistorian and write it into TDengine TSDB to achieve historical data migration or real-time data synchronization.
11+
12+
## Create Task
13+
14+
### 1. Add Data Source
15+
16+
In the data writing page, click the **+Add Data Source** button to enter the Add Data Source page.
17+
18+
![kinghist-01.png](pic/Common-zh00-EnterDataSourcePage.png)
19+
20+
### 2. Configure Basic Information
21+
22+
Enter the task name in **Name**, e.g., "test_kinghistorian";
23+
24+
Select **KingHistorian** from the **Type** dropdown list.
25+
26+
**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.
27+
28+
Select a target database from the **Target Database** dropdown list, or click the **+Create Database** button on the right.
29+
30+
![kinghist-02.png](pic/kinghist-02.png)
31+
32+
### 3. Configure Connection Information
33+
34+
Fill in the **Server Address** and **Server Port** in the **Connection Configuration** area.
35+
36+
Fill in the **Username** and **Password** in the **Authentication** area.
37+
38+
Click the **Connectivity Check** button to check if the data source is available.
39+
40+
![kinghist-03.png](pic/kinghist-03.png)
41+
42+
### 4. Configure Tags
43+
44+
In the **Upload CSV Configuration File**, click **Download Data Points**, select the required **Point Group**, **Points**, and **Tags**, which will generate a CSV configuration file and download it locally. Modify the generated CSV configuration file as needed and re-upload it.
45+
46+
![kinghist-04.png](pic/kinghist-04.png)
47+
48+
### 5. Configure Collection Information
49+
50+
Fill in the relevant configuration parameters for the collection task in the **Collection Configuration** area.
51+
52+
#### 5.1. Historical Data Migration
53+
54+
If you want to perform historical data migration, configure the following parameters:
55+
56+
Fill in the start time of the data migration task in **Task Start Time**.
57+
58+
Fill in the end time of the data migration task in **Task End Time**.
59+
60+
Fill in a time interval in **Query Window**, and the data migration task will divide the time window according to this interval.
61+
62+
Fill in a time interval in **Out-of-Order**, and each query window will backtrack this interval.
63+
64+
Fill in a time interval in **Query Interval**, and there will be a waiting interval between each query window.
65+
66+
![kinghist-05.png](pic/kinghist-05.png)
67+
68+
#### 5.2. Real-Time Data Synchronization
69+
70+
If you want to perform real-time data synchronization, configure the following parameters:
71+
72+
Fill in a time interval in **Minimum Interval Time**, which is the minimum subscription interval time.
73+
74+
![kinghist-06.png](pic/kinghist-06.png)
75+
76+
### 6. Configure Advanced Options
77+
78+
Fill in the relevant configuration parameters for advanced options in the **Advanced Options** area.
79+
80+
### 7. Completion
81+
82+
Click the **Submit** button to complete the task creation. After submitting the task, return to the **Data Writing** page to view the task status.
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: "KingHistorian"
3+
sidebar_label: "KingHistorian"
4+
---
5+
6+
本节讲述如何通过 Explorer 界面创建数据迁移/数据同步任务,从 KingHistorian 迁移/同步数据到当前 TDengine TSDB 集群。
7+
8+
## 功能概述
9+
10+
TDengine TSDB 可以高效地从 KingHistorian 读取数据并将其写入 TDengine TSDB,以实现历史数据迁移或实时数据同步。
11+
12+
## 创建任务
13+
14+
### 1. 新增数据源
15+
16+
在数据写入页面中,点击 **+新增数据源** 按钮,进入新增数据源页面。
17+
18+
![kinghist-01.png](pic/Common-zh00-EnterDataSourcePage.png)
19+
20+
### 2. 配置基本信息
21+
22+
**名称** 中输入任务名称,如:“test_kinghistorian”;
23+
24+
**类型** 下拉列表中选择 **KingHistorian**
25+
26+
**代理** 是非必填项,如果需要,可以在下拉框中选择指定的代理,也可以先点击右侧的 **+创建新的代理** 按钮
27+
28+
**目标数据库** 下拉列表中选择一个目标数据库,也可以先点击右侧的 **+创建数据库** 按钮
29+
30+
![kinghist-02.png](pic/kinghist-02.png)
31+
32+
### 3. 配置连接信息
33+
34+
**连接配置** 区域填写 **Server 地址****Server 端口**
35+
36+
**认证** 区域填写 **用户名****密码**
37+
38+
点击 **连通性检查** 按钮,检查数据源是否可用。
39+
40+
![kinghist-03.png](pic/kinghist-03.png)
41+
42+
### 4. 配置 Tag
43+
44+
**上传 CSV 配置文件**中,点击 **下载数据点位**,选择需要 **测点组****测点****标签**,之后会生成 CSV 配置文件,并下载到本地。
45+
按照需求,修改生成的 CSV 配置文件,并重新上传。
46+
47+
![kinghist-04.png](pic/kinghist-04.png)
48+
49+
### 5. 配置采集信息
50+
51+
**采集配置** 区域填写采集任务相关的配置参数。
52+
53+
#### 5.1. 历史数据迁移
54+
55+
如果要进行历史数据迁移,需要配置以下参数:
56+
57+
**任务开始时间** 中,填写数据迁移任务的开始时间。
58+
59+
**任务结束时间** 中,填写数据迁移任务的结束时间。
60+
61+
**查询窗口** 中,填写一个时间间隔,数据迁移任务将按照这个时间间隔划分时间窗口。
62+
63+
**乱序** 中,填写一个时间间隔,每个查询窗口都会回溯这个时间间隔。
64+
65+
**查询间隔** 中,填写一个时间间隔,每个查询窗口之间会等待这个时间间隔。
66+
67+
![kinghist-05.png](pic/kinghist-05.png)
68+
69+
#### 5.2. 实时数据同步
70+
71+
如果要进行实时数据同步,需要配置以下参数:
72+
73+
**最小间隔时间**中,填写一个时间间隔,订阅的最小间隔时间。
74+
75+
![kinghist-06.png](pic/kinghist-06.png)
76+
77+
### 6. 配置高级选项
78+
79+
**高级选项** 区域填写高级选项相关的配置参数。
80+
81+
### 7. 创建完成
82+
83+
点击 **提交** 按钮,完成创建任务。提交任务后,回到**数据写入**页面可以查看任务状态。
20.1 KB
Loading

0 commit comments

Comments
 (0)