src/paimon/common/table/special_fields_test.cpp

/*
 * 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.
 */

#include "paimon/common/table/special_fields.h"

#include <memory>

#include "arrow/type.h"
#include "gtest/gtest.h"

namespace paimon::test {

TEST(SpecialFieldsTest, TestSequenceNumberField) {
    ASSERT_EQ(SpecialFields::SequenceNumber().Id(), std::numeric_limits<int32_t>::max() - 1);
    ASSERT_EQ(SpecialFields::SequenceNumber().Name(), "_SEQUENCE_NUMBER");
    ASSERT_EQ(SpecialFields::SequenceNumber().Type()->id(), arrow::Type::INT64);
}

TEST(SpecialFieldsTest, TestValueKindField) {
    ASSERT_EQ(SpecialFields::ValueKind().Id(), std::numeric_limits<int32_t>::max() - 2);
    ASSERT_EQ(SpecialFields::ValueKind().Name(), "_VALUE_KIND");
    ASSERT_EQ(SpecialFields::ValueKind().Type()->id(), arrow::Type::INT8);
}

TEST(SpecialFieldsTest, TestRowKindField) {
    ASSERT_EQ(SpecialFields::RowKind().Id(), std::numeric_limits<int32_t>::max() - 3);
    ASSERT_EQ(SpecialFields::RowKind().Name(), "rowkind");
    ASSERT_EQ(SpecialFields::RowKind().Type()->id(), arrow::Type::STRING);
}

TEST(SpecialFieldsTest, TestRowIdField) {
    ASSERT_EQ(SpecialFields::RowId().Id(), std::numeric_limits<int32_t>::max() - 5);
    ASSERT_EQ(SpecialFields::RowId().Name(), "_ROW_ID");
    ASSERT_EQ(SpecialFields::RowId().Type()->id(), arrow::Type::INT64);
}

TEST(SpecialFieldsTest, TestIndexScore) {
    ASSERT_EQ(SpecialFields::IndexScore().Id(), std::numeric_limits<int32_t>::max() - 10000 - 1);
    ASSERT_EQ(SpecialFields::IndexScore().Name(), "_INDEX_SCORE");
    ASSERT_EQ(SpecialFields::IndexScore().Type()->id(), arrow::Type::FLOAT);
}

TEST(SpecialFieldsTest, TestPerFieldIndexScoreNames) {
    for (const auto& field_name : {"F1", "body_text", "_title", "文档"}) {
        const auto name = SpecialFields::IndexScoreFieldName(field_name);
        ASSERT_EQ(SpecialFields::ParseIndexScoreFieldName(name), field_name);
        ASSERT_TRUE(SpecialFields::IsSystemField(name));
    }
    ASSERT_EQ(SpecialFields::IndexScoreFieldName("F1"), "_F1_INDEX_SCORE");
    for (const auto& name : {"_INDEX_SCORE", "__INDEX_SCORE", "F1_INDEX_SCORE", "_F1_index_score",
                             "_F1_INDEX_SCORE_extra"}) {
        ASSERT_FALSE(SpecialFields::ParseIndexScoreFieldName(name));
    }
}

TEST(SpecialFieldsTest, TestRealtimeOffset) {
    ASSERT_EQ(SpecialFields::RealtimeOffset().Id(), SpecialFieldIds::REALTIME_OFFSET);
    ASSERT_EQ(SpecialFields::RealtimeOffset().Name(), "_REALTIME_OFFSET");
    ASSERT_EQ(SpecialFields::RealtimeOffset().Type()->id(), arrow::Type::INT64);
    ASSERT_FALSE(SpecialFields::RealtimeOffset().Nullable());
}

TEST(SpecialFieldsTest, TestKeyValueSpecialFieldCount) {
    ASSERT_EQ(SpecialFields::KEY_VALUE_SPECIAL_FIELD_COUNT, 2);
}

TEST(SpecialFieldsTest, TestGetArrayElementFieldId) {
    ASSERT_EQ(SpecialFields::STRUCTURED_TYPE_FIELD_ID_BASE, 536870911);
    ASSERT_EQ(SpecialFields::STRUCTURED_TYPE_FIELD_DEPTH_LIMIT, 1024);
    ASSERT_EQ(SpecialFields::GetArrayElementFieldId(1, 1), 536871936);
    ASSERT_EQ(SpecialFields::GetArrayElementFieldId(2, 2), 536872961);
}

TEST(SpecialFieldsTest, TestIsSystemField) {
    ASSERT_TRUE(SpecialFields::IsSystemField("_SEQUENCE_NUMBER"));
    ASSERT_TRUE(SpecialFields::IsSystemField("_VALUE_KIND"));
    ASSERT_FALSE(SpecialFields::IsSystemField("VALUE_KIND"));
    ASSERT_TRUE(SpecialFields::IsSystemField("rowkind"));
    ASSERT_TRUE(SpecialFields::IsSystemField("_ROW_ID"));
    ASSERT_TRUE(SpecialFields::IsSystemField("_INDEX_SCORE"));
    ASSERT_FALSE(SpecialFields::IsSystemField("_REALTIME_OFFSET"));
    ASSERT_TRUE(SpecialFields::IsSystemField("_KEY_0"));
}

}  // namespace paimon::test