diff --git a/src/.vuepress/sidebar/V2.0.x/en-Table.ts b/src/.vuepress/sidebar/V2.0.x/en-Table.ts index 6a156575f..e19cc8120 100644 --- a/src/.vuepress/sidebar/V2.0.x/en-Table.ts +++ b/src/.vuepress/sidebar/V2.0.x/en-Table.ts @@ -53,7 +53,7 @@ export const enSidebar = { prefix: 'Deployment-and-Maintenance/', children: [ { text: 'Deployment form', link: 'Deployment-form_apache' }, - { text: 'Obtain TimechoDB', link: 'IoTDB-Package_apache' }, + { text: 'Obtain IoTDB', link: 'IoTDB-Package_apache' }, { text: 'Database Resources', link: 'Database-Resources' }, { text: 'Environment Requirements', link: 'Environment-Requirements' }, { @@ -61,10 +61,6 @@ export const enSidebar = { link: 'Stand-Alone-Deployment_apache', }, { text: 'Cluster Deployment', link: 'Cluster-Deployment_apache' }, - { - text: 'Dual Active Deployment', - link: 'Dual-Active-Deployment_apache', - }, { text: 'Docker Deployment', link: 'Docker-Deployment_apache' }, { text: 'Monitoring Panel Deployment', diff --git a/src/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_apache.md b/src/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_apache.md index b61ac6f7a..931a75b3d 100644 --- a/src/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_apache.md +++ b/src/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_apache.md @@ -19,7 +19,7 @@ --> -# Common Concept +# Common Concepts ## 1. SQL Dialect Related Concepts diff --git a/src/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_timecho.md b/src/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_timecho.md index 40ff6cca8..236489032 100644 --- a/src/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_timecho.md +++ b/src/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_timecho.md @@ -19,7 +19,7 @@ --> -# Common Concept +# Common Concepts ## 1. SQL Dialect Related Concepts diff --git a/src/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_apache.md b/src/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_apache.md index f3b777bf2..7c363efbb 100644 --- a/src/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_apache.md +++ b/src/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_apache.md @@ -19,7 +19,7 @@ --> -# Time Series Modeling +# Modeling Scheme Design This section introduces how to transform time series data application scenarios into IoTDB time series modeling. diff --git a/src/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_timecho.md b/src/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_timecho.md index 477666573..ed78fa2e1 100644 --- a/src/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_timecho.md +++ b/src/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_timecho.md @@ -19,7 +19,7 @@ --> -# Time Series Modeling +# Modeling Scheme Design This section introduces how to transform time series data application scenarios into IoTDB time series modeling. diff --git a/src/UserGuide/Master/Table/Background-knowledge/Data-Type.md b/src/UserGuide/Master/Table/Background-knowledge/Data-Type.md index 34219dad3..71794dff6 100644 --- a/src/UserGuide/Master/Table/Background-knowledge/Data-Type.md +++ b/src/UserGuide/Master/Table/Background-knowledge/Data-Type.md @@ -19,7 +19,7 @@ --> -# Data Types +# Data Type ## 1. Basic Data Types diff --git a/src/UserGuide/Master/Table/Background-knowledge/Navigating_Time_Series_Data.md b/src/UserGuide/Master/Table/Background-knowledge/Navigating_Time_Series_Data.md index 024ecef37..a2308a55a 100644 --- a/src/UserGuide/Master/Table/Background-knowledge/Navigating_Time_Series_Data.md +++ b/src/UserGuide/Master/Table/Background-knowledge/Navigating_Time_Series_Data.md @@ -18,7 +18,7 @@ under the License. --> -# Time Series Data +# Timeseries Data Model ## 1. What is Time Series Data? diff --git a/src/UserGuide/Master/Table/Basic-Concept/Delete-Data.md b/src/UserGuide/Master/Table/Basic-Concept/Delete-Data.md index f2016dd7f..4099dc633 100644 --- a/src/UserGuide/Master/Table/Basic-Concept/Delete-Data.md +++ b/src/UserGuide/Master/Table/Basic-Concept/Delete-Data.md @@ -19,7 +19,7 @@ --> -# Data Deletion +# Delete Data ## 1. Data Deletion diff --git a/src/UserGuide/Master/Table/Basic-Concept/Query-Data.md b/src/UserGuide/Master/Table/Basic-Concept/Query-Data.md index 4a5c51a95..05e53c4c3 100644 --- a/src/UserGuide/Master/Table/Basic-Concept/Query-Data.md +++ b/src/UserGuide/Master/Table/Basic-Concept/Query-Data.md @@ -19,7 +19,7 @@ --> -# Data Query +# Query Data ## 1. Syntax Overview diff --git a/src/UserGuide/Master/Table/Basic-Concept/TTL-Delete-Data.md b/src/UserGuide/Master/Table/Basic-Concept/TTL-Delete-Data.md index df19a8596..be7619140 100644 --- a/src/UserGuide/Master/Table/Basic-Concept/TTL-Delete-Data.md +++ b/src/UserGuide/Master/Table/Basic-Concept/TTL-Delete-Data.md @@ -19,7 +19,7 @@ --> -# Automatic Data Expiration (TTL) +# TTL Delete Data ## 1. Overview diff --git a/src/UserGuide/Master/Table/Basic-Concept/Write-Updata-Data.md b/src/UserGuide/Master/Table/Basic-Concept/Write-Updata-Data.md index e40532b4a..8a5fc8aa9 100644 --- a/src/UserGuide/Master/Table/Basic-Concept/Write-Updata-Data.md +++ b/src/UserGuide/Master/Table/Basic-Concept/Write-Updata-Data.md @@ -19,7 +19,7 @@ --> -# Data Insertion & Update +# Write & Update Data ## 1. Data Insertion diff --git a/src/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md b/src/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md index dd2f1e26a..590baa139 100644 --- a/src/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/UserGuide/Master/Table/Deployment-and-Maintenance/Environment-Requirements.md @@ -18,7 +18,7 @@ under the License. --> -# System Requirements +# Environment Requirements ## 1. Disk Array diff --git a/src/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_apache.md b/src/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_apache.md index d94979310..d5e9f8fea 100644 --- a/src/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_apache.md +++ b/src/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_apache.md @@ -19,7 +19,7 @@ --> -# Product Introduction +# IoTDB Introduction Apache IoTDB is a low-cost, high-performance IoT-native time-series database. It addresses challenges faced by enterprises in managing time-series data for IoT big data platforms, including complex application scenarios, massive data volumes, high sampling frequencies, frequent out-of-order data, time-consuming data processing, diverse analytical requirements, and high storage and maintenance costs. diff --git a/src/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md b/src/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md index 60c0cbf44..c454bdcd5 100644 --- a/src/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md +++ b/src/UserGuide/Master/Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md @@ -18,7 +18,7 @@ under the License. --> -# Product Introduction +# IoTDB Introduction TimechoDB is a high-performance, cost-efficient, and IoT-native time-series database developed by Timecho. As an enterprise-grade extension of Apache IoTDB, it is designed to tackle the complexities of managing large-scale time-series data in IoT environments. These challenges include high-frequency data sampling, massive data volumes, out-of-order data, extended processing times, diverse analytical demands, and high storage and maintenance costs. diff --git a/src/UserGuide/Master/Table/Reference/System-Config-Manual.md b/src/UserGuide/Master/Table/Reference/System-Config-Manual.md index 44e49f3b3..0dc2d654f 100644 --- a/src/UserGuide/Master/Table/Reference/System-Config-Manual.md +++ b/src/UserGuide/Master/Table/Reference/System-Config-Manual.md @@ -18,7 +18,7 @@ under the License. --> -# Configuration and Parameters +# Config Manual ## 1. IoTDB Configuration Files diff --git a/src/UserGuide/Master/Table/SQL-Manual/Keywords.md b/src/UserGuide/Master/Table/SQL-Manual/Keywords.md index 0bb31d769..34d530637 100644 --- a/src/UserGuide/Master/Table/SQL-Manual/Keywords.md +++ b/src/UserGuide/Master/Table/SQL-Manual/Keywords.md @@ -19,7 +19,7 @@ --> -# Reserved Words & Keywords +# Keywords Reserved keywords must be enclosed in double quotes (" ") to be used as identifiers. Below is a list of all reserved keywords in the IoTDB table model. diff --git a/src/UserGuide/Master/Table/Technical-Insider/Cluster-data-partitioning.md b/src/UserGuide/Master/Table/Technical-Insider/Cluster-data-partitioning.md index f9f37e622..ef1ddc8a8 100644 --- a/src/UserGuide/Master/Table/Technical-Insider/Cluster-data-partitioning.md +++ b/src/UserGuide/Master/Table/Technical-Insider/Cluster-data-partitioning.md @@ -18,7 +18,7 @@ under the License. --> -# Partitioning and Load Balance +# Data Partitioning and Load Balancing This document introduces the partitioning strategies and load balance strategies in IoTDB. According to the characteristics of time series data, IoTDB partitions them by series and time dimensions. Combining a series partition with a time partition creates a partition, the unit of division. To enhance throughput and reduce management costs, these partitions are evenly allocated to RegionGroups, which serve as the unit of replication. The RegionGroup's Regions then determine the storage location, with the leader Region managing the primary load. During this process, the Region placement strategy determines which nodes will host the replicas, while the leader selection strategy designates which Region will act as the leader. diff --git a/src/UserGuide/Master/Table/Technical-Insider/Encoding-and-Compression.md b/src/UserGuide/Master/Table/Technical-Insider/Encoding-and-Compression.md index fedf3c03e..6f0f1824a 100644 --- a/src/UserGuide/Master/Table/Technical-Insider/Encoding-and-Compression.md +++ b/src/UserGuide/Master/Table/Technical-Insider/Encoding-and-Compression.md @@ -18,7 +18,7 @@ under the License. --> -# Encoding and Compression +# Compression & Encoding IoTDB employs various encoding and compression techniques to enhance storage efficiency and reduce I/O operations during data writing and reading. Below is a detailed explanation of the supported encoding and compression methods. diff --git a/src/UserGuide/Master/Table/Tools-System/Benchmark.md b/src/UserGuide/Master/Table/Tools-System/Benchmark.md index af31651f4..b8dc8c4ff 100644 --- a/src/UserGuide/Master/Table/Tools-System/Benchmark.md +++ b/src/UserGuide/Master/Table/Tools-System/Benchmark.md @@ -18,7 +18,7 @@ under the License. --> -# Benchmark +# Benchmark Tool ## 1. **Basic Overview** diff --git a/src/UserGuide/Master/Table/Tools-System/Maintenance-Tool_apache.md b/src/UserGuide/Master/Table/Tools-System/Maintenance-Tool_apache.md index fdcdbdc9e..29fe1da59 100644 --- a/src/UserGuide/Master/Table/Tools-System/Maintenance-Tool_apache.md +++ b/src/UserGuide/Master/Table/Tools-System/Maintenance-Tool_apache.md @@ -19,7 +19,7 @@ --> -# Cluster Management Tools +# Cluster Management Tool ## 1. Data Directory Overview Tool diff --git a/src/UserGuide/Master/Table/Tools-System/Maintenance-Tool_timecho.md b/src/UserGuide/Master/Table/Tools-System/Maintenance-Tool_timecho.md index f16c251c2..725b758a4 100644 --- a/src/UserGuide/Master/Table/Tools-System/Maintenance-Tool_timecho.md +++ b/src/UserGuide/Master/Table/Tools-System/Maintenance-Tool_timecho.md @@ -18,7 +18,7 @@ under the License. --> -# Maintenance Tool +# Cluster Management Tool ## 1. IoTDB-OpsKit diff --git a/src/UserGuide/Master/Table/Tools-System/Monitor-Tool_apache.md b/src/UserGuide/Master/Table/Tools-System/Monitor-Tool_apache.md index 77a5f9bde..4015009c1 100644 --- a/src/UserGuide/Master/Table/Tools-System/Monitor-Tool_apache.md +++ b/src/UserGuide/Master/Table/Tools-System/Monitor-Tool_apache.md @@ -19,7 +19,7 @@ --> -# Prometheus +# Monitor Tool The deployment of monitoring tools can be referenced in the document [Monitoring Panel Deployment](../Deployment-and-Maintenance/Monitoring-panel-deployment.md) chapter. diff --git a/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md b/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md index 02b233cb4..df9ed3a38 100644 --- a/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md +++ b/src/UserGuide/Master/Table/User-Manual/Data-Sync_apache.md @@ -19,7 +19,7 @@ --> -# Data Synchronization +# Data Sync Data synchronization is a typical requirement in the Industrial Internet of Things (IIoT). Through data synchronization mechanisms, data sharing between IoTDB instances can be achieved, enabling the establishment of a complete data pipeline to meet needs such as internal and external network data exchange, edge-to-cloud synchronization, data migration, and data backup. diff --git a/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md b/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md index 92a097141..655087533 100644 --- a/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md +++ b/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md @@ -18,7 +18,7 @@ under the License. --> -# Data Synchronization +# Data Sync Data synchronization is a typical requirement in the Industrial Internet of Things (IIoT). Through data synchronization mechanisms, data sharing between IoTDB instances can be achieved, enabling the establishment of a complete data pipeline to meet needs such as internal and external network data exchange, edge-to-cloud synchronization, data migration, and data backup. diff --git a/src/UserGuide/Master/Table/User-Manual/Maintenance-commands.md b/src/UserGuide/Master/Table/User-Manual/Maintenance-commands.md index 8454fd993..09961050d 100644 --- a/src/UserGuide/Master/Table/User-Manual/Maintenance-commands.md +++ b/src/UserGuide/Master/Table/User-Manual/Maintenance-commands.md @@ -18,6 +18,7 @@ under the License. --> +# Maintenance Statement ## 1. Status Checking diff --git a/src/UserGuide/Master/Tree/API/Programming-Data-Subscription.md b/src/UserGuide/Master/Tree/API/Programming-Data-Subscription.md index 281cc9864..f7d58c4f5 100644 --- a/src/UserGuide/Master/Tree/API/Programming-Data-Subscription.md +++ b/src/UserGuide/Master/Tree/API/Programming-Data-Subscription.md @@ -19,7 +19,7 @@ * limitations under the License. --> -# Data subscription API +# Data Subscription API IoTDB provides powerful data subscription functionality, allowing users to access newly added data from IoTDB in real-time through subscription APIs. For detailed functional definitions and introductions：[Data subscription](../User-Manual/Data-subscription.md) diff --git a/src/UserGuide/Master/Tree/API/Programming-Java-Native-API.md b/src/UserGuide/Master/Tree/API/Programming-Java-Native-API.md index 53b445885..f38cbfd37 100644 --- a/src/UserGuide/Master/Tree/API/Programming-Java-Native-API.md +++ b/src/UserGuide/Master/Tree/API/Programming-Java-Native-API.md @@ -17,7 +17,7 @@ * limitations under the License. --> -# Session Native API +# Java Native API In the native API of IoTDB, the `Session` is the core interface for interacting with the database. It integrates a rich set of methods that support data writing, querying, and metadata operations. By instantiating a `Session`, you can establish a connection to the IoTDB server and perform various database operations within the environment constructed by this connection. The `Session` is not thread-safe and should not be called simultaneously by multiple threads. diff --git a/src/UserGuide/Master/Tree/API/Programming-Rust-Native-API.md b/src/UserGuide/Master/Tree/API/Programming-Rust-Native-API.md index d25923e71..f3fcacf46 100644 --- a/src/UserGuide/Master/Tree/API/Programming-Rust-Native-API.md +++ b/src/UserGuide/Master/Tree/API/Programming-Rust-Native-API.md @@ -19,7 +19,7 @@ --> -# Rust Native API Native API +# Rust Native API IoTDB uses Thrift as a cross language RPC framework, so access to IoTDB can be achieved through the interface provided by Thrift. This document will introduce how to generate a native Rust interface that can access IoTDB. diff --git a/src/UserGuide/Master/Tree/API/RestServiceV1.md b/src/UserGuide/Master/Tree/API/RestServiceV1.md index 4fb834708..532ec3c7e 100644 --- a/src/UserGuide/Master/Tree/API/RestServiceV1.md +++ b/src/UserGuide/Master/Tree/API/RestServiceV1.md @@ -19,7 +19,7 @@ --> -# RESTful API V1(Not Recommend) +# REST API V1(Not Recommend) IoTDB's RESTful services can be used for query, write, and management operations, using the OpenAPI standard to define interfaces and generate frameworks. ## 1. Enable RESTful Services diff --git a/src/UserGuide/Master/Tree/API/RestServiceV2.md b/src/UserGuide/Master/Tree/API/RestServiceV2.md index 186cd1360..f3b97f823 100644 --- a/src/UserGuide/Master/Tree/API/RestServiceV2.md +++ b/src/UserGuide/Master/Tree/API/RestServiceV2.md @@ -19,7 +19,7 @@ --> -# RESTful API V2 +# REST API V2 IoTDB's RESTful services can be used for query, write, and management operations, using the OpenAPI standard to define interfaces and generate frameworks. ## 1. Enable RESTful Services diff --git a/src/UserGuide/Master/Tree/Background-knowledge/Data-Model-and-Terminology_apache.md b/src/UserGuide/Master/Tree/Background-knowledge/Data-Model-and-Terminology_apache.md index f3b777bf2..7c363efbb 100644 --- a/src/UserGuide/Master/Tree/Background-knowledge/Data-Model-and-Terminology_apache.md +++ b/src/UserGuide/Master/Tree/Background-knowledge/Data-Model-and-Terminology_apache.md @@ -19,7 +19,7 @@ --> -# Time Series Modeling +# Modeling Scheme Design This section introduces how to transform time series data application scenarios into IoTDB time series modeling. diff --git a/src/UserGuide/Master/Tree/Background-knowledge/Data-Model-and-Terminology_timecho.md b/src/UserGuide/Master/Tree/Background-knowledge/Data-Model-and-Terminology_timecho.md index 477666573..ed78fa2e1 100644 --- a/src/UserGuide/Master/Tree/Background-knowledge/Data-Model-and-Terminology_timecho.md +++ b/src/UserGuide/Master/Tree/Background-knowledge/Data-Model-and-Terminology_timecho.md @@ -19,7 +19,7 @@ --> -# Time Series Modeling +# Modeling Scheme Design This section introduces how to transform time series data application scenarios into IoTDB time series modeling. diff --git a/src/UserGuide/Master/Tree/Background-knowledge/Navigating_Time_Series_Data.md b/src/UserGuide/Master/Tree/Background-knowledge/Navigating_Time_Series_Data.md index 121373d1c..8ae94a763 100644 --- a/src/UserGuide/Master/Tree/Background-knowledge/Navigating_Time_Series_Data.md +++ b/src/UserGuide/Master/Tree/Background-knowledge/Navigating_Time_Series_Data.md @@ -18,7 +18,7 @@ under the License. --> -# Entering Time Series Data +# Timeseries Data Model ## 1. What Is Time Series Data？ diff --git a/src/UserGuide/Master/Tree/Basic-Concept/Operate-Metadata_apache.md b/src/UserGuide/Master/Tree/Basic-Concept/Operate-Metadata_apache.md index 688211f3e..de7833bcd 100644 --- a/src/UserGuide/Master/Tree/Basic-Concept/Operate-Metadata_apache.md +++ b/src/UserGuide/Master/Tree/Basic-Concept/Operate-Metadata_apache.md @@ -19,7 +19,7 @@ --> -# Timeseries Management +# Data Modeling ## 1. Database Management diff --git a/src/UserGuide/Master/Tree/Basic-Concept/Operate-Metadata_timecho.md b/src/UserGuide/Master/Tree/Basic-Concept/Operate-Metadata_timecho.md index b101a9057..f617f29e7 100644 --- a/src/UserGuide/Master/Tree/Basic-Concept/Operate-Metadata_timecho.md +++ b/src/UserGuide/Master/Tree/Basic-Concept/Operate-Metadata_timecho.md @@ -19,7 +19,7 @@ --> -# Timeseries Management +# Data Modeling ## 1. Database Management diff --git a/src/UserGuide/Master/Tree/Basic-Concept/Write-Delete-Data.md b/src/UserGuide/Master/Tree/Basic-Concept/Write-Delete-Data.md index 8c009eac1..70f358c64 100644 --- a/src/UserGuide/Master/Tree/Basic-Concept/Write-Delete-Data.md +++ b/src/UserGuide/Master/Tree/Basic-Concept/Write-Delete-Data.md @@ -20,7 +20,7 @@ --> -# Write & Delete Data +# Write & Delete ## 1. CLI INSERT IoTDB provides users with a variety of ways to insert real-time data, such as directly inputting [INSERT SQL statement](../SQL-Manual/SQL-Manual.md#insert-data) in [Client/Shell tools](../Tools-System/CLI.md), or using [Java JDBC](../API/Programming-JDBC.md) to perform single or batch execution of [INSERT SQL statement](../SQL-Manual/SQL-Manual.md). diff --git a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Environment-Requirements.md b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Environment-Requirements.md index 72f2e5081..69dcd6653 100644 --- a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Environment-Requirements.md @@ -18,7 +18,7 @@ under the License. --> -# System Requirements +# Environment Requirements ## 1. Disk Array diff --git a/src/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_apache.md b/src/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_apache.md index 71f394c8f..5684a8deb 100644 --- a/src/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_apache.md +++ b/src/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_apache.md @@ -19,7 +19,7 @@ --> -# What is IoTDB +# IoTDB Introduction Apache IoTDB is a low-cost, high-performance native temporal database for the Internet of Things. It can solve various problems encountered by enterprises when building IoT big data platforms to manage time-series data, such as complex application scenarios, large data volumes, high sampling frequencies, high amount of unaligned data, long data processing time, diverse analysis requirements, and high storage and operation costs. diff --git a/src/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md b/src/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md index 7c03f8a40..c30e5c9d4 100644 --- a/src/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md +++ b/src/UserGuide/Master/Tree/IoTDB-Introduction/IoTDB-Introduction_timecho.md @@ -19,7 +19,7 @@ --> -# What is TimechoDB +# IoTDB Introduction TimechoDB is a low-cost, high-performance native temporal database for the Internet of Things, provided by Timecho based on the Apache IoTDB community version as an original commercial product. It can solve various problems encountered by enterprises when building IoT big data platforms to manage time-series data, such as complex application scenarios, large data volumes, high sampling frequencies, high amount of unaligned data, long data processing time, diverse analysis requirements, and high storage and operation costs. diff --git a/src/UserGuide/Master/Tree/Reference/Common-Config-Manual.md b/src/UserGuide/Master/Tree/Reference/Common-Config-Manual.md index ca38812b8..8c8e2b936 100644 --- a/src/UserGuide/Master/Tree/Reference/Common-Config-Manual.md +++ b/src/UserGuide/Master/Tree/Reference/Common-Config-Manual.md @@ -19,7 +19,7 @@ --> -# Common Configuration +# Common Config Manual IoTDB common files for ConfigNode and DataNode are under `conf`. diff --git a/src/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual.md b/src/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual.md index 7a2b8e6f6..5203166af 100644 --- a/src/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual.md +++ b/src/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual.md @@ -19,7 +19,7 @@ --> -# ConfigNode Configuration +# ConfigNode Config Manual IoTDB ConfigNode files are under `conf`. diff --git a/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md b/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md index d452a6673..e2a3ca1b2 100644 --- a/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md +++ b/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md @@ -19,7 +19,7 @@ --> -# DataNode Configuration Parameters +# DataNode Config Manual We use the same configuration files for IoTDB DataNode and Standalone version, all under the `conf`. diff --git a/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md b/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md index 4dbe77f53..3c6e3f938 100644 --- a/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md +++ b/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md @@ -19,7 +19,7 @@ --> -# DataNode Configuration Parameters +# DataNode Config Manual We use the same configuration files for IoTDB DataNode and Standalone version, all under the `conf`. diff --git a/src/UserGuide/Master/Tree/Technical-Insider/Cluster-data-partitioning.md b/src/UserGuide/Master/Tree/Technical-Insider/Cluster-data-partitioning.md index 11ee2be4e..204132f62 100644 --- a/src/UserGuide/Master/Tree/Technical-Insider/Cluster-data-partitioning.md +++ b/src/UserGuide/Master/Tree/Technical-Insider/Cluster-data-partitioning.md @@ -19,7 +19,7 @@ --> -# Load Balance +# Data Partitioning & Load Balancing This document introduces the partitioning strategies and load balance strategies in IoTDB. According to the characteristics of time series data, IoTDB partitions them by series and time dimensions. Combining a series partition with a time partition creates a partition, the unit of division. To enhance throughput and reduce management costs, these partitions are evenly allocated to RegionGroups, which serve as the unit of replication. The RegionGroup's Regions then determine the storage location, with the leader Region managing the primary load. During this process, the Region placement strategy determines which nodes will host the replicas, while the leader selection strategy designates which Region will act as the leader. ## 1. Partitioning Strategy & Partition Allocation diff --git a/src/UserGuide/Master/Tree/Technical-Insider/Encoding-and-Compression.md b/src/UserGuide/Master/Tree/Technical-Insider/Encoding-and-Compression.md index 632f29674..b71925665 100644 --- a/src/UserGuide/Master/Tree/Technical-Insider/Encoding-and-Compression.md +++ b/src/UserGuide/Master/Tree/Technical-Insider/Encoding-and-Compression.md @@ -19,7 +19,7 @@ --> -# Encoding and Compression +# Compression & Encoding ## 1. Encoding Methods diff --git a/src/UserGuide/Master/Tree/Technical-Insider/Publication.md b/src/UserGuide/Master/Tree/Technical-Insider/Publication.md index 1f1832ef0..f040b12c5 100644 --- a/src/UserGuide/Master/Tree/Technical-Insider/Publication.md +++ b/src/UserGuide/Master/Tree/Technical-Insider/Publication.md @@ -19,7 +19,7 @@ --> -# Academic Achievement +# Research Paper Apache IoTDB starts at Tsinghua University, School of Software. IoTDB is a database for managing large amount of time series data with columnar storage, data encoding, pre-computation, and index techniques. It has SQL-like interface to write millions of data points per second per node and is optimized to get query results in few seconds over trillions of data points. It can also be easily integrated with Apache Hadoop MapReduce and Apache Spark for analytics. diff --git a/src/UserGuide/Master/Tree/Tools-System/Maintenance-Tool_apache.md b/src/UserGuide/Master/Tree/Tools-System/Maintenance-Tool_apache.md index 1587518da..51fc20f46 100644 --- a/src/UserGuide/Master/Tree/Tools-System/Maintenance-Tool_apache.md +++ b/src/UserGuide/Master/Tree/Tools-System/Maintenance-Tool_apache.md @@ -18,7 +18,7 @@ under the License. --> -# Cluster management tool +# Cluster Management Tool ## 1. IoTDB Data Directory Overview Tool diff --git a/src/UserGuide/Master/Tree/Tools-System/Maintenance-Tool_timecho.md b/src/UserGuide/Master/Tree/Tools-System/Maintenance-Tool_timecho.md index 651154352..9a8405f52 100644 --- a/src/UserGuide/Master/Tree/Tools-System/Maintenance-Tool_timecho.md +++ b/src/UserGuide/Master/Tree/Tools-System/Maintenance-Tool_timecho.md @@ -18,7 +18,7 @@ under the License. --> -# Cluster management tool +# Cluster Management Tool ## 1. IoTDB-OpsKit diff --git a/src/UserGuide/Master/Tree/User-Manual/AINode_apache.md b/src/UserGuide/Master/Tree/User-Manual/AINode_apache.md index 20f5e1192..2abf23e73 100644 --- a/src/UserGuide/Master/Tree/User-Manual/AINode_apache.md +++ b/src/UserGuide/Master/Tree/User-Manual/AINode_apache.md @@ -19,7 +19,7 @@ --> -# AI Capability（AINode） +# AI Capability AINode is the third internal node after ConfigNode and DataNode in Apache IoTDB, which extends the capability of machine learning analysis of time series by interacting with DataNode and ConfigNode of IoTDB cluster, supports the introduction of pre-existing machine learning models from the outside to be registered, and uses the registered models in the It supports the process of introducing existing machine learning models from outside for registration, and using the registered models to complete the time series analysis tasks on the specified time series data through simple SQL statements, which integrates the model creation, management and inference in the database engine. At present, we have provided machine learning algorithms or self-developed models for common timing analysis scenarios (e.g. prediction and anomaly detection). diff --git a/src/UserGuide/Master/Tree/User-Manual/AINode_timecho.md b/src/UserGuide/Master/Tree/User-Manual/AINode_timecho.md index 9c593ad07..7095ba16d 100644 --- a/src/UserGuide/Master/Tree/User-Manual/AINode_timecho.md +++ b/src/UserGuide/Master/Tree/User-Manual/AINode_timecho.md @@ -19,7 +19,7 @@ --> -# AI Capability（AINode） +# AI Capability AINode is the third internal node after ConfigNode and DataNode in Apache IoTDB, which extends the capability of machine learning analysis of time series by interacting with DataNode and ConfigNode of IoTDB cluster, supports the introduction of pre-existing machine learning models from the outside to be registered, and uses the registered models in the It supports the process of introducing existing machine learning models from outside for registration, and using the registered models to complete the time series analysis tasks on the specified time series data through simple SQL statements, which integrates the model creation, management and inference in the database engine. At present, we have provided machine learning algorithms or self-developed models for common timing analysis scenarios (e.g. prediction and anomaly detection). diff --git a/src/UserGuide/Master/Tree/User-Manual/Authority-Management.md b/src/UserGuide/Master/Tree/User-Manual/Authority-Management.md index ea58dc7bd..b13648a9a 100644 --- a/src/UserGuide/Master/Tree/User-Manual/Authority-Management.md +++ b/src/UserGuide/Master/Tree/User-Manual/Authority-Management.md @@ -19,7 +19,7 @@ --> -# Database Administration +# Authority Management IoTDB provides permission management operations, offering users the ability to manage permissions for data and cluster systems, ensuring data and system security. diff --git a/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md b/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md index 1db4190cd..696832a20 100644 --- a/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md +++ b/src/UserGuide/Master/Tree/User-Manual/Data-Sync_apache.md @@ -19,7 +19,7 @@ --> -# Data Synchronisation +# Data Sync Data synchronization is a typical requirement in industrial Internet of Things (IoT). Through data synchronization mechanisms, it is possible to achieve data sharing between IoTDB, and to establish a complete data link to meet the needs for internal and external network data interconnectivity, edge-cloud synchronization, data migration, and data backup. diff --git a/src/UserGuide/Master/Tree/User-Manual/Load-Balance.md b/src/UserGuide/Master/Tree/User-Manual/Load-Balance.md index ce193b75e..305b237cc 100644 --- a/src/UserGuide/Master/Tree/User-Manual/Load-Balance.md +++ b/src/UserGuide/Master/Tree/User-Manual/Load-Balance.md @@ -19,12 +19,12 @@ --> -## Load Balance +# Load Balance Region migration belongs to advanced operations and maintenance functions, which have certain operational costs. It is recommended to read the entire document before using this function. If you have any questions about the solution design, please contact the IoTDB team for technical support. -### Feature introduction +## 1. Feature introduction IoTDB is a distributed database, and the balanced distribution of data plays an important role in load balancing the disk space and write pressure of the cluster. Region is the basic unit for distributed storage of data in IoTDB cluster, and the specific concept can be seen in [region](../Background-knowledge/Cluster-Concept.md)。 @@ -35,14 +35,14 @@ Here is a schematic diagram of the region migration process : ![](/img/region%E8%BF%81%E7%A7%BB%E7%A4%BA%E6%84%8F%E5%9B%BE20241210.png) -### Notes +## 2. Notes 1. It is recommended to only use the Region Migration feature on IoTDB 1.3.3 and higher versions. 2. Region migration is only supported when the consensus protocol is IoTConsus or Ratis (in iotdb system. properties, the `schema_region_consensus_protocol_class` and`data_region_consensus_protocol_class`). 3. Region migration consumes system resources such as disk space and network bandwidth. It is recommended to perform the migration during periods of low business load. 4. Under ideal circumstances, Region migration does not affect user-side read or write operations. In special cases, Region migration may block writes. For detailed identification and handling of such situations, please refer to the user guide. -### Instructions for use +## 3. Instructions for use - **Grammar definition** : diff --git a/src/UserGuide/Master/Tree/User-Manual/Query-Performance-Analysis.md b/src/UserGuide/Master/Tree/User-Manual/Query-Performance-Analysis.md index 6d68830bd..57c2556dd 100644 --- a/src/UserGuide/Master/Tree/User-Manual/Query-Performance-Analysis.md +++ b/src/UserGuide/Master/Tree/User-Manual/Query-Performance-Analysis.md @@ -20,9 +20,7 @@ --> -# Maintennance - -## Query Performance Analysis +# Query Performance Analysis The purpose of query analysis is to assist users in understanding the execution mechanism and performance bottlenecks of queries, thereby facilitating query optimization and performance enhancement. This is crucial not only for the efficiency of query execution but also for the user experience of applications and the efficient utilization of resources. For effective query analysis, IoTDB versions V1.3.2 and above offer the query analysis statements: Explain and Explain Analyze. @@ -38,7 +36,7 @@ The comparison of various methods is as follows: | Monitoring Panel | Medium. Requires the installation of the IoTDB monitoring panel tool (an enterprise version tool) and the activation of the IoTDB monitoring service. | Medium. The IoTDB monitoring service's recording of metrics will introduce additional latency. | Supports distributed systems, but only analyzes the overall query load and time consumption of the database. | | Arthas Sampling | Medium. Requires the installation of the Java Arthas tool (Arthas cannot be directly installed in some intranets, and sometimes a restart of the application is needed after installation). | High. CPU sampling may affect the response speed of online business. | Does not support distributed systems and only analyzes the overall query load and time consumption of the database. | -### Explain Statement +## 1. Explain Statement #### Syntax @@ -83,7 +81,7 @@ Executing the above SQL will yield the following results. It is evident that IoT +-----------------------------------------------------------------------+ ``` -### Explain Analyze Statement +## 2. Explain Analyze Statement #### Syntax @@ -268,7 +266,7 @@ FRAGMENT-INSTANCE[Id: 20240311_041502_00001_1.3.0][IP: 192.168.130.9][DataRegion ``` -### Common Issues +## 3.Common Issues #### What is the difference between WALL TIME and CPU TIME? @@ -312,7 +310,7 @@ Because even if this part of the unaligned data is entered into the sequence, IO During the upgrade, only the lib package was replaced, and the conf/logback-datanode.xml was not replaced. It needs to be replaced, and there is no need to restart (the content of this file can be hot loaded). After waiting for about 1 minute, re-execute explain analyze verbose. -### Practical Case Studies +## 4. Practical Case Studies #### Case Study 1: The query involves too many files, and disk IO becomes a bottleneck, causing the query speed to slow down. diff --git a/src/UserGuide/Master/Tree/User-Manual/Trigger.md b/src/UserGuide/Master/Tree/User-Manual/Trigger.md index 5e05607da..1dda77b96 100644 --- a/src/UserGuide/Master/Tree/User-Manual/Trigger.md +++ b/src/UserGuide/Master/Tree/User-Manual/Trigger.md @@ -19,7 +19,7 @@ --> -# TRIGGER +# Trigger ## 1. Instructions diff --git a/src/UserGuide/Master/Tree/User-Manual/UDF-development.md b/src/UserGuide/Master/Tree/User-Manual/UDF-development.md index a866f4df6..815712589 100644 --- a/src/UserGuide/Master/Tree/User-Manual/UDF-development.md +++ b/src/UserGuide/Master/Tree/User-Manual/UDF-development.md @@ -1,4 +1,4 @@ - # UDF development + # UDF Development ## 1. UDF development diff --git a/src/UserGuide/Master/Tree/User-Manual/User-defined-function_apache.md b/src/UserGuide/Master/Tree/User-Manual/User-defined-function_apache.md index 42413bcad..d6623a360 100644 --- a/src/UserGuide/Master/Tree/User-Manual/User-defined-function_apache.md +++ b/src/UserGuide/Master/Tree/User-Manual/User-defined-function_apache.md @@ -1,4 +1,4 @@ -# USER-DEFINED FUNCTION (UDF) +# UDF ## 1. UDF Introduction diff --git a/src/UserGuide/Master/Tree/User-Manual/User-defined-function_timecho.md b/src/UserGuide/Master/Tree/User-Manual/User-defined-function_timecho.md index 63c195ce8..cd82c24df 100644 --- a/src/UserGuide/Master/Tree/User-Manual/User-defined-function_timecho.md +++ b/src/UserGuide/Master/Tree/User-Manual/User-defined-function_timecho.md @@ -1,4 +1,4 @@ -# USER-DEFINED FUNCTION (UDF) +# UDF ## 1. UDF Introduction diff --git a/src/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_apache.md b/src/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_apache.md index b61ac6f7a..931a75b3d 100644 --- a/src/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_apache.md +++ b/src/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_apache.md @@ -19,7 +19,7 @@ --> -# Common Concept +# Common Concepts ## 1. SQL Dialect Related Concepts diff --git a/src/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_timecho.md b/src/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_timecho.md index 40ff6cca8..236489032 100644 --- a/src/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_timecho.md +++ b/src/UserGuide/latest-Table/Background-knowledge/Cluster-Concept_timecho.md @@ -19,7 +19,7 @@ --> -# Common Concept +# Common Concepts ## 1. SQL Dialect Related Concepts diff --git a/src/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_apache.md b/src/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_apache.md index f3b777bf2..7c363efbb 100644 --- a/src/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_apache.md +++ b/src/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_apache.md @@ -19,7 +19,7 @@ --> -# Time Series Modeling +# Modeling Scheme Design This section introduces how to transform time series data application scenarios into IoTDB time series modeling. diff --git a/src/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_timecho.md b/src/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_timecho.md index 477666573..ed78fa2e1 100644 --- a/src/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_timecho.md +++ b/src/UserGuide/latest-Table/Background-knowledge/Data-Model-and-Terminology_timecho.md @@ -19,7 +19,7 @@ --> -# Time Series Modeling +# Modeling Scheme Design This section introduces how to transform time series data application scenarios into IoTDB time series modeling. diff --git a/src/UserGuide/latest-Table/Background-knowledge/Data-Type.md b/src/UserGuide/latest-Table/Background-knowledge/Data-Type.md index 34219dad3..71794dff6 100644 --- a/src/UserGuide/latest-Table/Background-knowledge/Data-Type.md +++ b/src/UserGuide/latest-Table/Background-knowledge/Data-Type.md @@ -19,7 +19,7 @@ --> -# Data Types +# Data Type ## 1. Basic Data Types diff --git a/src/UserGuide/latest-Table/Background-knowledge/Navigating_Time_Series_Data.md b/src/UserGuide/latest-Table/Background-knowledge/Navigating_Time_Series_Data.md index 024ecef37..a2308a55a 100644 --- a/src/UserGuide/latest-Table/Background-knowledge/Navigating_Time_Series_Data.md +++ b/src/UserGuide/latest-Table/Background-knowledge/Navigating_Time_Series_Data.md @@ -18,7 +18,7 @@ under the License. --> -# Time Series Data +# Timeseries Data Model ## 1. What is Time Series Data? diff --git a/src/UserGuide/latest-Table/Basic-Concept/Delete-Data.md b/src/UserGuide/latest-Table/Basic-Concept/Delete-Data.md index f2016dd7f..4099dc633 100644 --- a/src/UserGuide/latest-Table/Basic-Concept/Delete-Data.md +++ b/src/UserGuide/latest-Table/Basic-Concept/Delete-Data.md @@ -19,7 +19,7 @@ --> -# Data Deletion +# Delete Data ## 1. Data Deletion diff --git a/src/UserGuide/latest-Table/Basic-Concept/Query-Data.md b/src/UserGuide/latest-Table/Basic-Concept/Query-Data.md index 4a5c51a95..05e53c4c3 100644 --- a/src/UserGuide/latest-Table/Basic-Concept/Query-Data.md +++ b/src/UserGuide/latest-Table/Basic-Concept/Query-Data.md @@ -19,7 +19,7 @@ --> -# Data Query +# Query Data ## 1. Syntax Overview diff --git a/src/UserGuide/latest-Table/Basic-Concept/TTL-Delete-Data.md b/src/UserGuide/latest-Table/Basic-Concept/TTL-Delete-Data.md index df19a8596..be7619140 100644 --- a/src/UserGuide/latest-Table/Basic-Concept/TTL-Delete-Data.md +++ b/src/UserGuide/latest-Table/Basic-Concept/TTL-Delete-Data.md @@ -19,7 +19,7 @@ --> -# Automatic Data Expiration (TTL) +# TTL Delete Data ## 1. Overview diff --git a/src/UserGuide/latest-Table/Basic-Concept/Write-Updata-Data.md b/src/UserGuide/latest-Table/Basic-Concept/Write-Updata-Data.md index e40532b4a..8a5fc8aa9 100644 --- a/src/UserGuide/latest-Table/Basic-Concept/Write-Updata-Data.md +++ b/src/UserGuide/latest-Table/Basic-Concept/Write-Updata-Data.md @@ -19,7 +19,7 @@ --> -# Data Insertion & Update +# Write & Update Data ## 1. Data Insertion diff --git a/src/UserGuide/latest-Table/Deployment-and-Maintenance/Environment-Requirements.md b/src/UserGuide/latest-Table/Deployment-and-Maintenance/Environment-Requirements.md index dd2f1e26a..590baa139 100644 --- a/src/UserGuide/latest-Table/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/UserGuide/latest-Table/Deployment-and-Maintenance/Environment-Requirements.md @@ -18,7 +18,7 @@ under the License. --> -# System Requirements +# Environment Requirements ## 1. Disk Array diff --git a/src/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_apache.md b/src/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_apache.md index d94979310..d5e9f8fea 100644 --- a/src/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_apache.md +++ b/src/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_apache.md @@ -19,7 +19,7 @@ --> -# Product Introduction +# IoTDB Introduction Apache IoTDB is a low-cost, high-performance IoT-native time-series database. It addresses challenges faced by enterprises in managing time-series data for IoT big data platforms, including complex application scenarios, massive data volumes, high sampling frequencies, frequent out-of-order data, time-consuming data processing, diverse analytical requirements, and high storage and maintenance costs. diff --git a/src/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md b/src/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md index 60c0cbf44..c454bdcd5 100644 --- a/src/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md +++ b/src/UserGuide/latest-Table/IoTDB-Introduction/IoTDB-Introduction_timecho.md @@ -18,7 +18,7 @@ under the License. --> -# Product Introduction +# IoTDB Introduction TimechoDB is a high-performance, cost-efficient, and IoT-native time-series database developed by Timecho. As an enterprise-grade extension of Apache IoTDB, it is designed to tackle the complexities of managing large-scale time-series data in IoT environments. These challenges include high-frequency data sampling, massive data volumes, out-of-order data, extended processing times, diverse analytical demands, and high storage and maintenance costs. diff --git a/src/UserGuide/latest-Table/Reference/System-Config-Manual.md b/src/UserGuide/latest-Table/Reference/System-Config-Manual.md index 44e49f3b3..0dc2d654f 100644 --- a/src/UserGuide/latest-Table/Reference/System-Config-Manual.md +++ b/src/UserGuide/latest-Table/Reference/System-Config-Manual.md @@ -18,7 +18,7 @@ under the License. --> -# Configuration and Parameters +# Config Manual ## 1. IoTDB Configuration Files diff --git a/src/UserGuide/latest-Table/SQL-Manual/Keywords.md b/src/UserGuide/latest-Table/SQL-Manual/Keywords.md index 0bb31d769..34d530637 100644 --- a/src/UserGuide/latest-Table/SQL-Manual/Keywords.md +++ b/src/UserGuide/latest-Table/SQL-Manual/Keywords.md @@ -19,7 +19,7 @@ --> -# Reserved Words & Keywords +# Keywords Reserved keywords must be enclosed in double quotes (" ") to be used as identifiers. Below is a list of all reserved keywords in the IoTDB table model. diff --git a/src/UserGuide/latest-Table/Technical-Insider/Cluster-data-partitioning.md b/src/UserGuide/latest-Table/Technical-Insider/Cluster-data-partitioning.md index f9f37e622..ef1ddc8a8 100644 --- a/src/UserGuide/latest-Table/Technical-Insider/Cluster-data-partitioning.md +++ b/src/UserGuide/latest-Table/Technical-Insider/Cluster-data-partitioning.md @@ -18,7 +18,7 @@ under the License. --> -# Partitioning and Load Balance +# Data Partitioning and Load Balancing This document introduces the partitioning strategies and load balance strategies in IoTDB. According to the characteristics of time series data, IoTDB partitions them by series and time dimensions. Combining a series partition with a time partition creates a partition, the unit of division. To enhance throughput and reduce management costs, these partitions are evenly allocated to RegionGroups, which serve as the unit of replication. The RegionGroup's Regions then determine the storage location, with the leader Region managing the primary load. During this process, the Region placement strategy determines which nodes will host the replicas, while the leader selection strategy designates which Region will act as the leader. diff --git a/src/UserGuide/latest-Table/Technical-Insider/Encoding-and-Compression.md b/src/UserGuide/latest-Table/Technical-Insider/Encoding-and-Compression.md index fedf3c03e..6f0f1824a 100644 --- a/src/UserGuide/latest-Table/Technical-Insider/Encoding-and-Compression.md +++ b/src/UserGuide/latest-Table/Technical-Insider/Encoding-and-Compression.md @@ -18,7 +18,7 @@ under the License. --> -# Encoding and Compression +# Compression & Encoding IoTDB employs various encoding and compression techniques to enhance storage efficiency and reduce I/O operations during data writing and reading. Below is a detailed explanation of the supported encoding and compression methods. diff --git a/src/UserGuide/latest-Table/Tools-System/Benchmark.md b/src/UserGuide/latest-Table/Tools-System/Benchmark.md index af31651f4..b8dc8c4ff 100644 --- a/src/UserGuide/latest-Table/Tools-System/Benchmark.md +++ b/src/UserGuide/latest-Table/Tools-System/Benchmark.md @@ -18,7 +18,7 @@ under the License. --> -# Benchmark +# Benchmark Tool ## 1. **Basic Overview** diff --git a/src/UserGuide/latest-Table/Tools-System/Maintenance-Tool_apache.md b/src/UserGuide/latest-Table/Tools-System/Maintenance-Tool_apache.md index fdcdbdc9e..29fe1da59 100644 --- a/src/UserGuide/latest-Table/Tools-System/Maintenance-Tool_apache.md +++ b/src/UserGuide/latest-Table/Tools-System/Maintenance-Tool_apache.md @@ -19,7 +19,7 @@ --> -# Cluster Management Tools +# Cluster Management Tool ## 1. Data Directory Overview Tool diff --git a/src/UserGuide/latest-Table/Tools-System/Maintenance-Tool_timecho.md b/src/UserGuide/latest-Table/Tools-System/Maintenance-Tool_timecho.md index f16c251c2..725b758a4 100644 --- a/src/UserGuide/latest-Table/Tools-System/Maintenance-Tool_timecho.md +++ b/src/UserGuide/latest-Table/Tools-System/Maintenance-Tool_timecho.md @@ -18,7 +18,7 @@ under the License. --> -# Maintenance Tool +# Cluster Management Tool ## 1. IoTDB-OpsKit diff --git a/src/UserGuide/latest-Table/Tools-System/Monitor-Tool_apache.md b/src/UserGuide/latest-Table/Tools-System/Monitor-Tool_apache.md index 77a5f9bde..4015009c1 100644 --- a/src/UserGuide/latest-Table/Tools-System/Monitor-Tool_apache.md +++ b/src/UserGuide/latest-Table/Tools-System/Monitor-Tool_apache.md @@ -19,7 +19,7 @@ --> -# Prometheus +# Monitor Tool The deployment of monitoring tools can be referenced in the document [Monitoring Panel Deployment](../Deployment-and-Maintenance/Monitoring-panel-deployment.md) chapter. diff --git a/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md b/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md index 02b233cb4..df9ed3a38 100644 --- a/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md +++ b/src/UserGuide/latest-Table/User-Manual/Data-Sync_apache.md @@ -19,7 +19,7 @@ --> -# Data Synchronization +# Data Sync Data synchronization is a typical requirement in the Industrial Internet of Things (IIoT). Through data synchronization mechanisms, data sharing between IoTDB instances can be achieved, enabling the establishment of a complete data pipeline to meet needs such as internal and external network data exchange, edge-to-cloud synchronization, data migration, and data backup. diff --git a/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md b/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md index 92a097141..655087533 100644 --- a/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md +++ b/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md @@ -18,7 +18,7 @@ under the License. --> -# Data Synchronization +# Data Sync Data synchronization is a typical requirement in the Industrial Internet of Things (IIoT). Through data synchronization mechanisms, data sharing between IoTDB instances can be achieved, enabling the establishment of a complete data pipeline to meet needs such as internal and external network data exchange, edge-to-cloud synchronization, data migration, and data backup. diff --git a/src/UserGuide/latest-Table/User-Manual/Maintenance-commands.md b/src/UserGuide/latest-Table/User-Manual/Maintenance-commands.md index 8454fd993..09961050d 100644 --- a/src/UserGuide/latest-Table/User-Manual/Maintenance-commands.md +++ b/src/UserGuide/latest-Table/User-Manual/Maintenance-commands.md @@ -18,6 +18,7 @@ under the License. --> +# Maintenance Statement ## 1. Status Checking diff --git a/src/UserGuide/latest/API/Programming-Data-Subscription.md b/src/UserGuide/latest/API/Programming-Data-Subscription.md index 281cc9864..f7d58c4f5 100644 --- a/src/UserGuide/latest/API/Programming-Data-Subscription.md +++ b/src/UserGuide/latest/API/Programming-Data-Subscription.md @@ -19,7 +19,7 @@ * limitations under the License. --> -# Data subscription API +# Data Subscription API IoTDB provides powerful data subscription functionality, allowing users to access newly added data from IoTDB in real-time through subscription APIs. For detailed functional definitions and introductions：[Data subscription](../User-Manual/Data-subscription.md) diff --git a/src/UserGuide/latest/API/Programming-Java-Native-API.md b/src/UserGuide/latest/API/Programming-Java-Native-API.md index 53b445885..f38cbfd37 100644 --- a/src/UserGuide/latest/API/Programming-Java-Native-API.md +++ b/src/UserGuide/latest/API/Programming-Java-Native-API.md @@ -17,7 +17,7 @@ * limitations under the License. --> -# Session Native API +# Java Native API In the native API of IoTDB, the `Session` is the core interface for interacting with the database. It integrates a rich set of methods that support data writing, querying, and metadata operations. By instantiating a `Session`, you can establish a connection to the IoTDB server and perform various database operations within the environment constructed by this connection. The `Session` is not thread-safe and should not be called simultaneously by multiple threads. diff --git a/src/UserGuide/latest/API/Programming-Rust-Native-API.md b/src/UserGuide/latest/API/Programming-Rust-Native-API.md index d25923e71..f3fcacf46 100644 --- a/src/UserGuide/latest/API/Programming-Rust-Native-API.md +++ b/src/UserGuide/latest/API/Programming-Rust-Native-API.md @@ -19,7 +19,7 @@ --> -# Rust Native API Native API +# Rust Native API IoTDB uses Thrift as a cross language RPC framework, so access to IoTDB can be achieved through the interface provided by Thrift. This document will introduce how to generate a native Rust interface that can access IoTDB. diff --git a/src/UserGuide/latest/API/RestServiceV1.md b/src/UserGuide/latest/API/RestServiceV1.md index 4fb834708..532ec3c7e 100644 --- a/src/UserGuide/latest/API/RestServiceV1.md +++ b/src/UserGuide/latest/API/RestServiceV1.md @@ -19,7 +19,7 @@ --> -# RESTful API V1(Not Recommend) +# REST API V1(Not Recommend) IoTDB's RESTful services can be used for query, write, and management operations, using the OpenAPI standard to define interfaces and generate frameworks. ## 1. Enable RESTful Services diff --git a/src/UserGuide/latest/API/RestServiceV2.md b/src/UserGuide/latest/API/RestServiceV2.md index 186cd1360..f3b97f823 100644 --- a/src/UserGuide/latest/API/RestServiceV2.md +++ b/src/UserGuide/latest/API/RestServiceV2.md @@ -19,7 +19,7 @@ --> -# RESTful API V2 +# REST API V2 IoTDB's RESTful services can be used for query, write, and management operations, using the OpenAPI standard to define interfaces and generate frameworks. ## 1. Enable RESTful Services diff --git a/src/UserGuide/latest/Background-knowledge/Data-Model-and-Terminology_apache.md b/src/UserGuide/latest/Background-knowledge/Data-Model-and-Terminology_apache.md index f3b777bf2..7c363efbb 100644 --- a/src/UserGuide/latest/Background-knowledge/Data-Model-and-Terminology_apache.md +++ b/src/UserGuide/latest/Background-knowledge/Data-Model-and-Terminology_apache.md @@ -19,7 +19,7 @@ --> -# Time Series Modeling +# Modeling Scheme Design This section introduces how to transform time series data application scenarios into IoTDB time series modeling. diff --git a/src/UserGuide/latest/Background-knowledge/Data-Model-and-Terminology_timecho.md b/src/UserGuide/latest/Background-knowledge/Data-Model-and-Terminology_timecho.md index 477666573..ed78fa2e1 100644 --- a/src/UserGuide/latest/Background-knowledge/Data-Model-and-Terminology_timecho.md +++ b/src/UserGuide/latest/Background-knowledge/Data-Model-and-Terminology_timecho.md @@ -19,7 +19,7 @@ --> -# Time Series Modeling +# Modeling Scheme Design This section introduces how to transform time series data application scenarios into IoTDB time series modeling. diff --git a/src/UserGuide/latest/Background-knowledge/Navigating_Time_Series_Data.md b/src/UserGuide/latest/Background-knowledge/Navigating_Time_Series_Data.md index 121373d1c..8ae94a763 100644 --- a/src/UserGuide/latest/Background-knowledge/Navigating_Time_Series_Data.md +++ b/src/UserGuide/latest/Background-knowledge/Navigating_Time_Series_Data.md @@ -18,7 +18,7 @@ under the License. --> -# Entering Time Series Data +# Timeseries Data Model ## 1. What Is Time Series Data？ diff --git a/src/UserGuide/latest/Basic-Concept/Operate-Metadata_apache.md b/src/UserGuide/latest/Basic-Concept/Operate-Metadata_apache.md index 688211f3e..de7833bcd 100644 --- a/src/UserGuide/latest/Basic-Concept/Operate-Metadata_apache.md +++ b/src/UserGuide/latest/Basic-Concept/Operate-Metadata_apache.md @@ -19,7 +19,7 @@ --> -# Timeseries Management +# Data Modeling ## 1. Database Management diff --git a/src/UserGuide/latest/Basic-Concept/Operate-Metadata_timecho.md b/src/UserGuide/latest/Basic-Concept/Operate-Metadata_timecho.md index b101a9057..f617f29e7 100644 --- a/src/UserGuide/latest/Basic-Concept/Operate-Metadata_timecho.md +++ b/src/UserGuide/latest/Basic-Concept/Operate-Metadata_timecho.md @@ -19,7 +19,7 @@ --> -# Timeseries Management +# Data Modeling ## 1. Database Management diff --git a/src/UserGuide/latest/Basic-Concept/Write-Delete-Data.md b/src/UserGuide/latest/Basic-Concept/Write-Delete-Data.md index 8c009eac1..70f358c64 100644 --- a/src/UserGuide/latest/Basic-Concept/Write-Delete-Data.md +++ b/src/UserGuide/latest/Basic-Concept/Write-Delete-Data.md @@ -20,7 +20,7 @@ --> -# Write & Delete Data +# Write & Delete ## 1. CLI INSERT IoTDB provides users with a variety of ways to insert real-time data, such as directly inputting [INSERT SQL statement](../SQL-Manual/SQL-Manual.md#insert-data) in [Client/Shell tools](../Tools-System/CLI.md), or using [Java JDBC](../API/Programming-JDBC.md) to perform single or batch execution of [INSERT SQL statement](../SQL-Manual/SQL-Manual.md). diff --git a/src/UserGuide/latest/Deployment-and-Maintenance/Environment-Requirements.md b/src/UserGuide/latest/Deployment-and-Maintenance/Environment-Requirements.md index 72f2e5081..69dcd6653 100644 --- a/src/UserGuide/latest/Deployment-and-Maintenance/Environment-Requirements.md +++ b/src/UserGuide/latest/Deployment-and-Maintenance/Environment-Requirements.md @@ -18,7 +18,7 @@ under the License. --> -# System Requirements +# Environment Requirements ## 1. Disk Array diff --git a/src/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_apache.md b/src/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_apache.md index 71f394c8f..5684a8deb 100644 --- a/src/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_apache.md +++ b/src/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_apache.md @@ -19,7 +19,7 @@ --> -# What is IoTDB +# IoTDB Introduction Apache IoTDB is a low-cost, high-performance native temporal database for the Internet of Things. It can solve various problems encountered by enterprises when building IoT big data platforms to manage time-series data, such as complex application scenarios, large data volumes, high sampling frequencies, high amount of unaligned data, long data processing time, diverse analysis requirements, and high storage and operation costs. diff --git a/src/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_timecho.md b/src/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_timecho.md index 7c03f8a40..c30e5c9d4 100644 --- a/src/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_timecho.md +++ b/src/UserGuide/latest/IoTDB-Introduction/IoTDB-Introduction_timecho.md @@ -19,7 +19,7 @@ --> -# What is TimechoDB +# IoTDB Introduction TimechoDB is a low-cost, high-performance native temporal database for the Internet of Things, provided by Timecho based on the Apache IoTDB community version as an original commercial product. It can solve various problems encountered by enterprises when building IoT big data platforms to manage time-series data, such as complex application scenarios, large data volumes, high sampling frequencies, high amount of unaligned data, long data processing time, diverse analysis requirements, and high storage and operation costs. diff --git a/src/UserGuide/latest/Reference/Common-Config-Manual.md b/src/UserGuide/latest/Reference/Common-Config-Manual.md index ca38812b8..8c8e2b936 100644 --- a/src/UserGuide/latest/Reference/Common-Config-Manual.md +++ b/src/UserGuide/latest/Reference/Common-Config-Manual.md @@ -19,7 +19,7 @@ --> -# Common Configuration +# Common Config Manual IoTDB common files for ConfigNode and DataNode are under `conf`. diff --git a/src/UserGuide/latest/Reference/ConfigNode-Config-Manual.md b/src/UserGuide/latest/Reference/ConfigNode-Config-Manual.md index 7a2b8e6f6..5203166af 100644 --- a/src/UserGuide/latest/Reference/ConfigNode-Config-Manual.md +++ b/src/UserGuide/latest/Reference/ConfigNode-Config-Manual.md @@ -19,7 +19,7 @@ --> -# ConfigNode Configuration +# ConfigNode Config Manual IoTDB ConfigNode files are under `conf`. diff --git a/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md b/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md index d452a6673..e2a3ca1b2 100644 --- a/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md +++ b/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md @@ -19,7 +19,7 @@ --> -# DataNode Configuration Parameters +# DataNode Config Manual We use the same configuration files for IoTDB DataNode and Standalone version, all under the `conf`. diff --git a/src/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md b/src/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md index 4dbe77f53..3c6e3f938 100644 --- a/src/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md +++ b/src/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md @@ -19,7 +19,7 @@ --> -# DataNode Configuration Parameters +# DataNode Config Manual We use the same configuration files for IoTDB DataNode and Standalone version, all under the `conf`. diff --git a/src/UserGuide/latest/Technical-Insider/Cluster-data-partitioning.md b/src/UserGuide/latest/Technical-Insider/Cluster-data-partitioning.md index 11ee2be4e..204132f62 100644 --- a/src/UserGuide/latest/Technical-Insider/Cluster-data-partitioning.md +++ b/src/UserGuide/latest/Technical-Insider/Cluster-data-partitioning.md @@ -19,7 +19,7 @@ --> -# Load Balance +# Data Partitioning & Load Balancing This document introduces the partitioning strategies and load balance strategies in IoTDB. According to the characteristics of time series data, IoTDB partitions them by series and time dimensions. Combining a series partition with a time partition creates a partition, the unit of division. To enhance throughput and reduce management costs, these partitions are evenly allocated to RegionGroups, which serve as the unit of replication. The RegionGroup's Regions then determine the storage location, with the leader Region managing the primary load. During this process, the Region placement strategy determines which nodes will host the replicas, while the leader selection strategy designates which Region will act as the leader. ## 1. Partitioning Strategy & Partition Allocation diff --git a/src/UserGuide/latest/Technical-Insider/Encoding-and-Compression.md b/src/UserGuide/latest/Technical-Insider/Encoding-and-Compression.md index 632f29674..b71925665 100644 --- a/src/UserGuide/latest/Technical-Insider/Encoding-and-Compression.md +++ b/src/UserGuide/latest/Technical-Insider/Encoding-and-Compression.md @@ -19,7 +19,7 @@ --> -# Encoding and Compression +# Compression & Encoding ## 1. Encoding Methods diff --git a/src/UserGuide/latest/Technical-Insider/Publication.md b/src/UserGuide/latest/Technical-Insider/Publication.md index 1f1832ef0..f040b12c5 100644 --- a/src/UserGuide/latest/Technical-Insider/Publication.md +++ b/src/UserGuide/latest/Technical-Insider/Publication.md @@ -19,7 +19,7 @@ --> -# Academic Achievement +# Research Paper Apache IoTDB starts at Tsinghua University, School of Software. IoTDB is a database for managing large amount of time series data with columnar storage, data encoding, pre-computation, and index techniques. It has SQL-like interface to write millions of data points per second per node and is optimized to get query results in few seconds over trillions of data points. It can also be easily integrated with Apache Hadoop MapReduce and Apache Spark for analytics. diff --git a/src/UserGuide/latest/Tools-System/Maintenance-Tool_apache.md b/src/UserGuide/latest/Tools-System/Maintenance-Tool_apache.md index 1587518da..51fc20f46 100644 --- a/src/UserGuide/latest/Tools-System/Maintenance-Tool_apache.md +++ b/src/UserGuide/latest/Tools-System/Maintenance-Tool_apache.md @@ -18,7 +18,7 @@ under the License. --> -# Cluster management tool +# Cluster Management Tool ## 1. IoTDB Data Directory Overview Tool diff --git a/src/UserGuide/latest/Tools-System/Maintenance-Tool_timecho.md b/src/UserGuide/latest/Tools-System/Maintenance-Tool_timecho.md index 651154352..9a8405f52 100644 --- a/src/UserGuide/latest/Tools-System/Maintenance-Tool_timecho.md +++ b/src/UserGuide/latest/Tools-System/Maintenance-Tool_timecho.md @@ -18,7 +18,7 @@ under the License. --> -# Cluster management tool +# Cluster Management Tool ## 1. IoTDB-OpsKit diff --git a/src/UserGuide/latest/User-Manual/AINode_apache.md b/src/UserGuide/latest/User-Manual/AINode_apache.md index 20f5e1192..2abf23e73 100644 --- a/src/UserGuide/latest/User-Manual/AINode_apache.md +++ b/src/UserGuide/latest/User-Manual/AINode_apache.md @@ -19,7 +19,7 @@ --> -# AI Capability（AINode） +# AI Capability AINode is the third internal node after ConfigNode and DataNode in Apache IoTDB, which extends the capability of machine learning analysis of time series by interacting with DataNode and ConfigNode of IoTDB cluster, supports the introduction of pre-existing machine learning models from the outside to be registered, and uses the registered models in the It supports the process of introducing existing machine learning models from outside for registration, and using the registered models to complete the time series analysis tasks on the specified time series data through simple SQL statements, which integrates the model creation, management and inference in the database engine. At present, we have provided machine learning algorithms or self-developed models for common timing analysis scenarios (e.g. prediction and anomaly detection). diff --git a/src/UserGuide/latest/User-Manual/AINode_timecho.md b/src/UserGuide/latest/User-Manual/AINode_timecho.md index 9c593ad07..7095ba16d 100644 --- a/src/UserGuide/latest/User-Manual/AINode_timecho.md +++ b/src/UserGuide/latest/User-Manual/AINode_timecho.md @@ -19,7 +19,7 @@ --> -# AI Capability（AINode） +# AI Capability AINode is the third internal node after ConfigNode and DataNode in Apache IoTDB, which extends the capability of machine learning analysis of time series by interacting with DataNode and ConfigNode of IoTDB cluster, supports the introduction of pre-existing machine learning models from the outside to be registered, and uses the registered models in the It supports the process of introducing existing machine learning models from outside for registration, and using the registered models to complete the time series analysis tasks on the specified time series data through simple SQL statements, which integrates the model creation, management and inference in the database engine. At present, we have provided machine learning algorithms or self-developed models for common timing analysis scenarios (e.g. prediction and anomaly detection). diff --git a/src/UserGuide/latest/User-Manual/Authority-Management.md b/src/UserGuide/latest/User-Manual/Authority-Management.md index ea58dc7bd..b13648a9a 100644 --- a/src/UserGuide/latest/User-Manual/Authority-Management.md +++ b/src/UserGuide/latest/User-Manual/Authority-Management.md @@ -19,7 +19,7 @@ --> -# Database Administration +# Authority Management IoTDB provides permission management operations, offering users the ability to manage permissions for data and cluster systems, ensuring data and system security. diff --git a/src/UserGuide/latest/User-Manual/Data-Sync_apache.md b/src/UserGuide/latest/User-Manual/Data-Sync_apache.md index 1db4190cd..696832a20 100644 --- a/src/UserGuide/latest/User-Manual/Data-Sync_apache.md +++ b/src/UserGuide/latest/User-Manual/Data-Sync_apache.md @@ -19,7 +19,7 @@ --> -# Data Synchronisation +# Data Sync Data synchronization is a typical requirement in industrial Internet of Things (IoT). Through data synchronization mechanisms, it is possible to achieve data sharing between IoTDB, and to establish a complete data link to meet the needs for internal and external network data interconnectivity, edge-cloud synchronization, data migration, and data backup. diff --git a/src/UserGuide/latest/User-Manual/Load-Balance.md b/src/UserGuide/latest/User-Manual/Load-Balance.md index ce193b75e..305b237cc 100644 --- a/src/UserGuide/latest/User-Manual/Load-Balance.md +++ b/src/UserGuide/latest/User-Manual/Load-Balance.md @@ -19,12 +19,12 @@ --> -## Load Balance +# Load Balance Region migration belongs to advanced operations and maintenance functions, which have certain operational costs. It is recommended to read the entire document before using this function. If you have any questions about the solution design, please contact the IoTDB team for technical support. -### Feature introduction +## 1. Feature introduction IoTDB is a distributed database, and the balanced distribution of data plays an important role in load balancing the disk space and write pressure of the cluster. Region is the basic unit for distributed storage of data in IoTDB cluster, and the specific concept can be seen in [region](../Background-knowledge/Cluster-Concept.md)。 @@ -35,14 +35,14 @@ Here is a schematic diagram of the region migration process : ![](/img/region%E8%BF%81%E7%A7%BB%E7%A4%BA%E6%84%8F%E5%9B%BE20241210.png) -### Notes +## 2. Notes 1. It is recommended to only use the Region Migration feature on IoTDB 1.3.3 and higher versions. 2. Region migration is only supported when the consensus protocol is IoTConsus or Ratis (in iotdb system. properties, the `schema_region_consensus_protocol_class` and`data_region_consensus_protocol_class`). 3. Region migration consumes system resources such as disk space and network bandwidth. It is recommended to perform the migration during periods of low business load. 4. Under ideal circumstances, Region migration does not affect user-side read or write operations. In special cases, Region migration may block writes. For detailed identification and handling of such situations, please refer to the user guide. -### Instructions for use +## 3. Instructions for use - **Grammar definition** : diff --git a/src/UserGuide/latest/User-Manual/Query-Performance-Analysis.md b/src/UserGuide/latest/User-Manual/Query-Performance-Analysis.md index 6d68830bd..57c2556dd 100644 --- a/src/UserGuide/latest/User-Manual/Query-Performance-Analysis.md +++ b/src/UserGuide/latest/User-Manual/Query-Performance-Analysis.md @@ -20,9 +20,7 @@ --> -# Maintennance - -## Query Performance Analysis +# Query Performance Analysis The purpose of query analysis is to assist users in understanding the execution mechanism and performance bottlenecks of queries, thereby facilitating query optimization and performance enhancement. This is crucial not only for the efficiency of query execution but also for the user experience of applications and the efficient utilization of resources. For effective query analysis, IoTDB versions V1.3.2 and above offer the query analysis statements: Explain and Explain Analyze. @@ -38,7 +36,7 @@ The comparison of various methods is as follows: | Monitoring Panel | Medium. Requires the installation of the IoTDB monitoring panel tool (an enterprise version tool) and the activation of the IoTDB monitoring service. | Medium. The IoTDB monitoring service's recording of metrics will introduce additional latency. | Supports distributed systems, but only analyzes the overall query load and time consumption of the database. | | Arthas Sampling | Medium. Requires the installation of the Java Arthas tool (Arthas cannot be directly installed in some intranets, and sometimes a restart of the application is needed after installation). | High. CPU sampling may affect the response speed of online business. | Does not support distributed systems and only analyzes the overall query load and time consumption of the database. | -### Explain Statement +## 1. Explain Statement #### Syntax @@ -83,7 +81,7 @@ Executing the above SQL will yield the following results. It is evident that IoT +-----------------------------------------------------------------------+ ``` -### Explain Analyze Statement +## 2. Explain Analyze Statement #### Syntax @@ -268,7 +266,7 @@ FRAGMENT-INSTANCE[Id: 20240311_041502_00001_1.3.0][IP: 192.168.130.9][DataRegion ``` -### Common Issues +## 3.Common Issues #### What is the difference between WALL TIME and CPU TIME? @@ -312,7 +310,7 @@ Because even if this part of the unaligned data is entered into the sequence, IO During the upgrade, only the lib package was replaced, and the conf/logback-datanode.xml was not replaced. It needs to be replaced, and there is no need to restart (the content of this file can be hot loaded). After waiting for about 1 minute, re-execute explain analyze verbose. -### Practical Case Studies +## 4. Practical Case Studies #### Case Study 1: The query involves too many files, and disk IO becomes a bottleneck, causing the query speed to slow down. diff --git a/src/UserGuide/latest/User-Manual/Trigger.md b/src/UserGuide/latest/User-Manual/Trigger.md index 5e05607da..1dda77b96 100644 --- a/src/UserGuide/latest/User-Manual/Trigger.md +++ b/src/UserGuide/latest/User-Manual/Trigger.md @@ -19,7 +19,7 @@ --> -# TRIGGER +# Trigger ## 1. Instructions diff --git a/src/UserGuide/latest/User-Manual/UDF-development.md b/src/UserGuide/latest/User-Manual/UDF-development.md index a866f4df6..815712589 100644 --- a/src/UserGuide/latest/User-Manual/UDF-development.md +++ b/src/UserGuide/latest/User-Manual/UDF-development.md @@ -1,4 +1,4 @@ - # UDF development + # UDF Development ## 1. UDF development diff --git a/src/UserGuide/latest/User-Manual/User-defined-function_apache.md b/src/UserGuide/latest/User-Manual/User-defined-function_apache.md index 42413bcad..d6623a360 100644 --- a/src/UserGuide/latest/User-Manual/User-defined-function_apache.md +++ b/src/UserGuide/latest/User-Manual/User-defined-function_apache.md @@ -1,4 +1,4 @@ -# USER-DEFINED FUNCTION (UDF) +# UDF ## 1. UDF Introduction diff --git a/src/UserGuide/latest/User-Manual/User-defined-function_timecho.md b/src/UserGuide/latest/User-Manual/User-defined-function_timecho.md index 63c195ce8..cd82c24df 100644 --- a/src/UserGuide/latest/User-Manual/User-defined-function_timecho.md +++ b/src/UserGuide/latest/User-Manual/User-defined-function_timecho.md @@ -1,4 +1,4 @@ -# USER-DEFINED FUNCTION (UDF) +# UDF ## 1. UDF Introduction