You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by qi...@apache.org on 2020/11/11 04:38:24 UTC
[iotdb] branch master updated: correct errors in the documents
(#1989)
This is an automated email from the ASF dual-hosted git repository.
qiaojialin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new f8b3d1c correct errors in the documents (#1989)
f8b3d1c is described below
commit f8b3d1ce83400b2d218071cbb9b59d09a9afd599
Author: ZHOU JESSE <69...@users.noreply.github.com>
AuthorDate: Wed Nov 11 12:38:07 2020 +0800
correct errors in the documents (#1989)
---
docs/SystemDesign/Tools/Sync.md | 2 +-
docs/UserGuide/Server/ServerFileList.md | 4 +--
docs/UserGuide/Server/Single Node Setup.md | 4 +--
docs/UserGuide/System Tools/JMX Tool.md | 2 +-
.../UserGuide/System Tools/Load External Tsfile.md | 4 +--
.../System Tools/Monitor and Log Tools.md | 31 +++++++++++-----------
.../Query History Visualization Tool.md | 6 ++---
docs/UserGuide/System Tools/Sync Tool.md | 2 +-
docs/UserGuide/System Tools/Watermark Tool.md | 2 +-
docs/UserGuide/UserGuideReadme.md | 4 +--
10 files changed, 30 insertions(+), 31 deletions(-)
diff --git a/docs/SystemDesign/Tools/Sync.md b/docs/SystemDesign/Tools/Sync.md
index a429353..5a71b7a 100644
--- a/docs/SystemDesign/Tools/Sync.md
+++ b/docs/SystemDesign/Tools/Sync.md
@@ -184,7 +184,7 @@ Each time the sending end of the synchronization tool starts a synchronization t
### Statement of needs
-* Because the receiving end needs to receive files from multiple sending ends at the same time, it is necessary to distinguish files from different sending ends and manage these files in a unified manner.
+* Because the receiver needs to receive files from multiple senders at the same time, it is necessary to distinguish files from different senders and manage these files in a unified manner.
* The receiving end receives the file from the transmitting end and verifies the file name, the file data, and the MD5 value of the file. After the file is received, the file is stored locally at the receiving end, and the received tsfile file is checked for the MD5 value and the end of the file is checked. If the check is passed correctly, the file is retransmitted.
diff --git a/docs/UserGuide/Server/ServerFileList.md b/docs/UserGuide/Server/ServerFileList.md
index 766f52e..0275674 100644
--- a/docs/UserGuide/Server/ServerFileList.md
+++ b/docs/UserGuide/Server/ServerFileList.md
@@ -37,7 +37,7 @@
> under directory basedir/system/schema
1. system.properties
- + record all immutable properties, will be checked when starting IoTDB to avoid system error
+ + record all immutable properties, will be checked when starting IoTDB to avoid system errors
## State Related Files
@@ -88,7 +88,7 @@
#### Version
> under directory basedir/system/storage_groups/{StorageGroupName}/{TimePartitionId} or upgrade
1. Version-{version}
- + version file, record the max version in fileName of a stroage group
+ + version file, record the max version in fileName of a storage group
#### Upgrade
> under directory basedir/system/upgrade
diff --git a/docs/UserGuide/Server/Single Node Setup.md b/docs/UserGuide/Server/Single Node Setup.md
index 8931b81..b38b21c 100644
--- a/docs/UserGuide/Server/Single Node Setup.md
+++ b/docs/UserGuide/Server/Single Node Setup.md
@@ -21,7 +21,7 @@
# Single Node Setup
-Users can start IoTDB by the start-server script under the sbin folder.
+Users are able to start IoTDB through the start-server script under the sbin folder.
```
# Unix/OS X
@@ -35,4 +35,4 @@ or
- "-c" and "-rpc_port" are optional.
- option "-c" specifies the system configuration file directory.
- option "-rpc_port" specifies the rpc port.
-- if both option specified, the *rpc_port* will overrides the rpc_port in *conf_path*.
\ No newline at end of file
+- if both option specified, the *rpc_port* will override the rpc_port in *conf_path*.
\ No newline at end of file
diff --git a/docs/UserGuide/System Tools/JMX Tool.md b/docs/UserGuide/System Tools/JMX Tool.md
index 23c5b60..3851b4b 100644
--- a/docs/UserGuide/System Tools/JMX Tool.md
+++ b/docs/UserGuide/System Tools/JMX Tool.md
@@ -51,7 +51,7 @@ Step 4: Use jvisualvm
<img style="width:100%; max-width:300px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="https://user-images.githubusercontent.com/19167280/81464569-725e0200-91f5-11ea-9ff9-49745f4c9ef2.png">
4. Fill in information and log in as below. Remember to check "Do not require SSL connection".
-Here is an example:
+An example is:
Connection：192.168.130.15:31999
Username：iotdb
Password：passw!d
diff --git a/docs/UserGuide/System Tools/Load External Tsfile.md b/docs/UserGuide/System Tools/Load External Tsfile.md
index d0f3ac9..150e57a 100644
--- a/docs/UserGuide/System Tools/Load External Tsfile.md
+++ b/docs/UserGuide/System Tools/Load External Tsfile.md
@@ -37,7 +37,7 @@ This command has two usages:
1. Load a single tsfile by specifying a file path (absolute path).
-The second parameter indicates the path of the tsfile to be loaded and the name of the tsfile needs to conform to the tsfile naming convention, that is, `{systemTime}-{versionNum}-{mergeNum} .tsfile`. The third and fourth parameters are optional. When the metadata corresponding to the timeseries in the tsfile to be loaded does not exist, you can choose whether to create the schema automatically. If the third parameter is true, the schema will be created automatically. If the thrid parame [...]
+The second parameter indicates the path of the tsfile to be loaded and the name of the tsfile needs to conform to the tsfile naming convention, that is, `{systemTime}-{versionNum}-{mergeNum} .tsfile`. The third and fourth parameters are optional. If the metadata correspond to the timeseries in the tsfile to be loaded does not exist, you can choose whether to create the schema automatically. If the third parameter is true, the schema is created automatically. If the third parameter is fal [...]
If the `.resource` file corresponding to the file exists, it will be loaded into the data directory and engine of the Apache IoTDB. Otherwise, the corresponding `.resource` file will be regenerated from the tsfile file.
Examples:
@@ -72,7 +72,7 @@ Examples:
## move a tsfile to a target directory
-The command to move a tsfile to ta arget directory is: `move "<path>" "<dir>"`.
+The command to move a tsfile to target directory is: `move "<path>" "<dir>"`.
This command moves a tsfile to a target directory by specifying tsfile path and the target directory(absolute path). The specific implementation is to remove the tsfile from the engine and move the tsfile file and its corresponding `.resource` file to the target directory.
diff --git a/docs/UserGuide/System Tools/Monitor and Log Tools.md b/docs/UserGuide/System Tools/Monitor and Log Tools.md
index be4a9c2..966bab31 100644
--- a/docs/UserGuide/System Tools/Monitor and Log Tools.md
+++ b/docs/UserGuide/System Tools/Monitor and Log Tools.md
@@ -23,19 +23,19 @@
## System Monitor
-Currently, IoTDB provides users to use Java's JConsole tool to monitor system status or use IoTDB's open API to check data status.
+Currently, IoTDB provides users Java's JConsole tool to monitor system status or use IoTDB's open API to check data status.
### System Status Monitoring
-After starting JConsole tool and connecting to IoTDB server, you will have a basic look at IoTDB system status(CPU Occupation, in-memory information, etc.). See [official documentation](https://docs.oracle.com/javase/7/docs/technotes/guides/management/jconsole.html) for more informations.
+After starting JConsole tool and connecting to IoTDB server, a basic look at IoTDB system status(CPU Occupation, in-memory information, etc.) is provided. See [official documentation](https://docs.oracle.com/javase/7/docs/technotes/guides/management/jconsole.html) for more information.
#### JMX MBean Monitoring
-By using JConsole tool and connecting with JMX you can see some system statistics and parameters.
+By using JConsole tool and connecting with JMX you are provided with some system statistics and parameters.
This section describes how to use the JConsole ```Mbean``` tab to monitor the number of files opened by the IoTDB service process, the size of the data file, and so on. Once connected to JMX, you can find the ```MBean``` named ```org.apache.iotdb.service``` through the ```MBeans``` tab, as shown in the following Figure.
<img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="https://user-images.githubusercontent.com/20263106/53316064-54aec080-3901-11e9-9a49-76563ac09192.png">
-There are several attributes under Monitor, including the numbers of files opened in different folders, the data file size statistics and the values of some system parameters. By double-clicking the value corresponding to an attribute it can also display a line chart of that attribute. In particular, all the opened file count statistics are currently only supported on ```MacOS``` and most ```Linux``` distro except ```CentOS```. For the OS not supported these statistics will return ```-2` [...]
+There are several attributes under Monitor, including the numbers of files opened in different folders, the data file size statistics and the values of some system parameters. By double-clicking the value corresponding to an attribute it also displays a line chart of that attribute. Currently, all the opened file count statistics are only supported on ```MacOS``` and most ```Linux``` distro except ```CentOS```. For the OS not supported these statistics returns ```-2```. See the following [...]
##### MBean Monitor Attributes List
@@ -148,7 +148,7 @@ There are several attributes under Monitor, including the numbers of files opene
### Data Status Monitoring
-This module is the statistical monitoring method provided by IoTDB for users to store data information. We will record the statistical data in the system and store it in the database. The current 0.8.0 version of IoTDB provides statistics for writing data.
+This module is the statistical monitoring method provided by IoTDB for users to store data information. The statistical data are recorded in the system and stored in the database. The current 0.8.0 version of IoTDB provides statistics for writing data.
The user can choose to enable or disable the data statistics monitoring function (set the `enable_stat_monitor` item in the configuration file).
@@ -158,9 +158,9 @@ The current statistics of writing data by the system can be divided into two maj
The system defaults to collect data every 5 seconds, and writes the statistics to the IoTDB and stores them in a system-specified locate. (If you need to change the statistic frequency, you can set The `back_loop_period_in_second entry` in the configuration file, see Section [Engine Layer](../Server/Single%20Node%20Setup.md) for details). After the system is refreshed or restarted, IoTDB does not recover the statistics, and the statistics data will restart from zero.
-In order to avoid the excessive use of statistical information, we add a mechanism to periodically clear invalid data for statistical information. The system will delete invalid data at regular intervals. The user can set the trigger frequency (`stat_monitor_retain_interval_in_second`, default is 600s, see section [Engine Layer](../Server/Single%20Node%20Setup.md) for details) to set the frequency of deleting data. By setting the valid data duration (`stat_monitor_detect_freq_in_second e [...]
+To avoid the excessive use of statistical information, a mechanism is set to periodically clear invalid data for statistical information. The system deletes invalid data at regular intervals. The user set the trigger frequency (`stat_monitor_retain_interval_in_second`, default is 600s, see section [Engine Layer](../Server/Single%20Node%20Setup.md) for details) to set the frequency of deleting data. By setting the valid data duration (`stat_monitor_detect_freq_in_second entry`, the defaul [...]
-It's convenient for you to use `select` clause to get the writing data statistics the same as other timeseires.
+It's convenient for you to use `select` clause to get the writing data statistics the same as other timeseries.
Here are the writing data statistics:
@@ -266,19 +266,19 @@ Here are the writing data statistics:
Here we give some example of using writing data statistics.
-If you want to know the global successful writing points number, you can use `select` clause to query it's value. The query statement is like this:
+To know the global successful writing points number, use `select` clause to query it's value. The query statement is:
```
select TOTAL_POINTS_SUCCESS from root.stats.write.global
```
-If you want to know the successfule writing points number of root.ln (storage group), here is the query statement:
+To know the successfule writing points number of root.ln (storage group), the query statement is:
```
select TOTAL_POINTS_SUCCESS from root.stats.write.root_ln
```
-If you want to know the current timeseries point in the system, you can use `MAX_VALUE` function to query. Here is the query statement:
+To know the current timeseries point in the system, use `MAX_VALUE` function to query. Here is the query statement:
```
select MAX_VALUE(TOTAL_POINTS_SUCCESS) from root.stats.write.root_ln
@@ -286,11 +286,11 @@ select MAX_VALUE(TOTAL_POINTS_SUCCESS) from root.stats.write.root_ln
#### File Size Monitor
-Sometimes we are concerned about how the data file size of IoTDB is changing, maybe to help calculate how much disk space is left or the data ingestion speed. The File Size Monitor provides several statistics to show how different types of file-sizes change.
+Sometimes we are concerned about how the data file size of IoTDB changes, maybe to help calculate how much disk space is left or the data ingestion speed. The File Size Monitor provides several statistics to show how different types of file-sizes change.
The file size monitor defaults to collect file size data every 5 seconds using the same shared parameter ```back_loop_period_in_second```,
-Unlike Writing Data Monitor, currently File Size Monitor will not delete statistic data at regular intervals.
+Unlike Writing Data Monitor, currently File Size Monitor does not delete statistic data at regular intervals.
You can also use `select` clause to get the file size statistics like other time series.
@@ -362,7 +362,7 @@ Here are the file size statistics:
### Introduction
-In order to grasp the performance of iotdb, we add this module to count the time-consumption of each operation. This module can compute the statistics of the avg time-consuming of each operation and the proportion of each operation whose time consumption falls into a time range. The output is in log_measure.log file. An output example is below.
+To grasp the performance of iotdb, this module is added to count the time-consumption of each operation. This module can compute the statistics of the avg time-consuming of each operation and the proportion of each operation whose time consumption falls into a time range. The output is in log_measure.log file. An output example is below.
<img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="https://user-images.githubusercontent.com/13203019/60937461-14296f80-a303-11e9-9602-a7bed624bfb3.png">
@@ -446,7 +446,7 @@ Start the JConsole, establish a new JMX connection with the IoTDB Server (you ca
After connected, click `MBean` and find `ch.qos.logback.classic.default.ch.qos.logback.classic.jmx.JMXConfigurator`(As shown in fig 4.2).
<img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="https://user-images.githubusercontent.com/13203019/51577204-fe122900-1ef3-11e9-9e89-2eb1d46e24b8.png">
-In the JMXConfigurator Window, there are 6 operations provided for you, as shown in fig 4.3. You can use there interfaces to perform operation.
+In the JMXConfigurator Window, there are 6 operations provided, as shown in fig 4.3. You can use these interfaces to perform operation.
<img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="https://user-images.githubusercontent.com/13203019/51577216-09fdeb00-1ef4-11e9-9005-542ad7d9e9e0.png">
@@ -467,5 +467,4 @@ This method is to obtain the current log level of the specified Logger. This met
* getLoggerLevel
This method is to obtain the log level of the specified Logger. This method accepts a String type parameter named p1, which is the name of the specified Logger. This method returns the log level of the specified Logger.
-It should be noted that the difference between this method and the `getLoggerEffectiveLevel` method is that the method returns the log level that the specified Logger is set in the configuration file. If the user does not set the log level for the Logger. , then return empty. According to Logger's log-level inheritance mechanism, f a Logger's level is not explicitly set, it will inherit the log level settings from its nearest ancestor. At this point, calling the `getLoggerEffectiveLevel` [...]
-
+It should be noted that the difference between this method and the `getLoggerEffectiveLevel` method is that the method returns the log level that the specified Logger is set in the configuration file. If the user does not set the log level for the Logger, then return empty. According to Logger's log-level inheritance mechanism, a Logger's level is not explicitly set, it will inherit the log level settings from its nearest ancestor. At this point, calling the `getLoggerEffectiveLevel` met [...]
diff --git a/docs/UserGuide/System Tools/Query History Visualization Tool.md b/docs/UserGuide/System Tools/Query History Visualization Tool.md
index a4cc28f..d689913 100644
--- a/docs/UserGuide/System Tools/Query History Visualization Tool.md
+++ b/docs/UserGuide/System Tools/Query History Visualization Tool.md
@@ -21,10 +21,10 @@
# Query History Visualization Tool
-IoTDB Query History Visualization Tool uses a monitoring web page to provide metrics service for viewing the query history and SQL execution time. It can also provide the memory and CPU usage of the current host.
+IoTDB Query History Visualization Tool uses a monitoring web page to provide metrics service for viewing the query history and SQL execution time. It also provides the memory and CPU usage of the current host.
-The port of IoTDB Query History Visualization Tool is `8181`. Just print your `ip:8181` in your browser, and you can view page like this:
+The port of IoTDB Query History Visualization Tool is `8181`. Just print your `ip:8181` in your browser, and the page view looks like this:
<img style="width:100%; max-width:800px; margin-left:auto; margin-right:auto; display:block;" src="https://user-images.githubusercontent.com/19167280/65688727-3038e380-e09e-11e9-8266-24ff0a1efa96.png">
-> Note: Currently, we only support showing CPU ratio of Windows and Linux os. If you are using other OS, you may get a warning information: "Can't get the cpu ratio, because this OS is not support".
+> Note: Currently, we only support showing CPU ratio of Windows and Linux os. If you are using other OS, you may get a warning information: "Can't get the cpu ratio, because this OS is not supported".
diff --git a/docs/UserGuide/System Tools/Sync Tool.md b/docs/UserGuide/System Tools/Sync Tool.md
index 3556571..6a78811 100644
--- a/docs/UserGuide/System Tools/Sync Tool.md
+++ b/docs/UserGuide/System Tools/Sync Tool.md
@@ -52,7 +52,7 @@ The sync tool has a many-to-one sender-receiver mode - that is, one sync receive
# Application Scenario
In the case of a factory application, there are usually multiple sub-factories and multiple general(main) factories. Each sub-factory uses an IoTDB instance to collect data, and then synchronize the data to the general factory for backup or analysis. A general factory can receive data from multiple sub-factories and a sub-factory can also synchronize data to multiple general factories. In this scenario, each IoTDB instance manages different devices.
-In the sync module, each sub-factory is a sender, a general factory is a receiver, and senders periodically synchronizes the data to receivers. In the above application scenario, the data of one device can only be collected by one sender, so there is no device overlap between the data synchronized by multiple senders. Otherwise, the application scenario of the sync module is not satisfied.
+In the sync module, each sub-factory is a sender, a general factory is a receiver, and senders periodically synchronizes the data to receivers. In the scenario above, the data of one device can only be collected by one sender, so there is no device overlap between the data synchronized by multiple senders. Otherwise, the application scenario of the sync module is not satisfied.
When there is an abnormal scenario, namely, two or more senders synchronize the data of the same device (whose storage group is set as root.sg) to the same receiver, the root.sg data of the sender containing the device data received later by the receiver will be rejected. Example: the engine 1 synchronizes the storage groups root.sg1 and root.sg2 to the receiver, and the engine 2 synchronizes the storage groups root.sg2 and root.sg3 to the receiver. All of them include the time series ro [...]
If the receiver receives the data of root.sg2.d0.s0 of the sender 1 first, the receiver will reject the data of root.sg2 of the sender 2.
diff --git a/docs/UserGuide/System Tools/Watermark Tool.md b/docs/UserGuide/System Tools/Watermark Tool.md
index 37db03c..7224c53 100644
--- a/docs/UserGuide/System Tools/Watermark Tool.md
+++ b/docs/UserGuide/System Tools/Watermark Tool.md
@@ -196,4 +196,4 @@ Notes:
- `alpha`: It should be in the range of [0,1]. The watermark detection is based on the significance test. The smaller the `alpha` is, the lower the probability that the data without the watermark is detected to be watermark embedded, and thus the higher the credibility of the result of detecting the existence of the watermark in data.
-- `columnIndex`: It should be a postive integer.
\ No newline at end of file
+- `columnIndex`: It should be a positive integer.
\ No newline at end of file
diff --git a/docs/UserGuide/UserGuideReadme.md b/docs/UserGuide/UserGuideReadme.md
index b47f9ab..7caf5a4 100644
--- a/docs/UserGuide/UserGuideReadme.md
+++ b/docs/UserGuide/UserGuideReadme.md
@@ -20,10 +20,10 @@
-->
# IoTDB User Guide Toc
-We are keeping introducing more features into IoTDB. Therefore, different released versions have their user guide documents respectively.
+We keep introducing more features into IoTDB. Therefore, different released versions have their user guide documents respectively.
The "In Progress Version" is for matching the master branch of IOTDB's source code Repository.
-Other documents are for matching IoTDB released version.
+Other documents are for IoTDB previous released versions.
- [In progress version](https://iotdb.apache.org/UserGuide/Master/Get%20Started/QuickStart.html)
- [Version 0.10.x](https://iotdb.apache.org/UserGuide/V0.10.x/Get%20Started/QuickStart.html)