davidradl commented on code in PR #26013: URL: https://github.com/apache/flink/pull/26013#discussion_r1922326609
########## docs/content.zh/docs/dev/datastream/sinks.md: ########## @@ -0,0 +1,136 @@ +--- +title: "Data Sinks" +weight: 12 +type: docs +aliases: + - /dev/stream/sinks.html +--- +<!-- +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. +--> + +# Data Sinks + +This page describes Flink's Data Sink API and the concepts and architecture behind it. +**Read this, if you are interested in how data sinks in Flink work, or if you want to implement a new Data Sink.** + +If you are looking for pre-defined sink connectors, please check the [Connector Docs]({{< ref "docs/connectors/datastream/overview" >}}). + +## The Data Sink API +This section describes the major interfaces of the new Sink API introduced in [FLIP-191](https://cwiki.apache.org/confluence/display/FLINK/FLIP-191%3A+Extend+unified+Sink+interface+to+support+small+file+compaction), and provides tips to the developers on the Sink development. + +### Sink +The {{< gh_link file="flink-core/src/main/java/org/apache/flink/api/connector/sink2/Sink.java" name="Sink" >}} API is a factory style interface to create the [SinkWriter](#sinkwriter) to write the data. + +The Sink implementations should be serializable as the Sink instances are serialized and uploaded to the Flink cluster at runtime. + +#### Use the Sink +We can add a `Sink` to `DataStream` by calling `DataStream.sinkTo(Sink)` method. For example, + +{{< tabs "bde5ff60-4e61-4633-a6dc-50413cfd7b45" >}} +{{< tab "Java" >}} +```java +final StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment(); + +Source mySource = new MySource(...); + +DataStream<Integer> stream = env.fromSource( + mySource, + WatermarkStrategy.noWatermarks(), + "MySourceName"); + +Sink mySink = new MySink(...); + +stream.sinkTo(mySink); +... +``` +{{< /tab >}} +{{< tab "Scala" >}} Review Comment: The Scala API has been removed. so need to refer to it at V2. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
