org.apache.flink.table.sources.PartitionableTableSource Maven / Gradle / Ivy

Go to download
/*
 * 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.flink.table.sources;

import org.apache.flink.annotation.Experimental;
import org.apache.flink.table.connector.source.DynamicTableSource;
import org.apache.flink.table.connector.source.abilities.SupportsPartitionPushDown;

import java.util.List;
import java.util.Map;

/**
 * An interface for partitionable {@link TableSource}.
 *
 * A {@link PartitionableTableSource} can exclude partitions from reading, which includes
 * skipping the metadata. This is especially useful when there are thousands of partitions in a
 * table.
 *
 * 
A partition is represented as a {@code Map} which maps from partition field
 * name to partition value. Since the map is NOT ordered, the correct order of partition fields
 * should be obtained via partition keys of catalog table.
 *
 * @deprecated This interface will not be supported in the new source design around {@link
 *     DynamicTableSource}. Use {@link SupportsPartitionPushDown} instead. See FLIP-95 for more
 *     information.
 */
@Deprecated
@Experimental
public interface PartitionableTableSource {

    /** Returns all the partitions of this {@link PartitionableTableSource}. */
    List> getPartitions();

    /**
     * Applies the remaining partitions to the table source. The {@code remainingPartitions} is the
     * remaining partitions of {@link #getPartitions()} after partition pruning applied.
     *
     * After trying to apply partition pruning, we should return a new {@link TableSource}
     * instance which holds all pruned-partitions.
     *
     * @param remainingPartitions Remaining partitions after partition pruning applied.
     * @return A new cloned instance of {@link TableSource} holds all pruned-partitions.
     */
    TableSource applyPartitionPruning(List> remainingPartitions);
}