paimon-python/pypaimon/table/source/full_text_search_split.py

# 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.

"""Splits of full-text search."""

from dataclasses import dataclass
from typing import List

from pypaimon.index.index_file_meta import IndexFileMeta
from pypaimon.utils.range import Range


class FullTextSearchSplit:
    """Base split of full-text search."""


@dataclass
class IndexFullTextSearchSplit(FullTextSearchSplit):
    """Split to read full-text index files."""

    column_name: str
    row_range_start: int
    row_range_end: int
    full_text_index_files: List[IndexFileMeta]


@dataclass
class RawFullTextSearchSplit(FullTextSearchSplit):
    """Split to scan raw rows for full-text search."""

    row_ranges: List[Range]