com.starrocks.connector.flink.StarRocksSink Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flink-connector-starrocks Show documentation
Flink connector for starrocks.
There is a newer version: 1.2.10_flink-1.19
Show newest version
/*
 * Licensed 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 com.starrocks.connector.flink;

import com.starrocks.connector.flink.row.sink.StarRocksGenericRowTransformer;
import com.starrocks.connector.flink.row.sink.StarRocksIRowTransformer;
import com.starrocks.connector.flink.row.sink.StarRocksSinkRowBuilder;
import com.starrocks.connector.flink.table.sink.SinkFunctionFactory;
import com.starrocks.connector.flink.table.sink.StarRocksSinkOptions;
import org.apache.flink.streaming.api.functions.sink.SinkFunction;
import org.apache.flink.table.api.TableSchema;

public class StarRocksSink {

    /**
     * Create a StarRocks DataStream sink.
     * 
     * Note: the objects passed to the return sink can be processed in batch and retried.
     * Therefore, objects can not be {@link org.apache.flink.api.common.ExecutionConfig#enableObjectReuse() reused}.
     * 
     *
     * @param flinkTableSchema     TableSchema of the all columns with DataType
     * @param sinkOptions          StarRocksSinkOptions as the document listed, such as jdbc-url, load-url, batch size and maximum retries
     * @param rowDataTransformer   StarRocksSinkRowBuilder which would be used to transform the upstream record.
     * @param                   type of data in {@link org.apache.flink.streaming.runtime.streamrecord.StreamRecord StreamRecord}.
     * @return SinkFunction        SinkFunction that could be add to a stream.
     */
    public static  SinkFunction sink(
            TableSchema flinkTableSchema,
            StarRocksSinkOptions sinkOptions,
            StarRocksSinkRowBuilder rowDataTransformer) {
        StarRocksIRowTransformer rowTransformer =
                new StarRocksGenericRowTransformer<>(rowDataTransformer);
        return SinkFunctionFactory.createSinkFunction(sinkOptions, flinkTableSchema, rowTransformer);
    }

    /**
     * Create a StarRocks DataStream sink, stream elements could only be String.
     * 
     * Note: the objects passed to the return sink can be processed in batch and retried.
     * Therefore, objects can not be {@link org.apache.flink.api.common.ExecutionConfig#enableObjectReuse() reused}.
     * 
     *
     * @param sinkOptions            StarRocksSinkOptions as the document listed, such as jdbc-url, load-url, batch size and maximum retries
     * @return SinkFunction          SinkFunction that could be add to a stream.
     */
    public static SinkFunction sink(StarRocksSinkOptions sinkOptions) {
        return SinkFunctionFactory.createSinkFunction(sinkOptions);
    }

    private StarRocksSink() {}
}