soyrice commented on a change in pull request #11415: [BEAM-9650] Cleanup
documentation on side inputs patterns
URL: https://github.com/apache/beam/pull/11415#discussion_r408998445
##########
File path: website/src/documentation/patterns/side-inputs.md
##########
@@ -46,29 +54,34 @@ For instance, the following code sample uses a `Map` to
create a `DoFn`. The `Ma
{% github_sample
/apache/beam/blob/master/examples/java/src/main/java/org/apache/beam/examples/snippets/Snippets.java
tag:SideInputPatternSlowUpdateGlobalWindowSnip1
%}
```
+```py
+No sample present.
+```
## Slowly updating side input using windowing
-You can read side input pcollection periodically into distinct windows.
-Later, when you apply side input to your main input, windows will be matched
automatically 1:1.
-This way, you can guarantee side input consistency on the duration of the
single window.
-
-To do this, you can utilize PeriodicSequence PTransform that will generate
infinite sequence
-of elements with some real-time period:
-
-1. Use the PeriodicImpulse transform to generate windowed periodic sequence.
-
- a. MAX_TIMESTAMP can be replaced with some closer boundary if you want to
stop generating elements at some point.
-
-1. Read data using Read operation triggered by arrival of PCollection element.
-
+You can read side input data periodically into distinct PCollection windows.
+Later, when you apply the side input to your main input, each main input
+window is automatically matched to a single side input window.
+This guarantees consistency on the duration of the single window,
+meaning that each window on the main input will be matched to a single
+version of side input data.
+
+Implementation of described approach can be narrowed down to:
Review comment:
We should rephrase as "To read side input data periodically:"
The goal is to summarize the previous paragraph, so that it's clear what
these steps refer to without needing to read through the previous paragraph.
The previous paragraph offers additional context, but if a reader skims the
page, they should be able to quickly figure out what these steps are about.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
