Fix comment

Signed-off-by: Jin Hai <[email protected]>
infiniflow · Oct 16, 2024 · 5250767 · 5250767
1 parent bffd987
commit 5250767
Show file tree

Hide file tree

Showing 24 changed files with 165 additions and 130 deletions.
diff --git a/src/unit_test/executor/expression/new_expression_evaluator.cpp b/src/unit_test/executor/expression/new_expression_evaluator.cpp
@@ -90,7 +90,7 @@ TEST_P(ExpressionEvaluatorTest, add_bigint_constant_1) {
 
     SharedPtr<DataType> data_type = MakeShared<DataType>(LogicalType::kBigInt);
     SharedPtr<ColumnDef> col_def = MakeShared<ColumnDef>(0, data_type, "c1", std::set<ConstraintType>());
-    SharedPtr<TableDef> table_def = TableDef::Make(MakeShared<String>("default_db"), MakeShared<String>("t1"), {col_def});
+    SharedPtr<TableDef> table_def = TableDef::Make(MakeShared<String>("default_db"), MakeShared<String>("t1"), MakeShared<String>(), {col_def});
     SharedPtr<DataTable> input_table = DataTable::Make(table_def, TableType::kDataTable);
 
     {
@@ -189,7 +189,7 @@ TEST_P(ExpressionEvaluatorTest, subtract_constant_8192_bigint) {
     ExpressionEvaluator expr_evaluator;
 
     SharedPtr<ColumnDef> col_def = MakeShared<ColumnDef>(0, MakeShared<DataType>(DataType(LogicalType::kBigInt)), "c1", std::set<ConstraintType>());
-    SharedPtr<TableDef> table_def = TableDef::Make(MakeShared<String>("default_db"), MakeShared<String>("t1"), {col_def});
+    SharedPtr<TableDef> table_def = TableDef::Make(MakeShared<String>("default_db"), MakeShared<String>("t1"), MakeShared<String>(), {col_def});
     SharedPtr<DataTable> input_table = DataTable::Make(table_def, TableType::kDataTable);
 
     {

diff --git a/src/unit_test/storage/bg_task/cleanup_task.cpp b/src/unit_test/storage/bg_task/cleanup_task.cpp
@@ -157,7 +157,7 @@ TEST_P(CleanupTaskTest, test_delete_table_simple) {
     auto table_name = MakeShared<String>("table1");
     {
 
-        auto table_def = MakeUnique<TableDef>(db_name, table_name, column_defs);
+        auto table_def = MakeUnique<TableDef>(db_name, table_name, MakeShared<String>(), column_defs);
         auto *txn = txn_mgr->BeginTxn(MakeUnique<String>("create table1"));
         auto status = txn->CreateTable(*db_name, std::move(table_def), ConflictType::kIgnore);
         EXPECT_TRUE(status.ok());
@@ -200,7 +200,7 @@ TEST_P(CleanupTaskTest, test_delete_table_complex) {
     auto table_name = MakeShared<String>("table1");
     {
 
-        auto table_def = MakeUnique<TableDef>(db_name, table_name, column_defs);
+        auto table_def = MakeUnique<TableDef>(db_name, table_name, MakeShared<String>(), column_defs);
         auto *txn = txn_mgr->BeginTxn(MakeUnique<String>("create table1"));
         auto status = txn->CreateTable(*db_name, std::move(table_def), ConflictType::kIgnore);
         EXPECT_TRUE(status.ok());
@@ -215,14 +215,14 @@ TEST_P(CleanupTaskTest, test_delete_table_complex) {
         txn_mgr->CommitTxn(txn);
     }
     {
-        auto table_def = MakeUnique<TableDef>(db_name, table_name, column_defs);
+        auto table_def = MakeUnique<TableDef>(db_name, table_name, MakeShared<String>(), column_defs);
         auto *txn = txn_mgr->BeginTxn(MakeUnique<String>("create table1"));
         auto status = txn->CreateTable(*db_name, std::move(table_def), ConflictType::kIgnore);
         EXPECT_TRUE(status.ok());
         txn_mgr->RollBackTxn(txn);
     }
     {
-        auto table_def = MakeUnique<TableDef>(db_name, table_name, column_defs);
+        auto table_def = MakeUnique<TableDef>(db_name, table_name, MakeShared<String>(), column_defs);
         auto *txn = txn_mgr->BeginTxn(MakeUnique<String>("create table1"));
         auto status = txn->CreateTable(*db_name, std::move(table_def), ConflictType::kIgnore);
         EXPECT_TRUE(status.ok());
@@ -268,7 +268,7 @@ TEST_P(CleanupTaskTest, test_compact_and_cleanup) {
     auto table_name = MakeShared<String>("table1");
     {
 
-        auto table_def = MakeUnique<TableDef>(db_name, table_name, column_defs);
+        auto table_def = MakeUnique<TableDef>(db_name, table_name, MakeShared<String>(), column_defs);
         auto *txn = txn_mgr->BeginTxn(MakeUnique<String>("create table1"));
         auto status = txn->CreateTable(*db_name, std::move(table_def), ConflictType::kIgnore);
         EXPECT_TRUE(status.ok());
@@ -345,7 +345,7 @@ TEST_P(CleanupTaskTest, test_with_index_compact_and_cleanup) {
         column_defs.push_back(MakeShared<ColumnDef>(column_id++, MakeShared<DataType>(DataType(LogicalType::kInteger)), *column_name, constraints));
     }
     {
-        auto table_def = MakeUnique<TableDef>(db_name, table_name, column_defs);
+        auto table_def = MakeUnique<TableDef>(db_name, table_name, MakeShared<String>(), column_defs);
         auto *txn = txn_mgr->BeginTxn(MakeUnique<String>("create table1"));
         auto status = txn->CreateTable(*db_name, std::move(table_def), ConflictType::kIgnore);
         EXPECT_TRUE(status.ok());

diff --git a/src/unit_test/storage/bg_task/compact_segments_task.cpp b/src/unit_test/storage/bg_task/compact_segments_task.cpp
@@ -133,7 +133,7 @@ TEST_P(CompactTaskTest, compact_to_single_segment) {
             }
         }
         { // create table
-            auto tbl1_def = MakeUnique<TableDef>(MakeShared<String>("default_db"), MakeShared<String>(table_name), columns);
+            auto tbl1_def = MakeUnique<TableDef>(MakeShared<String>("default_db"), MakeShared<String>(table_name), MakeShared<String>(), columns);
             auto *txn = txn_mgr->BeginTxn(MakeUnique<String>("create table"));
 
             Status status = txn->CreateTable("default_db", std::move(tbl1_def), ConflictType::kIgnore);
@@ -194,7 +194,7 @@ TEST_P(CompactTaskTest, compact_to_two_segment) {
             }
         }
         { // create table
-            auto tbl1_def = MakeUnique<TableDef>(MakeShared<String>("default_db"), MakeShared<String>(table_name), columns);
+            auto tbl1_def = MakeUnique<TableDef>(MakeShared<String>("default_db"), MakeShared<String>(table_name), MakeShared<String>(), columns);
             auto *txn = txn_mgr->BeginTxn(MakeUnique<String>("create table"));
 
             Status status = txn->CreateTable("default_db", std::move(tbl1_def), ConflictType::kIgnore);
@@ -259,7 +259,7 @@ TEST_P(CompactTaskTest, compact_with_delete) {
             }
         }
         { // create table
-            auto tbl1_def = MakeUnique<TableDef>(MakeShared<String>("default_db"), MakeShared<String>(table_name), columns);
+            auto tbl1_def = MakeUnique<TableDef>(MakeShared<String>("default_db"), MakeShared<String>(table_name), MakeShared<String>(), columns);
             auto *txn = txn_mgr->BeginTxn(MakeUnique<String>("create table"));
 
             Status status = txn->CreateTable("default_db", std::move(tbl1_def), ConflictType::kIgnore);
@@ -345,7 +345,7 @@ TEST_P(SilentLogTestCompactTaskTest, delete_in_compact_process) {
             }
         }
         { // create table
-            auto tbl1_def = MakeUnique<TableDef>(MakeShared<String>("default_db"), MakeShared<String>(table_name), columns);
+            auto tbl1_def = MakeUnique<TableDef>(MakeShared<String>("default_db"), MakeShared<String>(table_name), MakeShared<String>(), columns);
             auto *txn = txn_mgr->BeginTxn(MakeUnique<String>("create table"));
 
             Status status = txn->CreateTable("default_db", std::move(tbl1_def), ConflictType::kIgnore);
@@ -459,7 +459,7 @@ TEST_P(CompactTaskTest, uncommit_delete_in_compact_process) {
             }
         }
         { // create table
-            auto tbl1_def = MakeUnique<TableDef>(MakeShared<String>("default_db"), MakeShared<String>(table_name), columns);
+            auto tbl1_def = MakeUnique<TableDef>(MakeShared<String>("default_db"), MakeShared<String>(table_name), MakeShared<String>(), columns);
             auto *txn = txn_mgr->BeginTxn(MakeUnique<String>("create table"));
 
             Status status = txn->CreateTable("default_db", std::move(tbl1_def), ConflictType::kIgnore);
@@ -606,7 +606,7 @@ TEST_P(CompactTaskTest, compact_not_exist_table) {
         std::set<ConstraintType> constraints;
         auto column_def_ptr = MakeShared<ColumnDef>(column_id++, MakeShared<DataType>(DataType(LogicalType::kTinyInt)), "tiny_int_col", constraints);
         columns.emplace_back(column_def_ptr);
-        tbl1_def = MakeShared<TableDef>(MakeShared<String>("default_db"), MakeShared<String>(table_name), columns);
+        tbl1_def = MakeShared<TableDef>(MakeShared<String>("default_db"), MakeShared<String>(table_name), MakeShared<String>(), columns);
     }
     {
         // create table

diff --git a/src/unit_test/storage/binary_fuse_filter/segment_sealing.cpp b/src/unit_test/storage/binary_fuse_filter/segment_sealing.cpp
@@ -97,7 +97,7 @@ TEST_P(SealingTaskTest, append_unsealed_segment_sealed) {
         }
         {
             // create table
-            auto tbl1_def = MakeUnique<TableDef>(MakeShared<String>("default_db"), MakeShared<String>(table_name), columns);
+            auto tbl1_def = MakeUnique<TableDef>(MakeShared<String>("default_db"), MakeShared<String>(table_name), MakeShared<String>(), columns);
             auto *txn = txn_mgr->BeginTxn(MakeUnique<String>("create table"));
 
             Status status = txn->CreateTable("default_db", std::move(tbl1_def), ConflictType::kIgnore);

diff --git a/src/unit_test/storage/buffer/buffer_obj.cpp b/src/unit_test/storage/buffer/buffer_obj.cpp
@@ -59,13 +59,9 @@ import default_values;
 using namespace infinity;
 
 class BufferObjTest : public BaseTest {
-    void SetUp() override {
-        BaseTest::SetUp();
-    }
+    void SetUp() override { BaseTest::SetUp(); }
 
-    void TearDown() override {
-        BaseTest::TearDown();
-    }
+    void TearDown() override { BaseTest::TearDown(); }
 
 public:
     void SaveBufferObj(BufferObj *buffer_obj) { buffer_obj->Save(); };
@@ -91,7 +87,7 @@ TEST_F(BufferObjTest, test1) {
 
     RemoveDbDirs();
     std::shared_ptr<std::string> config_path = std::make_shared<std::string>(std::string(test_data_path()) + "/config/test_buffer_obj.toml");
-//    RemoveDbDirs();
+    //    RemoveDbDirs();
     infinity::InfinityContext::instance().Init(config_path);
 
     SizeT memory_limit = 1024;
@@ -100,7 +96,8 @@ TEST_F(BufferObjTest, test1) {
     auto base_dir = MakeShared<String>(GetFullDataDir());
     auto persistence_dir = MakeShared<String>(data_dir + "/persistence");
 
-    UniquePtr<PersistenceManager> persistence_manager = MakeUnique<PersistenceManager>(*persistence_dir, *base_dir, DEFAULT_PERSISTENCE_OBJECT_SIZE_LIMIT);
+    UniquePtr<PersistenceManager> persistence_manager =
+        MakeUnique<PersistenceManager>(*persistence_dir, *base_dir, DEFAULT_PERSISTENCE_OBJECT_SIZE_LIMIT);
     BufferManager buffer_manager(memory_limit, base_dir, temp_dir, persistence_manager.get());
 
     SizeT test_size1 = 1024;
@@ -138,7 +135,9 @@ TEST_F(BufferObjTest, test1) {
         buf1->CheckState();
     }
 
-    { auto handle2 = buf2->Load(); }
+    {
+        auto handle2 = buf2->Load();
+    }
     // kUnloaded, kEphemeral -> kFreed, kEphemeral
     EXPECT_EQ(buf1->status(), BufferStatus::kFreed);
     buf1->CheckState();
@@ -150,7 +149,9 @@ TEST_F(BufferObjTest, test1) {
         EXPECT_EQ(buf1->status(), BufferStatus::kLoaded);
         buf1->CheckState();
     }
-    { auto handle2 = buf2->Load(); }
+    {
+        auto handle2 = buf2->Load();
+    }
 
     /// kTemp
     {
@@ -172,7 +173,9 @@ TEST_F(BufferObjTest, test1) {
         buf1->CheckState();
     }
 
-    { auto handle2 = buf2->Load(); }
+    {
+        auto handle2 = buf2->Load();
+    }
     // kUnloaded, kTemp -> kFreed, kTemp
     EXPECT_EQ(buf1->status(), BufferStatus::kFreed);
     buf1->CheckState();
@@ -200,7 +203,9 @@ TEST_F(BufferObjTest, test1) {
         buf1->CheckState();
     }
 
-    { auto handle2 = buf2->Load(); }
+    {
+        auto handle2 = buf2->Load();
+    }
     // kUnloaded, kPersistent -> kFreed, kPersistent
     EXPECT_EQ(buf1->status(), BufferStatus::kFreed);
     buf1->CheckState();
@@ -254,7 +259,9 @@ TEST_F(BufferObjTest, test1) {
         auto handle1 = buf1->Load();
         __attribute__((unused)) auto data1 = handle1.GetDataMut();
     }
-    { auto handle2 = buf2->Load(); }
+    {
+        auto handle2 = buf2->Load();
+    }
     {
         auto handle1 = buf1->Load();
         SaveBufferObj(buf1);
@@ -267,8 +274,12 @@ TEST_F(BufferObjTest, test1) {
         auto handle1 = buf1->Load();
         __attribute__((unused)) auto data1 = handle1.GetDataMut();
     }
-    { auto handle2 = buf2->Load(); }
-    { auto handle1 = buf1->Load(); }
+    {
+        auto handle2 = buf2->Load();
+    }
+    {
+        auto handle1 = buf1->Load();
+    }
     SaveBufferObj(buf1);
     // kUnloaded, kPersistent -> kUnloaded, kPersistent
     EXPECT_EQ(buf1->status(), BufferStatus::kUnloaded);
@@ -494,7 +505,7 @@ TEST_F(BufferObjTest, test_hnsw_index_buffer_obj_shutdown) {
     infinity::GlobalResourceUsage::Init();
 #endif
     std::shared_ptr<std::string> config_path = std::make_shared<std::string>(std::string(test_data_path()) + "/config/test_buffer_obj_2.toml");
-//    RemoveDbDirs();
+    //    RemoveDbDirs();
     infinity::InfinityContext::instance().Init(config_path);
 
     constexpr u64 kInsertN = 2;
@@ -524,7 +535,8 @@ TEST_F(BufferObjTest, test_hnsw_index_buffer_obj_shutdown) {
                 MakeShared<ColumnDef>(column_id, MakeShared<DataType>(LogicalType::kEmbedding, embedding_info), "col1", constraints);
             column_defs.emplace_back(column_def_ptr);
         }
-        auto tbl1_def = MakeUnique<TableDef>(MakeShared<String>("default_db"), MakeShared<String>("test_hnsw"), column_defs);
+        auto tbl1_def =
+            MakeUnique<TableDef>(MakeShared<String>("default_db"), MakeShared<String>("test_hnsw"), MakeShared<String>("test_comment"), column_defs);
         auto *txn = txn_mgr->BeginTxn(MakeUnique<String>("create table"));
         Status status = txn->CreateTable("default_db", std::move(tbl1_def), ConflictType::kError);
         EXPECT_TRUE(status.ok());
@@ -677,6 +689,7 @@ TEST_F(BufferObjTest, test_big_with_gc_and_cleanup) {
 
     auto db_name = MakeShared<String>("default_db");
     auto table_name = MakeShared<String>("table1");
+    auto table_comment = MakeShared<String>("table1_commment");
     auto index_name = MakeShared<String>("idx1");
     auto column_name = MakeShared<String>("col1");
 
@@ -687,7 +700,7 @@ TEST_F(BufferObjTest, test_big_with_gc_and_cleanup) {
         column_defs.push_back(MakeShared<ColumnDef>(column_id++, MakeShared<DataType>(DataType(LogicalType::kBigInt)), *column_name, constraints));
     }
     {
-        auto table_def = MakeUnique<TableDef>(db_name, table_name, column_defs);
+        auto table_def = MakeUnique<TableDef>(db_name, table_name, table_comment, column_defs);
         auto *txn = txn_mgr->BeginTxn(MakeUnique<String>("create table"));
         auto status = txn->CreateTable(*db_name, std::move(table_def), ConflictType::kIgnore);
         EXPECT_TRUE(status.ok());
@@ -771,6 +784,7 @@ TEST_F(BufferObjTest, test_multiple_threads_read) {
 
     auto db_name = MakeShared<String>("default_db");
     auto table_name = MakeShared<String>("table1");
+    auto table_comment = MakeShared<String>("table_comment");
     auto index_name = MakeShared<String>("idx1");
     auto column_name = MakeShared<String>("col1");
 
@@ -781,7 +795,7 @@ TEST_F(BufferObjTest, test_multiple_threads_read) {
         column_defs.push_back(MakeShared<ColumnDef>(column_id++, MakeShared<DataType>(DataType(LogicalType::kBigInt)), *column_name, constraints));
     }
     {
-        auto table_def = MakeUnique<TableDef>(db_name, table_name, column_defs);
+        auto table_def = MakeUnique<TableDef>(db_name, table_name, table_comment, column_defs);
         auto *txn = txn_mgr->BeginTxn(MakeUnique<String>("create table"));
         auto status = txn->CreateTable(*db_name, std::move(table_def), ConflictType::kIgnore);
         EXPECT_TRUE(status.ok());

diff --git a/src/unit_test/storage/definition/table.cpp b/src/unit_test/storage/definition/table.cpp
@@ -61,7 +61,8 @@ TEST_F(TableTest, test1) {
     col_def = MakeShared<ColumnDef>(1, col_type, col_name, std::set<ConstraintType>());
     columns.emplace_back(col_def);
 
-    SharedPtr<TableDef> table_def = TableDef::Make(MakeShared<String>("default_db"), MakeShared<String>("order_by_table"), columns);
+    SharedPtr<TableDef> table_def =
+        TableDef::Make(MakeShared<String>("default_db"), MakeShared<String>("order_by_table"), MakeShared<String>("comment"), columns);
 
     SharedPtr<DataTable> order_by_table = DataTable::Make(table_def, TableType::kOrderBy);
 

diff --git a/src/unit_test/storage/definition/table_def.cpp b/src/unit_test/storage/definition/table_def.cpp
@@ -52,9 +52,11 @@ TEST_F(TableDefTest, test1) {
         columns.emplace_back(column_def_ptr);
     }
 
-    TableDef table_def(MakeShared<String>("default_db"), MakeShared<String>("t1"), columns);
+    TableDef table_def(MakeShared<String>("default_db"), MakeShared<String>("t1"), MakeShared<String>("t1_comment"), columns);
 
     EXPECT_EQ(*table_def.table_name(), "t1");
+    EXPECT_EQ(*table_def.schema_name(), "default_db");
+    EXPECT_EQ(*table_def.table_comment(), "t1_comment");
     EXPECT_EQ(table_def.column_count(), 2u);
     EXPECT_EQ(table_def.GetColIdByName("c1"), 0u);
     EXPECT_EQ(table_def.GetColIdByName("c2"), 1u);
@@ -76,24 +78,43 @@ TEST_F(TableDefTest, ReadWrite) {
     {
         std::set<ConstraintType> constraints;
         constraints.insert(ConstraintType::kPrimaryKey);
-        auto column_def_ptr =
-            MakeShared<ColumnDef>(column_id++, MakeShared<DataType>(LogicalType::kVarchar), "c2", constraints);
+        auto column_def_ptr = MakeShared<ColumnDef>(column_id++, MakeShared<DataType>(LogicalType::kVarchar), "c2", constraints);
         columns.emplace_back(column_def_ptr);
     }
 
-    TableDef table_def(MakeShared<String>("default_db"), MakeShared<String>("t1"), columns);
-
-    int32_t exp_size = table_def.GetSizeInBytes();
-    Vector<char> buf(exp_size, char(0));
-    char *buf_beg = buf.data();
-    char *ptr = buf_beg;
-    table_def.WriteAdv(ptr);
-    EXPECT_EQ(ptr - buf_beg, exp_size);
-
-    const char *ptr_r = buf_beg;
-    int32_t maxbytes = exp_size;
-    SharedPtr<TableDef> table_def2 = table_def.ReadAdv(ptr_r, maxbytes);
-    EXPECT_EQ(ptr_r - buf_beg, exp_size);
-    EXPECT_NE(table_def2, nullptr);
-    EXPECT_EQ(*table_def2, table_def);
+    {
+        TableDef table_def(MakeShared<String>("default_db"), MakeShared<String>("t1"), MakeShared<String>(), columns);
+
+        int32_t exp_size = table_def.GetSizeInBytes();
+        Vector<char> buf(exp_size, char(0));
+        char *buf_beg = buf.data();
+        char *ptr = buf_beg;
+        table_def.WriteAdv(ptr);
+        EXPECT_EQ(ptr - buf_beg, exp_size);
+
+        const char *ptr_r = buf_beg;
+        int32_t maxbytes = exp_size;
+        SharedPtr<TableDef> table_def2 = table_def.ReadAdv(ptr_r, maxbytes);
+        EXPECT_EQ(ptr_r - buf_beg, exp_size);
+        EXPECT_NE(table_def2, nullptr);
+        EXPECT_EQ(*table_def2, table_def);
+    }
+
+    {
+        TableDef table_def(MakeShared<String>("default_db"), MakeShared<String>("t1"), MakeShared<String>("t1_comment"), columns);
+
+        int32_t exp_size = table_def.GetSizeInBytes();
+        Vector<char> buf(exp_size, char(0));
+        char *buf_beg = buf.data();
+        char *ptr = buf_beg;
+        table_def.WriteAdv(ptr);
+        EXPECT_EQ(ptr - buf_beg, exp_size);
+
+        const char *ptr_r = buf_beg;
+        int32_t maxbytes = exp_size;
+        SharedPtr<TableDef> table_def2 = table_def.ReadAdv(ptr_r, maxbytes);
+        EXPECT_EQ(ptr_r - buf_beg, exp_size);
+        EXPECT_NE(table_def2, nullptr);
+        EXPECT_EQ(*table_def2, table_def);
+    }
 }
diff --git a/src/unit_test/storage/invertedindex/search/query_match.cpp b/src/unit_test/storage/invertedindex/search/query_match.cpp
@@ -174,7 +174,7 @@ void QueryMatchTest::CreateDBAndTable(const String& db_name, const String& table
         auto col3_def = MakeShared<ColumnDef>(2, col3_type, std::move(col3_name), std::set<ConstraintType>());
         column_defs.push_back(col3_def);
     }
-    auto table_def = TableDef::Make(MakeShared<String>(db_name), MakeShared<String>(table_name), std::move(column_defs));
+    auto table_def = TableDef::Make(MakeShared<String>(db_name), MakeShared<String>(table_name), MakeShared<String>(), std::move(column_defs));
     Storage *storage = InfinityContext::instance().storage();
     TxnManager *txn_mgr = storage->txn_manager();
     {