paimon-python/pypaimon/table/table.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.

from abc import ABC, abstractmethod

from pypaimon.read.read_builder import ReadBuilder
from pypaimon.read.stream_read_builder import StreamReadBuilder
from pypaimon.table.source.batch_vector_search_builder import BatchVectorSearchBuilder
from pypaimon.table.source.full_text_search_builder import FullTextSearchBuilder
from pypaimon.table.source.hybrid_search_builder import HybridSearchBuilder
from pypaimon.table.source.vector_search_builder import VectorSearchBuilder
from pypaimon.write.write_builder import BatchWriteBuilder, StreamWriteBuilder


class Table(ABC):
    """A table provides basic abstraction for table read and write."""

    @abstractmethod
    def new_read_builder(self) -> ReadBuilder:
        """Return a builder for building table scan and table read."""

    @abstractmethod
    def new_stream_read_builder(self) -> StreamReadBuilder:
        """Return a builder for building streaming table scan and read."""

    @abstractmethod
    def new_batch_write_builder(self) -> BatchWriteBuilder:
        """Returns a builder for building batch table write and table commit."""

    @abstractmethod
    def new_stream_write_builder(self) -> StreamWriteBuilder:
        """Returns a builder for building stream table write and table commit."""

    @abstractmethod
    def new_full_text_search_builder(self) -> FullTextSearchBuilder:
        """Returns a new full-text search builder."""

    @abstractmethod
    def new_vector_search_builder(self) -> VectorSearchBuilder:
        """Returns a new vector search builder."""

    @abstractmethod
    def new_hybrid_search_builder(self) -> HybridSearchBuilder:
        """Returns a new hybrid search builder."""

    def new_batch_vector_search_builder(self) -> BatchVectorSearchBuilder:
        """Returns a new batch vector search builder."""
        raise NotImplementedError(
            "%s does not support batch vector search."
            % self.__class__.__name__)