761417898 commented on code in PR #403: URL: https://github.com/apache/tsfile/pull/403#discussion_r1959005692
########## src/UserGuide/develop/QuickStart/InterfaceDefinition/InterfaceDefinition-CPP.md: ########## @@ -0,0 +1,267 @@ +<!-- + + 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 + +### TsFileTableWriter + +Used to write data to tsfile + +```cpp +/** + * @brief Facilitates writing structured table data into a TsFile with a specified schema. + * + * The TsFileTableWriter class is designed to write structured data, particularly suitable for time-series data, + * into a file optimized for efficient storage and retrieval (referred to as TsFile here). It allows users to define + * the schema of the tables they want to write, add rows of data according to that schema, and serialize this data + * into a TsFile. Additionally, it provides options to limit memory usage during the writing process. + */ +class TsFileTableWriter { + public: + /** + * TsFileTableWriter is used to write table data into a target file with the given schema, + * optionally limiting the memory usage. + * + * @param writer_file Target file where the table data will be written. Must not be null. + * @param table_schema Used to construct table structures. Defines the schema of the table + * being written. + * @param memory_threshold Optional parameter used to limit the memory size of objects. + * If set to 0, no memory limit is enforced. + */ + TsFileTableWriter(WriteFile* writer_file, + TableSchema* table_schema, + uint64_t memory_threshold = 0); + ~TsFileTableWriter(); + /** + * Writes the given tablet data into the target file according to the schema. + * + * @param tablet The tablet containing the data to be written. Must not be null. + * @return Returns 0 on success, or a non-zero error code on failure. + */ + int write_table(const Tablet& tablet); + /** + * Flushes any buffered data to the underlying storage medium, ensuring all data is written out. + * This method ensures that all pending writes are persisted. + * + * @return Returns 0 on success, or a non-zero error code on failure. + */ + int flush(); + /** + * Closes the writer and releases any resources held by it. + * After calling this method, no further operations should be performed on this instance. + * + * @return Returns 0 on success, or a non-zero error code on failure. + */ + int close(); +}; +``` + +### TableSchema + +Describe the data structure of the table schema + +```cpp +/** +* @brief Represents the schema information for an entire table. +* +* This class holds the metadata necessary to describe how a specific table is structured, +* including its name and the schemas of all its columns. +*/ +class TableSchema { + public: + /** + * Constructs a TableSchema object with the given table name, column schemas, and column categories. + * + * @param table_name The name of the table. Must be a non-empty string. + * This name is used to identify the table within the system. + * @param column_schemas A vector containing pointers to ColumnSchema objects. + * Each ColumnSchema defines the schema for one column in the table. + */ + TableSchema(const std::string& table_name, + const std::vector<ColumnSchema>& column_schemas); Review Comment: fixed -- 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: notifications-unsubscr...@tsfile.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
