LinJieXiao-XLJ commented on code in PR #365: URL: https://github.com/apache/tsfile/pull/365#discussion_r1903797298
########## docs/src/UserGuide/latest/QuickStart/Interface-Definitions.md: ########## @@ -0,0 +1,240 @@ +<!-- + + 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. + +--> +# Interface Definitions + +## Write Interface + +### ITsFileWriter + +Used to write data to tsfile + +```shell +interface ITsFileWriter extends AutoCloseable { + // Write data + void write(Tablet tablet); + + // Close Write + void close(); +} +``` + +### TsFileWriterBuilder + +Used to construct ITsFileWriter + +```shell +class TsFileWriterBuilder { + // Build ITsFileWriter object + public ITsFileWriter build(); + + // target file + public TsFileWriterBuilder file(File file); + + // Used to construct table structures + public TsFileWriterBuilder tableSchema(TableSchema schema); + + // Used to limit the memory size of objects + public TsFileWriterBuilder memoryThreshold(long memoryThreshold); +} +``` + +### TableSchema + +Describe the data structure of the table schema + +```shell +class TableSchema { + // Constructor function + public TableSchema(String tableName, List<ColumnSchema> columnSchemaList); +} + +class ColumnSchema { + // Constructor function + public ColumnSchema(String columnName, TSDataType dataType, ColumnCategory columnCategory); + + // Get column names + public String getColumnName(); + + // Get the data type of the column + public TSDataType getDataType(); + + // Get column category + public Tablet.ColumnCategory getColumnCategory(); +} + +class ColumnSchemaBuilder { + // Build ColumnSchema object + public ColumnSchema build(); + + // Column Name + public ColumnSchemaBuilder name(String columnName); + + // The data category of the column Review Comment: ok,done -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
