include/paimon/table/source/table_scan.h

/*
 * Copyright 2024-present Alibaba Inc.
 *
 * Licensed 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.
 */

#pragma once

#include <memory>

#include "paimon/result.h"
#include "paimon/table/source/plan.h"
#include "paimon/type_fwd.h"
#include "paimon/visibility.h"

namespace paimon {
class ScanContext;

/// A scanner interface for reading table's meta and create a plan.
class PAIMON_EXPORT TableScan {
 public:
    /// Create an instance of `TableScan`.
    ///
    /// @param context A unique pointer to the `ScanContext` used for scan operations.
    /// @return A Result containing a unique pointer to the `TableScan` instance.
    static Result<std::unique_ptr<TableScan>> Create(std::unique_ptr<ScanContext> context);

    virtual ~TableScan() = default;

    /// Create a scan plan.
    ///
    /// @return A Result containing a shared pointer to the created `Plan` or an error status.
    virtual Result<std::shared_ptr<Plan>> CreatePlan() = 0;
};
}  // namespace paimon