fix readme bug

This commit is contained in:
qiaojialin 2019-07-27 10:08:33 +08:00
parent 5b03d26e10
commit 8872de2964
12 changed files with 60 additions and 195 deletions

View File

@ -1,21 +1,3 @@
/**
* 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.
*/
import java.util.Properties;
public class MavenWrapperDownloader {

View File

@ -1,21 +1,2 @@
#
# 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.
#
distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.6.1/apache-maven-3.6.1-bin.zip
#wrapperUrl=https://repo1.maven.org/maven2/io/takari/maven-wrapper/0.2.1/maven-wrapper-0.2.1.jar

View File

@ -217,6 +217,6 @@ The following classes are modified from Apache Hive, which is under Apache Licen
------------
The following class is modified from Maven Wrapper, which is under Apache License 2.0:
The following class is modified from Maven Wrapper
./mvn/wrapper/MavenWrapperDownloader.java
./.mvn/wrapper/MavenWrapperDownloader.java

View File

@ -223,9 +223,10 @@ The following classes are modified from Apache Hive, which is under Apache Licen
------------
The following class is modified from Maven Wrapper, which is under Apache License 2.0:
The following class is modified from Maven Wrapper:
./.mvn/wrapper/MavenWrapperDownloader.java
./mvn/wrapper/MavenWrapperDownloader.java
================================================================
The binary distribution of this product bundles these dependencies under the

35
NOTICE
View File

@ -4,28 +4,7 @@ Copyright 2018 and onwards The Apache Software Foundation.
This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).
Export Control Notice
---------------------
This distribution includes cryptographic software. The country in which you currently reside may have
restrictions on the import, possession, use, and/or re-export to another country, of encryption software.
BEFORE using any encryption software, please check your country's laws, regulations and policies concerning
the import, possession, or use, and re-export of encryption software, to see if this is permitted. See
<http://www.wassenaar.org/> for more information.
The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this
software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software
using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache
Software Foundation distribution makes it eligible for export under the License Exception ENC Technology
Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for
both object code and source code.
The following provides more details on the included cryptographic software:
This software uses Apache Commons Crypto (https://commons.apache.org/proper/commons-crypto/) to
support authentication, and encryption and decryption of data sent across the network between
services.
============================================================================
IoTDB project uses 4 Chinese Patents:
* 201711384490X
@ -38,12 +17,10 @@ grant the users the right to the use of patent under the requirement of Apache 2
============================================================================
This product contains a modified portion of 'Apache Hive', an open source
Java SE, which can be obtained at:
This product contains a modified portion of 'Apache Hive'
* LICENSE:
* https://github.com/apache/hive/blob/master/LICENSE (Apache License 2.0)
* HOMEPAGE:
* https://github.com/apache/hive
Apache Hive
Copyright 2008-2018 The Apache Software Foundation
============================================================================
This product includes software developed by The Apache Software
Foundation (http://www.apache.org/).

View File

@ -4,28 +4,7 @@ Copyright 2018 and onwards The Apache Software Foundation.
This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).
Export Control Notice
---------------------
This distribution includes cryptographic software. The country in which you currently reside may have
restrictions on the import, possession, use, and/or re-export to another country, of encryption software.
BEFORE using any encryption software, please check your country's laws, regulations and policies concerning
the import, possession, or use, and re-export of encryption software, to see if this is permitted. See
<http://www.wassenaar.org/> for more information.
The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this
software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software
using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache
Software Foundation distribution makes it eligible for export under the License Exception ENC Technology
Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for
both object code and source code.
The following provides more details on the included cryptographic software:
This software uses Apache Commons Crypto (https://commons.apache.org/proper/commons-crypto/) to
support authentication, and encryption and decryption of data sent across the network between
services.
============================================================================
IoTDB project uses 4 Chinese Patents:
* 201711384490X
@ -38,57 +17,10 @@ grant the users the right to the use of patent under the requirement of Apache 2
============================================================================
This product contains a modified portion of 'Apache Hive', an open source
Java SE, which can be obtained at:
This product contains a modified portion of 'Apache Hive'
* LICENSE:
* https://github.com/apache/hive/blob/master/LICENSE (Apache License 2.0)
* HOMEPAGE:
* https://github.com/apache/hive
Apache Hive
Copyright 2008-2018 The Apache Software Foundation
============================================================================
The binary distribution of this product bundles binaries of
ch.qos.logback:logback-classic:1.1.11 and ch.qos.logback:logback-core:1.1.11 (https://logback.qos.ch/).
It has the following notices:
Logback: the reliable, generic, fast and flexible logging framework.
Copyright (C) 1999-2017, QOS.ch. All rights reserved.
This program and the accompanying materials are dual-licensed under
either the terms of the Eclipse Public License v1.0 as published by
the Eclipse Foundation
---
The binary distribution of this product bundles binaries of
javax.annotation:javax.annotation-api:1.3.2 (https://github.com/javaee/javax.annotation).
It has the following notices:
NOTICE PURSUANT TO SECTION 9 OF THE COMMON DEVELOPMENT AND DISTRIBUTION
LICENSE (CDDL)
The code released under the CDDL shall be governed by the laws of the
State of California (excluding conflict-of-law provisions). Any
litigation relating to this License shall be subject to the jurisdiction
of the Federal Courts of the Northern District of California and the
state courts of the State of California, with venue lying in Santa Clara
County, California.
---
The binary distribution of this product bundles binaries of
javax.activation:javax.activation-api:1.2.0 (https://docs.oracle.com/javase/7/docs/api/javax/activation/package-summary.html).
It has the following notices:
Copyright © 1993, 2018, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
---
The binary distribution of this product bundles binaries of
javax.xml.bind:jaxb-api:2.4.0-b180725.0427 (https://docs.oracle.com/javase/8/docs/api/javax/xml/bind/JAXB.html).
It has the following notices:
Copyright © 1993, 2018, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
---
This product includes software developed by The Apache Software
Foundation (http://www.apache.org/).

View File

@ -59,21 +59,11 @@ If you want to use Hadoop or Spark to analyze IoTDB data file (called as TsFile)
# 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 [User Guide](https://iotdb.apache.org/#/Documents/0.8.0/sec1).
This short guide will walk you through the basic process of using IoTDB. For a more-complete guide, please visit our website's [User Guide](https://iotdb.apache.org/#/Documents/0.8.0/chap1/sec1).
## Installation from source code
Use git to get IoTDB source code:
```
> git clone https://github.com/apache/incubator-iotdb.git
```
Or use the following command if you have configured SSH key on GitHub:
```
> 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:
@ -84,7 +74,7 @@ Now suppose your directory is like this:
> ls -l
incubator-iotdb/ <-- root path
|
+- iotdb/
+- server/
|
+- jdbc/
|
@ -95,18 +85,18 @@ incubator-iotdb/ <-- root path
+- pom.xml
```
Let $IOTDB_HOME = /workspace/incubator-iotdb/iotdb/iotdb/
Let $IOTDB_HOME = /workspace/incubator-iotdb/server/iotdb/
Let $IOTDB_CLI_HOME = /workspace/incubator-iotdb/iotdb-cli/cli
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:
@ -121,7 +111,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:
@ -130,38 +120,39 @@ 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] ------------------------------------------------------------------------
```
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:
After build, the IoTDB project will be at the folder "server/iotdb". The folder will include the following contents:
```
iotdb/iotdb/ <-- root path
server/iotdb/ <-- root path
|
+- bin/ <-- script files
+- sbin/ <-- script files for starting and stopping the server
|
+- tools/ <-- script files of tools
|
+- 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.
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 documentation [Chapter4: Deployment and Management](https://iotdb.apache.org/#/Documents/0.8.0/sec4) in detail.
For more, you are advised to check our documentation [Chapter4: Deployment and Management](https://iotdb.apache.org/#/Documents/0.8.0/chap4/sec1) in detail.
## Start
@ -171,10 +162,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
```
### Stop Server
@ -183,10 +174,10 @@ The server can be stopped with ctrl-C or the following script:
```
# Unix/OS X
> $IOTDB_HOME/bin/stop-server.sh
> $IOTDB_HOME/sbin/stop-server.sh
# Windows
> $IOTDB_HOME\bin\stop-server.bat
> $IOTDB_HOME\sbin\stop-server.bat
```
### Start Client
@ -198,13 +189,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.
@ -275,7 +266,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 documentation [Chapter 5: IoTDB SQL Documentation](https://iotdb.apache.org/#/Documents/0.8.0/sec5).
For more on what commands are supported by IoTDB SQL, see our documentation [Chapter 5: IoTDB SQL Documentation](https://iotdb.apache.org/#/Documents/0.8.0/chap5/sec1).
# Usage of import-csv.sh
@ -295,10 +286,10 @@ CREATE TIMESERIES root.fit.p.s1 WITH DATATYPE=INT32,ENCODING=RLE;
### Run import shell
```
# Unix/OS X
> $IOTDB_CLI_HOME/bin/import-csv.sh -h <ip> -p <port> -u <username> -pw <password> -f <xxx.csv>
> $IOTDB_CLI_HOME/tools/import-csv.sh -h <ip> -p <port> -u <username> -pw <password> -f <xxx.csv>
# Windows
> $IOTDB_CLI_HOME\bin\import-csv.bat -h <ip> -p <port> -u <username> -pw <password> -f <xxx.csv>
> $IOTDB_CLI_HOME\tools\import-csv.bat -h <ip> -p <port> -u <username> -pw <password> -f <xxx.csv>
```
### Error data file
@ -310,8 +301,8 @@ CREATE TIMESERIES root.fit.p.s1 WITH DATATYPE=INT32,ENCODING=RLE;
### Run export shell
```
# Unix/OS X
> $IOTDB_CLI_HOME/bin/export-csv.sh -h <ip> -p <port> -u <username> -pw <password> -td <xxx.csv> [-tf <time-format>]
> $IOTDB_CLI_HOME/tools/export-csv.sh -h <ip> -p <port> -u <username> -pw <password> -td <xxx.csv> [-tf <time-format>]
# Windows
> $IOTDB_CLI_HOME\export-csv.bat -h <ip> -p <port> -u <username> -pw <password> -td <xxx.csv> [-tf <time-format>]
> $IOTDB_CLI_HOME\tools\export-csv.bat -h <ip> -p <port> -u <username> -pw <password> -td <xxx.csv> [-tf <time-format>]
```

View File

@ -41,7 +41,7 @@
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>iotdb-jdbc</artifactId>
<version>0.8.1-SNAPSHOT</version>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>commons-cli</groupId>

View File

@ -61,7 +61,7 @@
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>iotdb-jdbc</artifactId>
<version>0.8.1-SNAPSHOT</version>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
@ -159,7 +159,7 @@
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.schemas</resource>
</transformer>
<transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer" />
<transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>${start-class}</mainClass>
</transformer>

View File

@ -39,12 +39,12 @@
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>tsfile</artifactId>
<version>0.8.1-SNAPSHOT</version>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.apache.iotdb</groupId>
<artifactId>service-rpc</artifactId>
<version>0.8.1-SNAPSHOT</version>
<version>${project.version}</version>
</dependency>
</dependencies>
<build>
@ -137,7 +137,7 @@
</goals>
</pluginExecutionFilter>
<action>
<ignore />
<ignore/>
</action>
</pluginExecution>
</pluginExecutions>

View File

@ -188,6 +188,7 @@
<excludes>
<!-- Git related files -->
<exclude>**/.git/**</exclude>
<exclude>**/.mvn/**</exclude>
<exclude>**/.gitignore</exclude>
<!-- Maven related files -->
<exclude>**/target/**</exclude>
@ -251,7 +252,7 @@
</requireJavaVersion>
<!-- Disabled for now as it breaks the ability to build single modules -->
<!--reactorModuleConvergence/-->
<banVulnerable implementation="org.sonatype.ossindex.maven.enforcer.BanVulnerableDependencies" />
<banVulnerable implementation="org.sonatype.ossindex.maven.enforcer.BanVulnerableDependencies"/>
</rules>
</configuration>
</execution>

View File

@ -100,7 +100,7 @@
</goals>
</pluginExecutionFilter>
<action>
<ignore />
<ignore/>
</action>
</pluginExecution>
<pluginExecution>