diff --git a/docs/src/.vuepress/navbar/en.ts b/docs/src/.vuepress/navbar/en.ts index ec6791013..1f014de88 100644 --- a/docs/src/.vuepress/navbar/en.ts +++ b/docs/src/.vuepress/navbar/en.ts @@ -30,20 +30,20 @@ export const enNavbar = navbar([ // text: 'Release', // link: '/Download/', // }, - { - text: 'Community', - children: [ - { text: 'About', link: '/Community/About' }, - { text: 'Feedback', link: '/Community/Feedback' }, - ], - }, - { - text: 'Development', - children: [ - { text: 'Become a Committer', link: '/Development/Community-Project-Committers' }, - { text: 'Power by', link: '/Development/Powered-By' }, - ], - }, + // { + // text: 'Community', + // children: [ + // { text: 'About', link: '/Community/About' }, + // { text: 'Feedback', link: '/Community/Feedback' }, + // ], + // }, + // { + // text: 'Development', + // children: [ + // { text: 'Become a Committer', link: '/Development/Community-Project-Committers' }, + // { text: 'Power by', link: '/Development/Powered-By' }, + // ], + // }, { text: 'ASF', children: [ diff --git a/docs/src/UserGuide/latest/QuickStart/QuickStart.md b/docs/src/UserGuide/latest/QuickStart/QuickStart.md index d1fceaf56..8d8eeef9c 100644 --- a/docs/src/UserGuide/latest/QuickStart/QuickStart.md +++ b/docs/src/UserGuide/latest/QuickStart/QuickStart.md @@ -32,12 +32,11 @@ There are two ways to use TsFile in your own project. * Use as jars: Compile the source codes and build to jars ```shell -git clone https://github.com/apache/iotdb.git -cd iotdb-core/tsfile +git clone https://github.com/apache/tsfile.git mvn clean package -Dmaven.test.skip=true ``` -Then, all the jars are in folder named `target/`. Import `target/tsfile-0.12.0-jar-with-dependencies.jar` to your project. +Then, all the jars are in folder named `target/`. Import `target/tsfile-1.0.0.jar` to your project. * Use as a maven dependency: @@ -46,13 +45,12 @@ Then, all the jars are in folder named `target/`. Import `target/tsfile-0.12.0-j * Get the source codes ```shell - git clone https://github.com/apache/iotdb.git + git clone https://github.com/apache/tsfile.git ``` * Compile the source codes and deploy ```shell - cd iotdb-core/tsfile mvn clean install -Dmaven.test.skip=true ``` @@ -60,7 +58,7 @@ Then, all the jars are in folder named `target/`. Import `target/tsfile-0.12.0-j ```xml - org.apache.iotdb + org.apache.tsfile tsfile 1.0.0 @@ -94,7 +92,7 @@ Then, all the jars are in folder named `target/`. Import `target/tsfile-0.12.0-j ```xml - org.apache.iotdb + org.apache.tsfile tsfile 1.0.0 @@ -292,20 +290,20 @@ Please note, we should redo the step of adding measurements before writing new d You should install TsFile to your local maven repository. ```shell -mvn clean install -pl iotdb-core/tsfile -am -DskipTests +mvn clean install -am -DskipTests ``` You could write a TsFile by constructing **TSRecord** if you have the **non-aligned** (e.g. not all sensors contain values) time series data. -A more thorough example can be found at `/example/tsfile/src/main/java/org/apache/iotdb/tsfile/TsFileWriteWithTSRecord.java` +A more thorough example can be found at `/example/src/main/java/org/apache/tsfile/tsfile/TsFileWriteWithTSRecord.java` You could write a TsFile by constructing **Tablet** if you have the **aligned** time series data. -A more thorough example can be found at `/example/tsfile/src/main/java/org/apache/iotdb/tsfile/TsFileWriteWithTablet.java` +A more thorough example can be found at `/example/src/main/java/org/apache/tsfile/tsfile/TsFileWriteWithTablet.java` You could write data into a closed TsFile by using **ForceAppendTsFileWriter**. -A more thorough example can be found at `/example/tsfile/src/main/java/org/apache/iotdb/tsfile/TsFileForceAppendWrite.java` +A more thorough example can be found at `/example/src/main/java/org/apache/tsfile/tsfile/TsFileForceAppendWrite.java` @@ -500,23 +498,23 @@ You should install TsFile to your local maven repository. A more thorough example with query statement can be found at -`/tsfile/example/src/main/java/org/apache/iotdb/tsfile/TsFileRead.java` +`/example/src/main/java/org/apache/tsfile/TsFileRead.java` ```java -package org.apache.iotdb.tsfile; +package org.apache.tsfile; import java.io.IOException; import java.util.ArrayList; -import org.apache.iotdb.tsfile.read.ReadOnlyTsFile; -import org.apache.iotdb.tsfile.read.TsFileSequenceReader; -import org.apache.iotdb.tsfile.read.common.Path; -import org.apache.iotdb.tsfile.read.expression.IExpression; -import org.apache.iotdb.tsfile.read.expression.QueryExpression; -import org.apache.iotdb.tsfile.read.expression.impl.BinaryExpression; -import org.apache.iotdb.tsfile.read.expression.impl.GlobalTimeExpression; -import org.apache.iotdb.tsfile.read.expression.impl.SingleSeriesExpression; -import org.apache.iotdb.tsfile.read.filter.TimeFilter; -import org.apache.iotdb.tsfile.read.filter.ValueFilter; -import org.apache.iotdb.tsfile.read.query.dataset.QueryDataSet; +import org.apache.tsfile.read.ReadOnlyTsFile; +import org.apache.tsfile.read.TsFileSequenceReader; +import org.apache.tsfile.read.common.Path; +import org.apache.tsfile.read.expression.IExpression; +import org.apache.tsfile.read.expression.QueryExpression; +import org.apache.tsfile.read.expression.impl.BinaryExpression; +import org.apache.tsfile.read.expression.impl.GlobalTimeExpression; +import org.apache.tsfile.read.expression.impl.SingleSeriesExpression; +import org.apache.tsfile.read.filter.TimeFilter; +import org.apache.tsfile.read.filter.ValueFilter; +import org.apache.tsfile.read.query.dataset.QueryDataSet; /** * The class is to show how to read TsFile file named "test.tsfile". diff --git a/docs/src/zh/UserGuide/latest/QuickStart/QuickStart.md b/docs/src/zh/UserGuide/latest/QuickStart/QuickStart.md index b8e71a88c..7ead357fc 100644 --- a/docs/src/zh/UserGuide/latest/QuickStart/QuickStart.md +++ b/docs/src/zh/UserGuide/latest/QuickStart/QuickStart.md @@ -30,8 +30,7 @@ TsFile 是在 IoTDB 中使用的时间序列的文件格式。在这个章节中 * 使用 jar 包：编译源码生成 jar 包 ```shell -git clone https://github.com/apache/iotdb.git -cd iotdb-core/tsfile/ +git clone https://github.com/apache/tsfile.git mvn clean package -Dmaven.test.skip=true ``` @@ -44,23 +43,22 @@ mvn clean package -Dmaven.test.skip=true 1. 下载源码 ```shell -git clone https://github.com/apache/iotdb.git +git clone https://github.com/apache/tsfile.git ``` 2. 编译源码和部署到本地仓库 ```shell -cd iotdb-core/tsfile/ mvn clean install -Dmaven.test.skip=true ``` 3. 在您自己的工程中增加依赖： - ```xml - - org.apache.iotdb - tsfile - 0.12.0 - - ``` + ```xml + + org.apache.tsfile + tsfile + 1.0.0 + + ``` 或者，您可以直接使用官方的 Maven 仓库： @@ -90,7 +88,7 @@ mvn clean install -Dmaven.test.skip=true ```xml - org.apache.iotdb + org.apache.tsfile tsfile 1.0.0 @@ -271,7 +269,7 @@ TsFile 可以通过以下三个步骤生成，完整的代码参见"写入 TsFil 您需要安装 TsFile 到本地的 Maven 仓库中。 ```shell -mvn clean install -pl iotdb-core/tsfile -am -DskipTests +mvn clean install -am -DskipTests ``` 如果存在**非对齐**的时序数据（比如：不是所有的传感器都有值），您可以通过构造** TSRecord **来写入。 @@ -279,7 +277,7 @@ mvn clean install -pl iotdb-core/tsfile -am -DskipTests 更详细的例子可以在 ``` -/example/tsfile/src/main/java/org/apache/iotdb/tsfile/TsFileWriteWithTSRecord.java +/example/src/main/java/org/apache/tsfile/TsFileWriteWithTSRecord.java ``` 中查看 @@ -289,14 +287,14 @@ mvn clean install -pl iotdb-core/tsfile -am -DskipTests 更详细的例子可以在 ``` -/example/tsfile/src/main/java/org/apache/iotdb/tsfile/TsFileWriteWithTablet.java +/example/src/main/java/org/apache/tsfile/TsFileWriteWithTablet.java ``` 中查看 在已关闭的 TsFile 文件中写入新数据的详细例子可以在 ``` -/example/tsfile/src/main/java/org/apache/iotdb/tsfile/TsFileForceAppendWrite.java +/example/src/main/java/org/apache/tsfile/TsFileForceAppendWrite.java ``` 中查看 @@ -473,23 +471,23 @@ public QueryDataSet query(QueryExpression queryExpression, long partitionStartOf 您需要安装 TsFile 到本地的 Maven 仓库中。 有关查询语句的更详细示例，请参见 -`/example/tsfile/src/main/java/org/apache/iotdb/tsfile/TsFileRead.java` +`/example/src/main/java/org/apache/tsfile/TsFileRead.java` ```java -package org.apache.iotdb.tsfile; +package org.apache.tsfile; import java.io.IOException; import java.util.ArrayList; -import org.apache.iotdb.tsfile.read.ReadOnlyTsFile; -import org.apache.iotdb.tsfile.read.TsFileSequenceReader; -import org.apache.iotdb.tsfile.read.common.Path; -import org.apache.iotdb.tsfile.read.expression.IExpression; -import org.apache.iotdb.tsfile.read.expression.QueryExpression; -import org.apache.iotdb.tsfile.read.expression.impl.BinaryExpression; -import org.apache.iotdb.tsfile.read.expression.impl.GlobalTimeExpression; -import org.apache.iotdb.tsfile.read.expression.impl.SingleSeriesExpression; -import org.apache.iotdb.tsfile.read.filter.TimeFilter; -import org.apache.iotdb.tsfile.read.filter.ValueFilter; -import org.apache.iotdb.tsfile.read.query.dataset.QueryDataSet; +import org.apache.tsfile.read.ReadOnlyTsFile; +import org.apache.tsfile.read.TsFileSequenceReader; +import org.apache.tsfile.read.common.Path; +import org.apache.tsfile.read.expression.IExpression; +import org.apache.tsfile.read.expression.QueryExpression; +import org.apache.tsfile.read.expression.impl.BinaryExpression; +import org.apache.tsfile.read.expression.impl.GlobalTimeExpression; +import org.apache.tsfile.read.expression.impl.SingleSeriesExpression; +import org.apache.tsfile.read.filter.TimeFilter; +import org.apache.tsfile.read.filter.ValueFilter; +import org.apache.tsfile.read.query.dataset.QueryDataSet; /** * The class is to show how to read TsFile file named "test.tsfile".