include/paimon/table/source/plan.h

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

#pragma once

#include <memory>
#include <optional>
#include <vector>

#include "paimon/table/source/split.h"

namespace paimon {
/// %Result plan of this `TableScan`.
class PAIMON_EXPORT Plan {
 public:
    virtual ~Plan() = default;
    /// %Result splits.
    virtual const std::vector<std::shared_ptr<Split>>& Splits() const = 0;
    /// Snapshot id of this plan, return `std::nullopt` if the table is empty.
    virtual std::optional<int64_t> SnapshotId() const = 0;
};
}  // namespace paimon