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

package org.apache.paimon.table.source;

import org.apache.paimon.annotation.Public;
import org.apache.paimon.utils.Restorable;

import javax.annotation.Nullable;

/**
 * {@link TableScan} for streaming, supports {@link #checkpoint} and {@link #restore}.
 *
 * <p>NOTE: {@link #checkpoint} will return the next snapshot id.
 *
 * @since 0.4.0
 */
@Public
public interface StreamTableScan extends TableScan, Restorable<Long> {

    /** Current watermark for consumed snapshot. */
    @Nullable
    Long watermark();

    /** Restore from checkpoint next snapshot id. */
    @Override
    void restore(@Nullable Long nextSnapshotId);

    /** Checkpoint to return next snapshot id. */
    @Nullable
    @Override
    Long checkpoint();

    /** Notifies the checkpoint complete with next snapshot id. */
    void notifyCheckpointComplete(@Nullable Long nextSnapshot);
}
