org.apache.flink.table.planner.operations.RichTableSourceQueryOperation Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-table-planner-blink_2.12 Show documentation

This module bridges Table/SQL API and runtime. It contains all resources that are required during pre-flight and runtime phase. The content of this module is work-in-progress. It will replace flink-table-planner once it is stable. See FLINK-11439 and FLIP-32 for more details.

There is a newer version: 1.13.6

Show newest version

/*
 * 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.planner.operations;

import org.apache.flink.annotation.Internal;
import org.apache.flink.table.catalog.ObjectIdentifier;
import org.apache.flink.table.operations.Operation;
import org.apache.flink.table.operations.OperationUtils;
import org.apache.flink.table.operations.TableSourceQueryOperation;
import org.apache.flink.table.planner.plan.stats.FlinkStatistic;
import org.apache.flink.table.sources.StreamTableSource;
import org.apache.flink.table.sources.TableSource;
import org.apache.flink.util.Preconditions;

import java.util.HashMap;
import java.util.Map;

/**
 * A {@link TableSourceQueryOperation} with {@link FlinkStatistic} and qualifiedName.
 * TODO this class should be deleted after unique key in TableSchema is ready
 * and setting catalog statistic to TableSourceTable in DatabaseCalciteSchema is ready
 *
 * This is only used for testing.
 */
@Internal
public class RichTableSourceQueryOperation extends TableSourceQueryOperation {
	private final FlinkStatistic statistic;
	private final ObjectIdentifier identifier;

	public RichTableSourceQueryOperation(
			ObjectIdentifier identifier,
			TableSource tableSource,
			FlinkStatistic statistic) {
		super(tableSource, false);
		Preconditions.checkArgument(tableSource instanceof StreamTableSource,
				"Blink planner should always use StreamTableSource.");
		this.statistic = statistic;
		this.identifier = identifier;
	}

	@Override
	public String asSummaryString() {
		Map args = new HashMap<>();
		args.put("fields", getTableSource().getTableSchema().getFieldNames());
		if (statistic != FlinkStatistic.UNKNOWN()) {
			args.put("statistic", statistic.toString());
		}

		return OperationUtils.formatWithChildren("TableSource", args, getChildren(), Operation::asSummaryString);
	}

	public ObjectIdentifier getIdentifier() {
		return identifier;
	}

	public FlinkStatistic getStatistic() {
		return statistic;
	}
}