This is an automated email from the ASF dual-hosted git repository. qiaojialin pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/incubator-iotdb.git
commit bee90f7b14fc11aea989b44b6bf57fcf85285069 Author: 仲炜 <[email protected]> AuthorDate: Sun Mar 29 15:38:27 2020 +0800 add docs and rename util classes. --- .../main/java/org/apache/iotdb/flink/FlinkTsFileBatchSource.java | 5 ++++- .../java/org/apache/iotdb/flink/FlinkTsFileStreamSource.java | 5 ++++- .../java/org/apache/iotdb/flink/{Utils.java => TsFlieUtils.java} | 5 ++++- .../org/apache/iotdb/flink/tsfile/util/TSFileConfigUtil.java | 3 +++ .../apache/iotdb/flink/tsfile/RowTsFileInputFormatTestBase.java | 9 ++++----- .../{tool/TsFileWriteTool.java => util/TsFileWriteUtil.java} | 6 +++--- 6 files changed, 22 insertions(+), 11 deletions(-) diff --git a/example/flink/src/main/java/org/apache/iotdb/flink/FlinkTsFileBatchSource.java b/example/flink/src/main/java/org/apache/iotdb/flink/FlinkTsFileBatchSource.java index 04df1df..6f01b75 100644 --- a/example/flink/src/main/java/org/apache/iotdb/flink/FlinkTsFileBatchSource.java +++ b/example/flink/src/main/java/org/apache/iotdb/flink/FlinkTsFileBatchSource.java @@ -34,11 +34,14 @@ import java.util.Arrays; import java.util.List; import java.util.stream.Collectors; +/** + * The example of reading TsFile via Flink DataSet API. + */ public class FlinkTsFileBatchSource { public static void main(String[] args) throws Exception { String path = "test.tsfile"; - Utils.writeTsFile(path); + TsFlieUtils.writeTsFile(path); new File(path).deleteOnExit(); String[] filedNames = { QueryConstant.RESERVED_TIME, diff --git a/example/flink/src/main/java/org/apache/iotdb/flink/FlinkTsFileStreamSource.java b/example/flink/src/main/java/org/apache/iotdb/flink/FlinkTsFileStreamSource.java index 3750ea2..83f7de9 100644 --- a/example/flink/src/main/java/org/apache/iotdb/flink/FlinkTsFileStreamSource.java +++ b/example/flink/src/main/java/org/apache/iotdb/flink/FlinkTsFileStreamSource.java @@ -37,11 +37,14 @@ import java.util.Iterator; import java.util.List; import java.util.stream.Collectors; +/** + * The example of reading TsFile via Flink DataStream API. + */ public class FlinkTsFileStreamSource { public static void main(String[] args) throws IOException { String path = "test.tsfile"; - Utils.writeTsFile(path); + TsFlieUtils.writeTsFile(path); new File(path).deleteOnExit(); String[] filedNames = { QueryConstant.RESERVED_TIME, diff --git a/example/flink/src/main/java/org/apache/iotdb/flink/Utils.java b/example/flink/src/main/java/org/apache/iotdb/flink/TsFlieUtils.java similarity index 96% rename from example/flink/src/main/java/org/apache/iotdb/flink/Utils.java rename to example/flink/src/main/java/org/apache/iotdb/flink/TsFlieUtils.java index e30ce40..ed7b722 100644 --- a/example/flink/src/main/java/org/apache/iotdb/flink/Utils.java +++ b/example/flink/src/main/java/org/apache/iotdb/flink/TsFlieUtils.java @@ -28,7 +28,10 @@ import org.apache.iotdb.tsfile.write.schema.MeasurementSchema; import java.io.File; -public class Utils { +/** + * Utils used to prepare source TsFiles for the examples. + */ +public class TsFlieUtils { public static void writeTsFile(String path) { try { diff --git a/flink-tsfile/src/main/java/org/apache/iotdb/flink/tsfile/util/TSFileConfigUtil.java b/flink-tsfile/src/main/java/org/apache/iotdb/flink/tsfile/util/TSFileConfigUtil.java index 5295cf4..43b6237 100644 --- a/flink-tsfile/src/main/java/org/apache/iotdb/flink/tsfile/util/TSFileConfigUtil.java +++ b/flink-tsfile/src/main/java/org/apache/iotdb/flink/tsfile/util/TSFileConfigUtil.java @@ -22,6 +22,9 @@ package org.apache.iotdb.flink.tsfile.util; import org.apache.iotdb.tsfile.common.conf.TSFileConfig; import org.apache.iotdb.tsfile.common.conf.TSFileDescriptor; +/** + * Utils of setting global TSFileConfig. + */ public class TSFileConfigUtil { public static void setGlobalTSFileConfig(TSFileConfig config) { diff --git a/flink-tsfile/src/test/java/org/apache/iotdb/flink/tsfile/RowTsFileInputFormatTestBase.java b/flink-tsfile/src/test/java/org/apache/iotdb/flink/tsfile/RowTsFileInputFormatTestBase.java index 0e5f14c..9da84f7 100644 --- a/flink-tsfile/src/test/java/org/apache/iotdb/flink/tsfile/RowTsFileInputFormatTestBase.java +++ b/flink-tsfile/src/test/java/org/apache/iotdb/flink/tsfile/RowTsFileInputFormatTestBase.java @@ -22,10 +22,9 @@ package org.apache.iotdb.flink.tsfile; import org.apache.flink.api.common.typeinfo.TypeInformation; import org.apache.flink.api.common.typeinfo.Types; import org.apache.flink.api.java.typeutils.RowTypeInfo; -import org.apache.flink.configuration.Configuration; import org.apache.flink.types.Row; -import org.apache.iotdb.flink.tool.TsFileWriteTool; +import org.apache.iotdb.flink.util.TsFileWriteUtil; import org.apache.iotdb.tsfile.common.conf.TSFileConfig; import org.apache.iotdb.tsfile.common.constant.QueryConstant; @@ -57,7 +56,7 @@ public abstract class RowTsFileInputFormatTestBase { public void prepareSourceTsFile() throws Exception { tmpDir = String.join( File.separator, - TsFileWriteTool.TMP_DIR, + TsFileWriteUtil.TMP_DIR, UUID.randomUUID().toString()); new File(tmpDir).mkdirs(); sourceTsFilePath1 = String.join( @@ -66,8 +65,8 @@ public abstract class RowTsFileInputFormatTestBase { sourceTsFilePath2 = String.join( File.separator, tmpDir, "source2.tsfile"); - TsFileWriteTool.create1(sourceTsFilePath1); - TsFileWriteTool.create2(sourceTsFilePath2); + TsFileWriteUtil.create1(sourceTsFilePath1); + TsFileWriteUtil.create2(sourceTsFilePath2); } @After diff --git a/flink-tsfile/src/test/java/org/apache/iotdb/flink/tool/TsFileWriteTool.java b/flink-tsfile/src/test/java/org/apache/iotdb/flink/util/TsFileWriteUtil.java similarity index 98% rename from flink-tsfile/src/test/java/org/apache/iotdb/flink/tool/TsFileWriteTool.java rename to flink-tsfile/src/test/java/org/apache/iotdb/flink/util/TsFileWriteUtil.java index bc65ee2..8dd413c 100644 --- a/flink-tsfile/src/test/java/org/apache/iotdb/flink/tool/TsFileWriteTool.java +++ b/flink-tsfile/src/test/java/org/apache/iotdb/flink/util/TsFileWriteUtil.java @@ -17,7 +17,7 @@ * under the License. */ -package org.apache.iotdb.flink.tool; +package org.apache.iotdb.flink.util; import java.io.File; import org.apache.iotdb.tsfile.file.metadata.enums.TSDataType; @@ -30,9 +30,9 @@ import org.apache.iotdb.tsfile.write.record.datapoint.IntDataPoint; import org.apache.iotdb.tsfile.write.schema.MeasurementSchema; /** - * An example of writing data to TsFile + * Utils used to prepare TsFiles for testing. */ -public class TsFileWriteTool { +public class TsFileWriteUtil { public static final String TMP_DIR = "target";
