Skip to content
Permalink
Browse files
merge master
  • Loading branch information
LeiRui committed Jul 29, 2019
2 parents b6e7af6 + d3f8983 commit 2bac929cd785441bc847649a0e86dad81711916c
Show file tree
Hide file tree
Showing 21 changed files with 1,479 additions and 191 deletions.
@@ -65,9 +65,9 @@ Shell > tar -zxf iotdb-<version>.tar.gz # For Linux or MacOS
解压后文件夹内容见图:

```
iotdb/ <-- root path
server/ <-- root path
|
+- bin/ <-- script files
+- sbin/ <-- script files
|
+- conf/ <-- configuration files
|
@@ -78,24 +78,12 @@ iotdb/ <-- root path

### 使用源码编译

您还可以使用从Git仓库克隆源码进行编译的方式安装IoTDB,具体操作步骤如下:
您可以获取已发布的源码https://iotdb.apache.org/#/Download,或者从git仓库获取https://github.com/apache/incubator-iotdb/tree/master

```
Shell > git clone https://github.com/apache/incubator-iotdb.git
```

或者:

```
Shell > git clone git@github.com:apache/incubator-iotdb.git
```

>注意:当前为未发布版本,需要获取权限后才可克隆源码,如需使用源码编译,请联系IoTDB。
步骤三:源码克隆后,进入到源码文件夹目录下,使用以下命令进行编译:
源码克隆后,进入到源码文件夹目录下,使用以下命令进行编译:

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

成功后,可以在终端看到如下信息:
@@ -104,11 +92,11 @@ Shell > git clone git@github.com:apache/incubator-iotdb.git
[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] Apache IoTDB (incubating) Project Parent POM ....... SUCCESS [ 6.405 s]
[INFO] TsFile ............................................. SUCCESS [ 10.435 s]
[INFO] Service-rpc ........................................ SUCCESS [ 4.170 s]
[INFO] IoTDB Jdbc ......................................... SUCCESS [ 3.252 s]
[INFO] IoTDB Server ....................................... SUCCESS [ 8.072 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
@@ -121,7 +109,7 @@ Shell > git clone git@github.com:apache/incubator-iotdb.git
```
$IOTDB_HOME/
|
+- bin/ <-- script files
+- sbin/ <-- script files
|
+- conf/ <-- configuration files
|
@@ -57,17 +57,7 @@ Here in the Quick Start, we give a brief introduction of using source code to in

### Installation from source code

Use git to get IoTDB source code:

```
Shell > git clone https://github.com/apache/incubator-iotdb.git
```

Or:

```
Shell > git clone git@github.com:apache/incubator-iotdb.git
```
You can get the released source code from https://iotdb.apache.org/#/Download, or from the git repository https://github.com/apache/incubator-iotdb/tree/master

Now suppose your directory is like this:

@@ -78,28 +68,28 @@ Now suppose your directory is like this:
> ls -l
incubator-iotdb/ <-- root path
|
+- iotdb/
+- server/
|
+- jdbc/
|
+- iotdb-cli/
+- client/
|
...
|
+- pom.xml
```

Let $IOTDB_HOME = /workspace/incubator-iotdb/iotdb/iotdb/
Let $IOTDB_CLI_HOME = /workspace/incubator-iotdb/iotdb-cli/cli/
Let $IOTDB_HOME = /workspace/incubator-iotdb/server/iotdb/
Let $IOTDB_CLI_HOME = /workspace/incubator-iotdb/client/cli/

Note:
* if `IOTDB_HOME` is not explicitly assigned,
then by default `IOTDB_HOME` is the direct parent directory of `bin/start-server.sh` on Unix/OS X
(or that of `bin\start-server.bat` on Windows).
then by default `IOTDB_HOME` is the direct parent directory of `sbin/start-server.sh` on Unix/OS X
(or that of `sbin\start-server.bat` on Windows).

* if `IOTDB_CLI_HOME` is not explicitly assigned,
then by default `IOTDB_CLI_HOME` is the direct parent directory of `bin/start-client.sh` on
Unix/OS X (or that of `bin\start-client.bat` on Windows).
then by default `IOTDB_CLI_HOME` is the direct parent directory of `sbin/start-client.sh` on
Unix/OS X (or that of `sbin\start-client.bat` on Windows).

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

@@ -115,10 +105,10 @@ Then under the root path of incubator-iotdb, you can build IoTDB using Maven:
/workspace/incubator-iotdb
# Unix/OS X
> mvn clean package -pl iotdb -am -Dmaven.test.skip=true
> mvn clean package -pl server -am -Dmaven.test.skip=true
# Windows
> mvn clean package -pl iotdb -am '-Dmaven.test.skip=true'
> mvn clean package -pl server -am '-Dmaven.test.skip=true'
```

Note: If you are a Windows user, you should use quoting `'-Dmaven.test.skip=true'` in the following commands.
@@ -129,11 +119,11 @@ 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] Apache IoTDB (incubating) Project Parent POM ....... SUCCESS [ 6.405 s]
[INFO] TsFile ............................................. SUCCESS [ 10.435 s]
[INFO] Service-rpc ........................................ SUCCESS [ 4.170 s]
[INFO] IoTDB Jdbc ......................................... SUCCESS [ 3.252 s]
[INFO] IoTDB Server ....................................... SUCCESS [ 8.072 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
@@ -146,15 +136,13 @@ After building, the IoTDB project will be at the subfolder named iotdb. The fold
```
$IOTDB_HOME/
|
+- bin/ <-- script files
+- sbin/ <-- script files
|
+- conf/ <-- configuration files
|
+- lib/ <-- project dependencies
```

<!-- > 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.
@@ -175,10 +163,10 @@ After that we start the server. Running the startup script:

```
# Unix/OS X
> $IOTDB_HOME/bin/start-server.sh
> $IOTDB_HOME/sbin/start-server.sh
# Windows
> $IOTDB_HOME\bin\start-server.bat
> $IOTDB_HOME\sbin\start-server.bat
```

### Start Client
@@ -190,13 +178,13 @@ Now let's trying to read and write some data from IoTDB using our Client. To sta
> pwd
/workspace/incubator-iotdb
> mvn clean package -pl iotdb-cli -am -Dmaven.test.skip=true
> mvn clean package -pl client -am -Dmaven.test.skip=true
# Unix/OS X
> $IOTDB_CLI_HOME/bin/start-client.sh -h <IP> -p <PORT> -u <USER_NAME>
> $IOTDB_CLI_HOME/sbin/start-client.sh -h <IP> -p <PORT> -u <USER_NAME>
# Windows
> $IOTDB_CLI_HOME\bin\start-client.bat -h <IP> -p <PORT> -u <USER_NAME>
> $IOTDB_CLI_HOME\sbin\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.
@@ -61,7 +61,7 @@ The IoTDB project will be at the subfolder named iotdb. The folder will include
```
iotdb/ <-- root path
|
+- bin/ <-- script files
+- sbin/ <-- script files
|
+- conf/ <-- configuration files
|
@@ -72,17 +72,7 @@ iotdb/ <-- root path

### Installation from source code

Use git to get IoTDB source code:

```
Shell > git clone https://github.com/apache/incubator-iotdb.git
```

Or:

```
Shell > git clone git@github.com:apache/incubator-iotdb.git
```
You can get the released source code from https://iotdb.apache.org/#/Download, or from the git repository https://github.com/apache/incubator-iotdb/tree/master

Now suppose your directory is like this:

@@ -93,28 +83,28 @@ Now suppose your directory is like this:
> ls -l
incubator-iotdb/ <-- root path
|
+- iotdb/
+- server/
|
+- jdbc/
|
+- iotdb-cli/
+- client/
|
...
|
+- pom.xml
```

Let $IOTDB_HOME = /workspace/incubator-iotdb/iotdb/iotdb/
Let $IOTDB_CLI_HOME = /workspace/incubator-iotdb/iotdb-cli/cli/
Let $IOTDB_HOME = /workspace/incubator-iotdb/server/iotdb/
Let $IOTDB_CLI_HOME = /workspace/incubator-iotdb/client/cli/

Note:
* if `IOTDB_HOME` is not explicitly assigned,
then by default `IOTDB_HOME` is the direct parent directory of `bin/start-server.sh` on Unix/OS X
(or that of `bin\start-server.bat` on Windows).
then by default `IOTDB_HOME` is the direct parent directory of `sbin/start-server.sh` on Unix/OS X
(or that of `sbin\start-server.bat` on Windows).

* if `IOTDB_CLI_HOME` is not explicitly assigned,
then by default `IOTDB_CLI_HOME` is the direct parent directory of `bin/start-client.sh` on
Unix/OS X (or that of `bin\start-client.bat` on Windows).
then by default `IOTDB_CLI_HOME` is the direct parent directory of `sbin/start-client.sh` on
Unix/OS X (or that of `sbin\start-client.bat` on Windows).

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

@@ -129,7 +119,7 @@ Then under the root path of incubator-iotdb, you can build IoTDB using Maven:
> pwd
/workspace/incubator-iotdb
> mvn clean package -pl iotdb -am -Dmaven.test.skip=true
> mvn clean package -pl server -am -Dmaven.test.skip=true
```

If successful, you will see the the following text in the terminal:
@@ -138,11 +128,11 @@ 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] Apache IoTDB (incubating) Project Parent POM ....... SUCCESS [ 6.405 s]
[INFO] TsFile ............................................. SUCCESS [ 10.435 s]
[INFO] Service-rpc ........................................ SUCCESS [ 4.170 s]
[INFO] IoTDB Jdbc ......................................... SUCCESS [ 3.252 s]
[INFO] IoTDB Server ....................................... SUCCESS [ 8.072 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
@@ -155,7 +145,7 @@ After building, the IoTDB project will be at the subfolder named iotdb. The fold
```
$IOTDB_HOME/
|
+- bin/ <-- script files
+- sbin/ <-- script files
|
+- conf/ <-- configuration files
|
@@ -3,7 +3,7 @@ SPDX short identifier: BSD-2-Clause

Note: This license has also been called the "Simplified BSD License" and the "FreeBSD License". See also the 3-clause BSD License.

Copyright <YEAR> <COPYRIGHT HOLDER>
Copyright 1998 Regents of the University of California

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

@@ -3,7 +3,7 @@ SPDX short identifier: BSD-3-Clause

Note: This license has also been called the "New BSD License" or "Modified BSD License". See also the 2-clause BSD License.

Copyright <YEAR> <COPYRIGHT HOLDER>
Copyright (c) 2012 Terence Parr and Sam Harwell

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

@@ -1,7 +1,8 @@
The MIT License
SPDX short identifier: MIT

Copyright <YEAR> <COPYRIGHT HOLDER>
Copyright (c) 2004-2017 QOS.ch
Copyright (c) 2015--2019 Tongfei Chen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

0 comments on commit 2bac929

Please sign in to comment.