[GitHub] aljoscha commented on a change in pull request #6532: [FLINK-10109] Add documentation for StreamingFileSink
aljoscha commented on a change in pull request #6532: [FLINK-10109] Add documentation for StreamingFileSink URL: https://github.com/apache/flink/pull/6532#discussion_r209167309 ## File path: docs/dev/connectors/streamfile_sink.md ## @@ -0,0 +1,95 @@ +--- +title: "Streaming File Sink" +nav-title: Streaming File Sink +nav-parent_id: connectors +nav-pos: 5 +--- + + +This connector provides a Sink that writes partitioned files to filesystems +supported by the Flink `FileSystem` abstraction. Since in streaming the input +is potentially infinite, the streaming file sink writes data into buckets. The +bucketing behaviour is configurable but a useful default is time-based +bucketing where we start writing a new bucket every hour and thus get +individual files that each contain a part of the infinite output stream. + +Within a bucket, we further split the output into smaller part files based on a +rolling policy. This is useful to prevent individual bucket files from getting +too big. This is also configurable but the default policy rolls files based on +file size and a timeout, i.e if no new data was written to a part file. + + Usage + +The only required configuration are the base path were we want to output our +data and an +[Encoder](http://flink.apache.org/docs/latest/api/java/org/apache/flink/api/common/serialization/Encoder.html) Review comment: I first have to figure out how I can get links to specific versions because we currently only have `http://flink.apache.org/docs/latest` and `http://flink.apache.org/docs/stable` and I don't want to link to the `https://ci.apache.org/projects/flink`-type urls. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] aljoscha commented on a change in pull request #6532: [FLINK-10109] Add documentation for StreamingFileSink
aljoscha commented on a change in pull request #6532: [FLINK-10109] Add
documentation for StreamingFileSink
URL: https://github.com/apache/flink/pull/6532#discussion_r209167365
##
File path: docs/dev/connectors/streamfile_sink.md
##
@@ -0,0 +1,95 @@
+---
+title: "Streaming File Sink"
+nav-title: Streaming File Sink
+nav-parent_id: connectors
+nav-pos: 5
+---
+
+
+This connector provides a Sink that writes partitioned files to filesystems
+supported by the Flink `FileSystem` abstraction. Since in streaming the input
+is potentially infinite, the streaming file sink writes data into buckets. The
+bucketing behaviour is configurable but a useful default is time-based
+bucketing where we start writing a new bucket every hour and thus get
+individual files that each contain a part of the infinite output stream.
+
+Within a bucket, we further split the output into smaller part files based on a
+rolling policy. This is useful to prevent individual bucket files from getting
+too big. This is also configurable but the default policy rolls files based on
+file size and a timeout, i.e if no new data was written to a part file.
+
+ Usage
+
+The only required configuration are the base path were we want to output our
+data and an
+[Encoder](http://flink.apache.org/docs/latest/api/java/org/apache/flink/api/common/serialization/Encoder.html)
+that is used for serializing records to the `OutputStream` for each file.
+
+Basic usage thus looks like this:
+
+
+
+
+{% highlight java %}
+DataStream input = ...;
+
+final StreamingFileSink sink = StreamingFileSink
Review comment:
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
