This is an automated email from the ASF dual-hosted git repository.
dope pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new 41e3fbe fix doc bug (#104)
41e3fbe is described below
commit 41e3fbed58a4dc178d1e4dcdaf74a47dba37a863
Author: XuYi <[email protected]>
AuthorDate: Wed Mar 20 19:05:15 2019 +0800
fix doc bug (#104)
---
Readme.md | 29 ++++++++++---------
clean.sh | 36 ++++++++++++++++++++++++
docs/Documentation/Frequently asked questions.md | 28 ++++++++++++++----
docs/Documentation/QuickStart.md | 25 ++++++++--------
4 files changed, 88 insertions(+), 30 deletions(-)
diff --git a/Readme.md b/Readme.md
index 6ae2882..5546b7e 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,8 @@ incubator-iotdb/ <-- root path
+- pom.xml
```
-Let $IOTDB_HOME = /User/workspace/incubator-iotdb/iotdb/iotdb/
+Let $IOTDB_HOME = /workspace/incubator-iotdb/iotdb/iotdb/
+Let $IOTDB_CLI_HOME = /workspace/incubator-iotdb/iotdb-cli/cli
If you are not the first time that building IoTDB, remember deleting the
following files:
@@ -109,7 +110,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
```
@@ -184,13 +185,17 @@ The server can be stopped with ctrl-C or the following
script:
Now let's trying to read and write some data from IoTDB using our Client. To
start the client, you need to explicit the server's IP and PORT as well as the
USER_NAME and PASSWORD.
```
-cd cli/cli
+# You can first build cli project
+> pwd
+/workspace/incubator-iotdb
+
+> mvn clean package -pl iotdb-cli -am -Dmaven.test.skip=true
# Unix/OS X
-> $IOTDB_HOME/bin/start-client.sh -h <IP> -p <PORT> -u <USER_NAME>
+> $IOTDB_CLI_HOME/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>
+> $IOTDB_CLI_HOME\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,13 +285,13 @@ CREATE TIMESERIES root.fit.p.s1 WITH
DATATYPE=INT32,ENCODING=RLE;
### Run import shell
```
-cd cli/cli
+
# Unix/OS X
-> ./bin/import-csv.sh -h <ip> -p <port> -u <username> -pw <password> -f
<xxx.csv>
+> $IOTDB_CLI_HOME/bin/import-csv.sh -h <ip> -p <port> -u <username> -pw
<password> -f <xxx.csv>
# Windows
-> bin\import-csv.bat -h <ip> -p <port> -u <username> -pw <password> -f
<xxx.csv>
+> $IOTDB_CLI_HOME\bin\import-csv.bat -h <ip> -p <port> -u <username> -pw
<password> -f <xxx.csv>
```
### Error data file
@@ -297,11 +302,9 @@ csvInsertError.error
### Run export shell
```
-cd cli/cli
-
# Unix/OS X
-> ./bin/export-csv.sh -h <ip> -p <port> -u <username> -pw <password> -td
<xxx.csv> [-tf <time-format>]
+> $IOTDB_CLI_HOME/bin/export-csv.sh -h <ip> -p <port> -u <username> -pw
<password> -td <xxx.csv> [-tf <time-format>]
# Windows
-> bin\export-csv.bat -h <ip> -p <port> -u <username> -pw <password> -td
<xxx.csv> [-tf <time-format>]
+> $IOTDB_CLI_HOME\export-csv.bat -h <ip> -p <port> -u <username> -pw
<password> -td <xxx.csv> [-tf <time-format>]
```
diff --git a/clean.sh b/clean.sh
new file mode 100644
index 0000000..0483bdc
--- /dev/null
+++ b/clean.sh
@@ -0,0 +1,36 @@
+#!/bin/sh
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+git checkout checkstyle.xml
+git checkout java-google-style.xml
+git checkout example/**/pom.xml
+git checkout grafana/pom.xml
+git checkout hadoop/pom.xml
+git checkout example/pom.xml
+git checkout jdbc/pom.xml
+git checkout service-rpc/pom.xml
+git checkout spark/pom.xml
+git checkout tsfile/pom.xml
+git checkout iotdb-cli/pom.xml
+git checkout iotdb/pom.xml
+git checkout pom.xml
+git checkout iotdb-cli/src/test/resources/logback.xml
+git checkout iotdb/iotdb/conf/logback.xml
+git checkout iotdb/src/test/resources/logback.xml
+git checkout tsfile/src/test/resources/logback.xml
diff --git a/docs/Documentation/Frequently asked questions.md
b/docs/Documentation/Frequently asked questions.md
index 5f53563..67d4c23 100644
--- a/docs/Documentation/Frequently asked questions.md
+++ b/docs/Documentation/Frequently asked questions.md
@@ -64,11 +64,28 @@ 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
+Let $IOTDB_CLI_HOME = /workspace/incubator-iotdb/iotdb-cli/cli/
+
+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 +100,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_HOME/data/system/schema/mlog.txt | wc -l
> 6
```
@@ -122,5 +139,6 @@ 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
-```
\ No newline at end of file
+> $IOTDB_CLI_HOME/bin/start-client.sh -h 127.0.0.1 -p 6667 -u root -pw root
-disableIS08601
+```
+
diff --git a/docs/Documentation/QuickStart.md b/docs/Documentation/QuickStart.md
index 63419b3..7c173dd 100755
--- a/docs/Documentation/QuickStart.md
+++ b/docs/Documentation/QuickStart.md
@@ -43,16 +43,11 @@ To use IoTDB, you need to have:
1. Java >= 1.8 (Please make sure the environment path has been set)
2. Maven >= 3.0 (If you want to compile and install IoTDB from source code)
-3. TsFile >= 0.7.0 (TsFile Github page:
[https://github.com/apache/incubator-iotdb/tree/master/tsfile](https://github.com/apache/incubator-iotdb/tree/master/tsfile))
-4. IoTDB-JDBC >= 0.7.0 (IoTDB-JDBC Github page:
[https://github.com/apache/incubator-iotdb/tree/master/jdbc](https://github.com/apache/incubator-iotdb/tree/master/jdbc))
-
-TODO: TsFile and IoTDB-JDBC dependencies will be removed after the project
reconstruct.
## Installation
IoTDB provides you two installation methods, you can refer to the following
suggestions, choose one of them:
-
* Installation from source code. If you need to modify the code yourself, you
can use this method.
* Installation from binary files. Download the binary files from the official
website. This is the recommended method, in which you will get a binary
released package which is out-of-the-box.(Comming Soon...)
@@ -76,7 +71,7 @@ Now suppose your directory is like this:
```
> pwd
-/User/workspace/incubator-iotdb
+/workspace/incubator-iotdb
> ls -l
incubator-iotdb/ <-- root path
@@ -85,15 +80,15 @@ 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/
+Let $IOTDB_CLI_HOME = /workspace/incubator-iotdb/iotdb-cli/cli/
If you are not the first time that building IoTDB, remember deleting the
following files:
```
@@ -105,7 +100,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
```
@@ -173,11 +168,17 @@ After that we start the server. Running the startup
script:
Now let's trying to read and write some data from IoTDB using our Client. To
start the client, you need to explicit the server's IP and PORT as well as the
USER_NAME and PASSWORD.
```
+# You can first build cli project
+> pwd
+/workspace/incubator-iotdb
+
+> mvn clean package -pl iotdb-cli -am -Dmaven.test.skip=true
+
# Unix/OS X
-> $IOTDB_HOME/bin/start-client.sh -h <IP> -p <PORT> -u <USER_NAME>
+> $IOTDB_CLI_HOME/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>
+> $IOTDB_CLI_HOME\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.
