org.apache.flink.table.planner.connectors.TransformationSinkProvider Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-table-planner-blink_2.11 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.connectors;

import org.apache.flink.annotation.Internal;
import org.apache.flink.api.dag.Transformation;
import org.apache.flink.table.connector.sink.DynamicTableSink;
import org.apache.flink.table.connector.sink.OutputFormatProvider;
import org.apache.flink.table.connector.sink.SinkFunctionProvider;
import org.apache.flink.table.connector.sink.SinkProvider;
import org.apache.flink.table.data.RowData;

/**
 * Provider that produces a {@link Transformation} as a runtime implementation for {@link
 * DynamicTableSink}.
 *
 * Note: This provider is only meant for advanced connector developers. Usually, a sink should
 * consist of a single entity expressed via {@link OutputFormatProvider}, {@link
 * SinkFunctionProvider}, or {@link SinkProvider}.
 */
@Internal
public interface TransformationSinkProvider extends DynamicTableSink.SinkRuntimeProvider {

    /** Creates a transformation for transforming the input provided in the context. */
    Transformation createTransformation(Context context);

    /** Context for {@link #createTransformation(Context)}. */
    interface Context {

        /** Helper method for creating the default implementation of {@link Context}. */
        static Context of(Transformation inputTransformation, int rowtimeIndex) {
            return new Context() {
                @Override
                public Transformation getInputTransformation() {
                    return inputTransformation;
                }

                @Override
                public int getRowtimeIndex() {
                    return rowtimeIndex;
                }
            };
        }

        /** Input transformation to transform. */
        Transformation getInputTransformation();

        /** Returns the field index of the rowtime attribute, or {@code -1} otherwise. */
        int getRowtimeIndex();
    }
}