Skip to content

Commit 1d28c4f

Browse files
authored
2.0 Tables and Trees with an Additional Sidebar (#593)
1 parent 404c831 commit 1d28c4f

12 files changed

Lines changed: 252 additions & 44 deletions

File tree

src/.vuepress/sidebar/V2.0.x/en-Table.ts

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -77,22 +77,16 @@ export const enSidebar = {
7777
collapsible: true,
7878
prefix: 'Basic-Concept/',
7979
children: [
80+
{ text: 'Database Management', link: 'Database-Management' },
81+
{ text: 'Table Management', link: 'Table-Management' },
82+
{ text: 'Write&Updata Data', link: 'Write-Updata-Data' },
83+
{ text: 'Query Data', link: 'Query-Data' },
8084
{
81-
text: 'Data Modeling',
85+
text: 'Delete Data',
8286
collapsible: true,
8387
children: [
84-
{ text: 'Database Management', link: 'Database-Management' },
85-
{ text: 'Table Management', link: 'Table-Management' },
86-
{ text: 'Write&Updata Data', link: 'Write-Updata-Data' },
87-
{ text: 'Query Data', link: 'Query-Data' },
88-
{
89-
text: 'Delete Data',
90-
collapsible: true,
91-
children: [
92-
{ text: 'Delete Data', link: 'Delete-Data' },
93-
{ text: 'TTL Delete Data', link: 'TTL-Delete-Data' },
94-
],
95-
},
88+
{ text: 'Delete Data', link: 'Delete-Data' },
89+
{ text: 'TTL Delete Data', link: 'TTL-Delete-Data' },
9690
],
9791
},
9892
],

src/.vuepress/sidebar/V2.0.x/en-Tree.ts

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ export const enSidebar = {
5757
collapsible: true,
5858
prefix: 'Deployment-and-Maintenance/',
5959
children: [
60+
{ text: 'Deployment form', link: 'Deployment-form_apache' },
6061
{ text: 'Obtain IoTDB', link: 'IoTDB-Package_apache' },
6162
{ text: 'Database Resources', link: 'Database-Resources' },
6263
{ text: 'Environment Requirements', link: 'Environment-Requirements' },
@@ -76,13 +77,7 @@ export const enSidebar = {
7677
children: [
7778
{
7879
text: 'Data Modeling',
79-
collapsible: true,
80-
children: [
81-
{
82-
text: 'Measurement Point Management',
83-
link: 'Operate-Metadata_apache',
84-
},
85-
],
80+
link: 'Operate-Metadata_apache',
8681
},
8782
{ text: 'Write & Delete', link: 'Write-Delete-Data' },
8883
{ text: 'Query Data', link: 'Query-Data' },

src/.vuepress/sidebar_timecho/V2.0.x/en-Table.ts

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -77,22 +77,16 @@ export const enSidebar = {
7777
collapsible: true,
7878
prefix: 'Basic-Concept/',
7979
children: [
80+
{ text: 'Database Management', link: 'Database-Management' },
81+
{ text: 'Table Management', link: 'Table-Management' },
82+
{ text: 'Write&Updata Data', link: 'Write-Updata-Data' },
83+
{ text: 'Query Data', link: 'Query-Data' },
8084
{
81-
text: 'Data Modeling',
85+
text: 'Delete Data',
8286
collapsible: true,
8387
children: [
84-
{ text: 'Database Management', link: 'Database-Management' },
85-
{ text: 'Table Management', link: 'Table-Management' },
86-
{ text: 'Write&Updata Data', link: 'Write-Updata-Data' },
87-
{ text: 'Query Data', link: 'Query-Data' },
88-
{
89-
text: 'Delete Data',
90-
collapsible: true,
91-
children: [
92-
{ text: 'Delete Data', link: 'Delete-Data' },
93-
{ text: 'TTL Delete Data', link: 'TTL-Delete-Data' },
94-
],
95-
},
88+
{ text: 'Delete Data', link: 'Delete-Data' },
89+
{ text: 'TTL Delete Data', link: 'TTL-Delete-Data' },
9690
],
9791
},
9892
],

src/.vuepress/sidebar_timecho/V2.0.x/en-Tree.ts

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ export const enSidebar = {
5757
collapsible: true,
5858
prefix: 'Deployment-and-Maintenance/',
5959
children: [
60+
{ text: 'Deployment form', link: 'Deployment-form_timecho' },
6061
{ text: 'Obtain TimechoDB', link: 'IoTDB-Package_timecho' },
6162
{ text: 'Database Resources', link: 'Database-Resources' },
6263
{ text: 'Environment Requirements', link: 'Environment-Requirements' },
@@ -85,13 +86,7 @@ export const enSidebar = {
8586
children: [
8687
{
8788
text: 'Data Modeling',
88-
collapsible: true,
89-
children: [
90-
{
91-
text: 'Measurement Point Management',
92-
link: 'Operate-Metadata_timecho',
93-
},
94-
],
89+
link: 'Operate-Metadata_timecho',
9590
},
9691
{ text: 'Write & Delete', link: 'Write-Delete-Data' },
9792
{ text: 'Query Data', link: 'Query-Data' },

src/UserGuide/Master/Table/Deployment-and-Maintenance/Deployment-form_apache.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
under the License.
1919
2020
-->
21-
# Deployment-Mode_apache
21+
# Deployment form
2222

2323
IoTDB has two operation modes: standalone mode and cluster mode.
2424

src/UserGuide/Master/Table/Deployment-and-Maintenance/Deployment-form_timecho.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
under the License.
1919
2020
-->
21-
# Deployment-Mode_apache
21+
# Deployment form
2222

2323
IoTDB has two operation modes: standalone mode and cluster mode.
2424

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
# Deployment form
22+
23+
IoTDB has two operation modes: standalone mode and cluster mode.
24+
25+
## 1 Standalone Mode
26+
27+
An IoTDB standalone instance includes 1 ConfigNode and 1 DataNode, referred to as 1C1D.
28+
29+
- **Features**: Easy for developers to install and deploy, with lower deployment and maintenance costs, and convenient operation.
30+
- **Applicable scenarios**: Situations with limited resources or where high availability is not a critical requirement, such as edge servers.
31+
- **Deployment method**:[Stand-Alone Deployment](../Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md)
32+
33+
34+
## 2 Cluster Mode
35+
36+
An IoTDB cluster instance consists of 3 ConfigNodes and no fewer than 3 DataNodes, typically 3 DataNodes, referred to as 3C3D. In the event of partial node failures, the remaining nodes can still provide services, ensuring high availability of the database service, and the database performance can be improved with the addition of nodes.
37+
38+
- **Features**: High availability and scalability, with the ability to enhance system performance by adding DataNodes.
39+
- **Applicable scenarios**: Enterprise-level application scenarios that require high availability and reliability.
40+
- **Deployment method**: [Cluster Deployment](../Deployment-and-Maintenance/Cluster-Deployment_apache.md)
41+
42+
## 3 Summary of Features
43+
44+
| **Dimension** | **Stand-Alone Mode** | **Cluster Mode** |
45+
| :-------------------------- | :----------------------------------------------------- | :----------------------------------------------------------- |
46+
| Applicable Scenario | Edge deployment, low requirement for high availability | High-availability business, disaster recovery scenarios, etc. |
47+
| Number of Machines Required | 1 | ≥3 |
48+
| Security and Reliability | Cannot tolerate single-point failure | High, can tolerate single-point failure |
49+
| Scalability | Scalable by adding DataNodes to improve performance | Scalable by adding DataNodes to improve performance |
50+
| Performance | Scalable with the number of DataNodes | Scalable with the number of DataNodes |
51+
52+
- The deployment steps for standalone mode and cluster mode are similar (adding ConfigNodes and DataNodes one by one), with the only differences being the number of replicas and the minimum number of nodes required to provide services.
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
# Deployment form
22+
23+
IoTDB has two operation modes: standalone mode and cluster mode.
24+
25+
## 1 Standalone Mode
26+
27+
An IoTDB standalone instance includes 1 ConfigNode and 1 DataNode, i.e., 1C1D.
28+
29+
- **Features**: Easy for developers to install and deploy, with low deployment and maintenance costs and convenient operations.
30+
- **Use Cases**: Scenarios with limited resources or low high-availability requirements, such as edge servers.
31+
- **Deployment Method**: [Stand-Alone Deployment](../Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md)
32+
33+
## 2 Dual-Active Mode
34+
35+
Dual-Active Deployment is a feature of TimechoDB, where two independent instances synchronize bidirectionally and can provide services simultaneously. If one instance stops and restarts, the other instance will resume data transfer from the breakpoint.
36+
37+
> An IoTDB Dual-Active instance typically consists of 2 standalone nodes, i.e., 2 sets of 1C1D. Each instance can also be a cluster.
38+
39+
- **Features**: The high-availability solution with the lowest resource consumption.
40+
- **Use Cases**: Scenarios with limited resources (only two servers) but requiring high availability.
41+
- **Deployment Method**: [Dual-Active Deployment](../Deployment-and-Maintenance/Dual-Active-Deployment_timecho.md)
42+
43+
## 3 Cluster Mode
44+
45+
An IoTDB cluster instance consists of 3 ConfigNodes and no fewer than 3 DataNodes, typically 3 DataNodes, i.e., 3C3D. If some nodes fail, the remaining nodes can still provide services, ensuring high availability of the database. Performance can be improved by adding DataNodes.
46+
47+
- **Features**: High availability, high scalability, and improved system performance by adding DataNodes.
48+
- **Use Cases**: Enterprise-level application scenarios requiring high availability and reliability.
49+
- **Deployment Method**: [Cluster Deployment](../Deployment-and-Maintenance/Cluster-Deployment_timecho.md)
50+
51+
52+
53+
## 4 Feature Summary
54+
55+
| **Dimension** | **Stand-Alone Mode** | **Dual-Active Mode** | **Cluster Mode** |
56+
| :-------------------------- | :------------------------------------------------------- | :------------------------------------------------------ | :------------------------------------------------------ |
57+
| Use Cases | Edge-side deployment, low high-availability requirements | High-availability services, disaster recovery scenarios | High-availability services, disaster recovery scenarios |
58+
| Number of Machines Required | 1 | 2 | ≥3 |
59+
| Security and Reliability | Cannot tolerate single-point failure | High, can tolerate single-point failure | High, can tolerate single-point failure |
60+
| Scalability | Can expand DataNodes to improve performance | Each instance can be scaled as needed | Can expand DataNodes to improve performance |
61+
| Performance | Can scale with the number of DataNodes | Same as one of the instances | Can scale with the number of DataNodes |
62+
63+
- The deployment steps for Stand-Alone Mode and Cluster Mode are similar (adding ConfigNodes and DataNodes one by one), with differences only in the number of replicas and the minimum number of nodes required to provide services.

src/UserGuide/latest-Table/Deployment-and-Maintenance/Deployment-form_apache.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
under the License.
1919
2020
-->
21-
# Deployment-Mode_apache
21+
# Deployment form
2222

2323
IoTDB has two operation modes: standalone mode and cluster mode.
2424

src/UserGuide/latest-Table/Deployment-and-Maintenance/Deployment-form_timecho.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
under the License.
1919
2020
-->
21-
# Deployment-Mode_apache
21+
# Deployment form
2222

2323
IoTDB has two operation modes: standalone mode and cluster mode.
2424

0 commit comments

Comments
 (0)