This is an automated email from the ASF dual-hosted git repository. dope pushed a commit to branch fix_doc_error in repository https://gitbox.apache.org/repos/asf/incubator-iotdb.git
commit 8fccb3978688f2263a143506ce7f58855036af10 Author: XuYi <[email protected]> AuthorDate: Wed Mar 20 14:14:27 2019 +0800 fix doc bug --- Readme.md | 16 +++++++++------- docs/Documentation/Frequently asked questions.md | 24 ++++++++++++++++++++---- docs/Documentation/QuickStart.md | 14 ++++++++------ 3 files changed, 37 insertions(+), 17 deletions(-) diff --git a/Readme.md b/Readme.md index 6ae2882..27ac48d 100644 --- a/Readme.md +++ b/Readme.md @@ -80,7 +80,7 @@ Now suppose your directory is like this: ``` > pwd -/User/workspace/incubator-iotdb +/workspace/incubator-iotdb > ls -l incubator-iotdb/ <-- root path @@ -96,7 +96,7 @@ incubator-iotdb/ <-- root path +- pom.xml ``` -Let $IOTDB_HOME = /User/workspace/incubator-iotdb/iotdb/iotdb/ +Let $IOTDB_HOME = /workspace/incubator-iotdb/iotdb/iotdb/ If you are not the first time that building IoTDB, remember deleting the following files: @@ -109,7 +109,7 @@ Then under the root path of incubator-iotdb, you can build IoTDB using Maven: ``` > pwd -/User/workspace/incubator-iotdb +/workspace/incubator-iotdb > mvn clean package -pl iotdb -am -Dmaven.test.skip=true ``` @@ -187,10 +187,12 @@ Now let's trying to read and write some data from IoTDB using our Client. To sta cd cli/cli # Unix/OS X -> $IOTDB_HOME/bin/start-client.sh -h <IP> -p <PORT> -u <USER_NAME> +> cd /workspace/incubator-iotdb/iotdb-cli/cli/bin/ +> start-client.sh -h <IP> -p <PORT> -u <USER_NAME> # Windows -> $IOTDB_HOME\bin\start-client.bat -h <IP> -p <PORT> -u <USER_NAME> +> cd \workspace\incubator-iotdb\iotdb-cli\cli\bin +> start-client.bat -h <IP> -p <PORT> -u <USER_NAME> ``` > NOTE: In the system, we set a default user in IoTDB named 'root'. The > default password for 'root' is 'root'. You can use this default user if you > are making the first try or you didn't create users by yourself. @@ -280,7 +282,7 @@ CREATE TIMESERIES root.fit.p.s1 WITH DATATYPE=INT32,ENCODING=RLE; ### Run import shell ``` -cd cli/cli +cd iotdb-cli/cli # Unix/OS X > ./bin/import-csv.sh -h <ip> -p <port> -u <username> -pw <password> -f > <xxx.csv> @@ -297,7 +299,7 @@ csvInsertError.error ### Run export shell ``` -cd cli/cli +cd iotdb-cli/cli # Unix/OS X > ./bin/export-csv.sh -h <ip> -p <port> -u <username> -pw <password> -td > <xxx.csv> [-tf <time-format>] diff --git a/docs/Documentation/Frequently asked questions.md b/docs/Documentation/Frequently asked questions.md index 5f53563..1adcd04 100644 --- a/docs/Documentation/Frequently asked questions.md +++ b/docs/Documentation/Frequently asked questions.md @@ -64,11 +64,27 @@ String iotdbVersion = tsfileDatabaseMetadata.getDatabaseProductVersion(); ## Where can I find IoTDB logs? -By default settings, the logs are stored under ```IOTDB_HOME/iotdb/logs```. You can change log level and storage path by configuring ```logback.xml``` under ```IOTDB_HOME/iotdb/conf```. ```IOTDB_HOME``` is the root path of IoTDB project. +Suppose your root directory is: + +``` +$ pwd +/workspace/incubator-iotdb + +$ ls -l +iotdb/ +iotdb-cli/ +pom.xml +Readme.md +... +``` + +Let IOTDB_HOME = /workspace/incubator-iotdb/iotdb/iotdb + +By default settings, the logs are stored under ```IOTDB_HOME/logs```. You can change log level and storage path by configuring ```logback.xml``` under ```IOTDB_HOME/conf```. ## Where can I find IoTDB data files? -By default settings, the data files (including tsfile, metadata, and WAL files) are stored under ```IOTDB_HOME/iotdb/data```. +By default settings, the data files (including tsfile, metadata, and WAL files) are stored under ```IOTDB_HOME/data```. ## How do I know how many time series are stored in IoTDB? @@ -83,7 +99,7 @@ In the result, there will be a statement shows `Total timeseries number`, this n If you are using Linux, you can use the following shell command: ``` -> grep "0,root" IOTDB_HOME/iotdb/data/system/schema/mlog.txt | wc -l +> grep "0,root" IOTDB_HOMEW/data/system/schema/mlog.txt | wc -l > 6 ``` @@ -122,5 +138,5 @@ IoTDB> show timeseries root.fit.d1.* The default IoTDB's CLI time display format is human readable (e.g. ```1970-01-01T08:00:00.001```), if you want to display time in timestamp type or other readable format, add parameter ```-disableIS08601``` in start command: ``` ->sh IOTDB_HOME/iotdb/bin/start-client.sh -h 10.129.187.21 -p 6667 -u root -pw root -disableIS08601 +> sh /workspace/incubator-iotdb/iotdb-cli/cli/bin/start-client.sh -h 127.0.0.1 -p 6667 -u root -pw root -disableIS08601 ``` \ No newline at end of file diff --git a/docs/Documentation/QuickStart.md b/docs/Documentation/QuickStart.md index 63419b3..e8e8499 100755 --- a/docs/Documentation/QuickStart.md +++ b/docs/Documentation/QuickStart.md @@ -76,7 +76,7 @@ Now suppose your directory is like this: ``` > pwd -/User/workspace/incubator-iotdb +/workspace/incubator-iotdb > ls -l incubator-iotdb/ <-- root path @@ -85,14 +85,14 @@ incubator-iotdb/ <-- root path | +- jdbc/ | -+- tsile/ ++- iotdb-cli/ | ... | +- pom.xml ``` -Let $IOTDB_HOME = /User/workspace/incubator-iotdb/iotdb/iotdb/ +Let $IOTDB_HOME = /workspace/incubator-iotdb/iotdb/iotdb/ If you are not the first time that building IoTDB, remember deleting the following files: @@ -105,7 +105,7 @@ Then under the root path of incubator-iotdb, you can build IoTDB using Maven: ``` > pwd -/User/workspace/incubator-iotdb +/workspace/incubator-iotdb > mvn clean package -pl iotdb -am -Dmaven.test.skip=true ``` @@ -174,10 +174,12 @@ Now let's trying to read and write some data from IoTDB using our Client. To sta ``` # Unix/OS X -> $IOTDB_HOME/bin/start-client.sh -h <IP> -p <PORT> -u <USER_NAME> +> cd /workspace/incubator-iotdb/iotdb-cli/cli +> ./start-client.sh -h <IP> -p <PORT> -u <USER_NAME> # Windows -> $IOTDB_HOME\bin\start-client.bat -h <IP> -p <PORT> -u <USER_NAME> +> cd d:\workspace\incubator-iotdb\iotdb-cli\cli +> start-client.bat -h <IP> -p <PORT> -u <USER_NAME> ``` > NOTE: In the system, we set a default user in IoTDB named 'root'. The > default password for 'root' is 'root'. You can use this default user if you > are making the first try or you didn't create users by yourself.
