Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
bff8aea
add english doc
MyXOF Jan 22, 2019
798453f
update doc
MyXOF Jan 22, 2019
767eb47
remove ^M
Jan 22, 2019
d7f9f44
remove picture
MyXOF Jan 22, 2019
f27a6a2
Merge branch 'doc' of github.com:apache/incubator-iotdb into doc
MyXOF Jan 22, 2019
2fab54d
modify the relative path of images in doc to absolute path
little-emotion Jan 23, 2019
a8bcfd1
Merge pull request #21 from little-emotion/doc_change_url
MyXOF Jan 23, 2019
48b82e5
test image style
little-emotion Jan 23, 2019
88ca2a5
Remove superfluous words
little-emotion Jan 23, 2019
41daf4f
Merge pull request #22 from little-emotion/doc_change_url
MyXOF Jan 23, 2019
91f23fe
fix bug
little-emotion Jan 23, 2019
bf865ce
Merge pull request #23 from little-emotion/doc_change_url
MyXOF Jan 23, 2019
519fc6e
change picture style
little-emotion Jan 23, 2019
7f5ca05
add toc and change format
little-emotion Jan 23, 2019
0522850
Merge pull request #24 from little-emotion/doc_change_url
MyXOF Jan 24, 2019
1f484ea
update doc
little-emotion Jan 24, 2019
bad2d74
rename directory
little-emotion Jan 24, 2019
e4d0382
update index of frequently asked questions
little-emotion Jan 24, 2019
ecd5727
Merge pull request #26 from little-emotion/doc_change_url
MyXOF Jan 24, 2019
a829fe7
Update Community-Project Committers.md
MyXOF Jan 24, 2019
339cd91
Update QuickStart.md
MyXOF Jan 24, 2019
9271717
Update OtherMaterial-Examples.md
MyXOF Jan 24, 2019
4045d49
Update QuickStart.md
MyXOF Jan 24, 2019
165ac81
Update Community-History&Vision.md
MyXOF Jan 25, 2019
0edeeb4
Update Community-Project Committers.md
MyXOF Jan 25, 2019
c3109a0
Update OtherMaterial-Examples.md
MyXOF Jan 25, 2019
94ed837
Update OtherMaterial-Reference.md
MyXOF Jan 25, 2019
617fc92
set github issues to JIRA issues
Jan 25, 2019
88dd127
change contents in community-powered by
Jan 25, 2019
bce09b4
change url from thulab to apache
Jan 25, 2019
fc4bd5a
Update QuickStart.md
MyXOF Jan 29, 2019
cfbf29b
Update QuickStart.md
MyXOF Jan 29, 2019
3949dec
Update QuickStart.md
MyXOF Jan 29, 2019
47c4ee0
fix reviews
qiaojialin Feb 21, 2019
72fdb4d
fix grammar error reviewd by lanking520
Feb 23, 2019
149ab77
add install guide for grafana on windows platform
MyXOF Feb 23, 2019
82fb9ce
fix issue 17 on jira
MyXOF Feb 23, 2019
f4679a9
update readme.md
MyXOF Feb 23, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 69 additions & 24 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ IoTDB's features are as following:
7. Intense integration with Open Source Ecosystem. IoTDB supports Hadoop, Spark, etc. analysis ecosystems and Grafana visualization tool.


For the latest information about IoTDB, please visit our [IoTDB official website](http://tsfile.org/index) (will transfer to iotdb.apache.org in the future).
For the latest information about IoTDB, please visit our [IoTDB official website](http://iotdb.apache.org/#/).

# Prerequisites

Expand All @@ -58,38 +58,81 @@ To use IoTDB, you need to have:

If you want to use Hadoop or Spark to analyze IoTDB data file (called as TsFile), you need to compile the hadoop and spark modules.


# Quick Start

This short guide will walk you through the basic process of using IoTDB. For a more-complete guide, please visit our website's [Document Part](http://tsfile.org/document).
This short guide will walk you through the basic process of using IoTDB. For a more-complete guide, please visit our website's [Document Part](http://iotdb.apache.org/#/Documents/Quick%20Start).

## Build
### Installation from source code

Use git to get IoTDB source code:

If you are not the first time that building IoTDB, remember deleting the following files:
```
rm -rf iotdb/iotdb/data/
rm -rf iotdb/iotdb/lib/
Shell > git clone https://github.com/apache/incubator-iotdb.git
```

Then you can build IoTDB using Maven in current folder:
Or:

```
mvn clean package -Dmaven.test.skip=true
Shell > git clone git@github.com:apache/incubator-iotdb.git
```

Now suppose your directory is like this:

```
> pwd
/User/workspace/incubator-iotdb

(__NOTICE:__ Remember that you have to use -Dmaven.test.skip=true before you run tests, it is because some IT (integration test) requires jars in iotdb-cli/cli/lib/, and the folder is empty before you run `mvn package`. After that, you can run `mvn test` as long as you do not run `mvn clean`. For more details, see: [How to test IoTDB
](https://github.com/thulab/iotdb/wiki/How-to-test-IoTDB) )
> ls -l
incubator-iotdb/ <-- root path
|
+- iotdb/
|
+- jdbc/
|
+- tsile/
|
...
|
+- pom.xml
```

Let $IOTDB_HOME = /User/workspace/incubator-iotdb/iotdb/iotdb/

If you are not the first time that building IoTDB, remember deleting the following files:

```
> rm -rf $IOTDB_HOME/data/
> rm -rf $IOTDB_HOME/lib/
```

Then under the root path of incubator-iotdb, you can build IoTDB using Maven:

```
> pwd
/User/workspace/incubator-iotdb

> mvn clean package -pl iotdb -am -Dmaven.test.skip=true
```

If successful, you will see the the following text in the terminal:

```
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] IoTDB Root ......................................... SUCCESS [ 7.020 s]
[INFO] TsFile ............................................. SUCCESS [ 10.486 s]
[INFO] Service-rpc ........................................ SUCCESS [ 3.717 s]
[INFO] IoTDB Jdbc ......................................... SUCCESS [ 3.076 s]
[INFO] IoTDB .............................................. SUCCESS [ 8.258 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
```
Otherwise, you may need to check the error statements and fix the problems.

After build, the IoTDB project will be at the folder "iotdb/iotdb". The folder will include the following contents:


```
iotdb/iotdb/ <-- root path
|
Expand All @@ -98,19 +141,17 @@ iotdb/iotdb/ <-- root path
+- conf/ <-- configuration files
|
+- lib/ <-- project dependencies
|
+- LICENSE <-- LICENSE
```

> NOTE: We also provide already built JARs and project at [http://tsfile.org/download](http://tsfile.org/download) instead of build the jar package yourself.
<!-- > NOTE: We also provide already built JARs and project at [http://tsfile.org/download](http://tsfile.org/download) instead of build the jar package yourself. -->

## Configure

Before starting to use IoTDB, you need to config the configuration files first. For your convenience, we have already set the default config in the files.

In total, we provide users three kinds of configurations module: environment config module (iotdb-env.bat, iotdb-env.sh), system config module (tsfile-format.properties, iotdb-engine.properties) and log config module (logback.xml). All of these kinds of configuration files are put in iotdb/config folder.

For more, you are advised to check our website [document page](http://tsfile.org/document). The forth chapter in User Guide Document will give you the details.
For more, you are advised to check our website [document page](http://iotdb.apache.org/#/Documents/Quick%20Start). The forth chapter in User Guide Document will give you the details.

## Start

Expand All @@ -120,10 +161,10 @@ After that we start the server. Running the startup script:

```
# Unix/OS X
> ./bin/start-server.sh
> $IOTDB_HOME/bin/start-server.sh

# Windows
> bin\start-server.bat
> $IOTDB_HOME\bin\start-server.bat
```

### Stop Server
Expand All @@ -132,10 +173,10 @@ The server can be stopped with ctrl-C or the following script:

```
# Unix/ OS X
> ./bin/stop-server.sh
> $IOTDB_HOME/bin/stop-server.sh

# Windows
> bin\stop-server.bat
> $IOTDB_HOME\bin\stop-server.bat
```

### Start Client
Expand All @@ -146,10 +187,10 @@ Now let's trying to read and write some data from IoTDB using our Client. To sta
cd cli/cli

# Unix/OS X
> ./bin/start-client.sh -h <ip> -p <port> -u <username> -pw <password>
> $IOTDB_HOME/bin/start-client.sh -h <IP> -p <PORT> -u <USER_NAME>

# Windows
> bin\start-client.bat -h <ip> -p <port> -u <username> -pw <password>
> $IOTDB_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.
Expand All @@ -162,7 +203,7 @@ The command line client is interactive so if everything is ready you should see
| | .--.|_/ | | \_| | | `. \ | |_) |
| | / .'`\ \ | | | | | | | __'.
_| |_| \__. | _| |_ _| |_.' /_| |__) |
|_____|'.__.' |_____| |______.'|_______/ version 0.7.0
|_____|'.__.' |_____| |______.'|_______/ version x.x.x


IoTDB> login successfully
Expand Down Expand Up @@ -219,7 +260,7 @@ execute successfully.

If your session looks similar to what's above, congrats, your IoTDB is operational!

For more on what commands are supported by IoTDB SQL, see our website [document page](http://tsfile.org/document). The eighth chapter in User Guide Document will give you help.
For more on what commands are supported by IoTDB SQL, see our website [document page](http://iotdb.apache.org/#/Documents/Quick%20Start). The eighth chapter in User Guide Document will give you help.


# Usage of import-csv.sh
Expand All @@ -238,6 +279,8 @@ 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>

Expand All @@ -253,6 +296,8 @@ 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>]

Expand Down
3 changes: 3 additions & 0 deletions docs/Community-History&Vision.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# History&Vision

Comming Soon.
21 changes: 21 additions & 0 deletions docs/Community-Powered By.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- TOC -->

- [Powered By](#powered-by)
- [Project and Product names using "IoTDB"](#project-and-product-names-using-iotdb)
- [Companies and Organizations](#companies-and-organizations)

<!-- /TOC -->
## Powered By

### Project and Product names using "IoTDB"

Organizations creating products and projects using Apache IoTDB, along with associated marketing materials, should take care to respect the trademark in “Apache IoTDB” and its logo. Please refer to [ASF Trademarks Guidance](https://www.apache.org/foundation/marks/) and associated [FAQ](https://www.apache.org/foundation/marks/faq/) for comprehensive and authoritative guidance on proper usage of ASF trademarks.
It is recommended to not include “IoTDB” in any names to prevent potential trademark issue with the IoTDB project.
As an example, names like “IoTDB BigDataProduct” should not be used, as the name include “IoTDB” in general. The above links, however, describe some exceptions, like for names such as “BigDataProduct, powered by Apache IoTDB” or “BigDataProduct for Apache IoTDB”. In summary, any names contain "Apache IoTDB" as a whole are acceptable.
A common practice you can take is to create software identifiers (Maven coordinates, module names, etc.) like “iotdb-tool”. These are permitted. Nominative use of trademarks in descriptions is also allowed, as in “BigDataProduct is a subproduct for Apache IoTDB”.

### Companies and Organizations
To add yourself to the list, please email dev@iotdb.apache.org with your organization name, URL, a list of IoTDB components you are using, and a short description of your use case.

- School of Software (Tsinghua University), and National Engineering Laboratery for Big Data Software that initially launched IoTDB
- We have both graduate students and a team of professional software engineers working on the stack
22 changes: 22 additions & 0 deletions docs/Community-Project Committers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Project Committers

| Name | Organization |
| :----------- | -------------: |
| Jianmin Wang | Tsinghua University |
|Xiangdong Huang | Tsinghua University |
| Jun Yuan | Tsinghua University |
| Chen Wang | Tsinghua University |
| Jialin Qiao | Tsinghua University |
| Jinrui Zhang | Tsinghua University |
| Rong Kang | Tsinghua University |
| Tian Jiang | Tsinghua University |
| Shuo Zhang | K2Data Company |
| Lei Rui | Tsinghua University |
| Rui Liu | Tsinghua University |
| Gaofei Cao | Tsinghua University |
| Xinyi Zhao | Tsinghua University |
| Yi Xu | Tsinghua University |
| Dongfang Mao | Tsinghua University |
| Tianan li | Tsinghua University |
| Yue Su | Tsinghua University |
| Hui Da | Lenovo |
Loading