org.apache.flink.table.operations.OutputConversionModifyOperation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flink-table-api-java Show documentation

This module contains the Table/SQL API for writing table programs within the table ecosystem using the Java programming language.

The 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.operations;

import org.apache.flink.annotation.Internal;
import org.apache.flink.api.common.typeinfo.TypeInformation;
import org.apache.flink.api.dag.Transformation;
import org.apache.flink.table.types.DataType;

import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;

/**
 * Special, internal kind of {@link ModifyOperation} that allows converting a tree of
 * {@link QueryOperation}s to a {@link Transformation} of given type described with
 * {@link TypeInformation}. This is used to convert a relational query to a datastream.
 */
@Internal
public class OutputConversionModifyOperation implements ModifyOperation {

	/**
	 * Should the output type contain the change flag, and what should the
	 * flag represent (retraction or deletion).
	 */
	public enum UpdateMode {
		APPEND,
		RETRACT,
		UPSERT
	}

	private final QueryOperation child;
	private final DataType type;
	private final UpdateMode updateMode;

	public OutputConversionModifyOperation(QueryOperation child, DataType type, UpdateMode updateMode) {
		this.child = child;
		this.type = type;
		this.updateMode = updateMode;
	}

	public UpdateMode getUpdateMode() {
		return updateMode;
	}

	public DataType getType() {
		return type;
	}

	@Override
	public QueryOperation getChild() {
		return child;
	}

	@Override
	public String asSummaryString() {
		Map params = new LinkedHashMap<>();
		params.put("updateMode", updateMode);
		params.put("type", type);

		return OperationUtils.formatWithChildren(
			"Output",
			params,
			Collections.singletonList(child),
			Operation::asSummaryString);
	}

	@Override
	public  R accept(ModifyOperationVisitor visitor) {
		return visitor.visit(this);
	}
}