-
Notifications
You must be signed in to change notification settings - Fork 14.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentation for Dataflow operators #46954
Open
VladaZakharova
wants to merge
1
commit into
apache:main
Choose a base branch
from
VladaZakharova:dataflow-doc-fix
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
+14
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sunank200
reviewed
Feb 21, 2025
Comment on lines
+349
to
+359
After being created, streaming pipeline can not be updated, because once a streaming job is running, its configuration | ||
is immutable. To apply any changes, you must modify the pipeline's definition (e.g., update your code or template) | ||
and then submit a new job. Essentially, you're creating a new instance of the pipeline with the desired updates. | ||
|
||
For batch pipelines, if the job is running and you want to update its configuration, you must cancel it because | ||
Dataflow jobs are immutable once they've started. Even though batch pipelines are designed to process finite data and | ||
eventually finish on their own, you cannot update a running job. If you decide to change any parameters or the | ||
pipeline logic while it's in progress, you need to cancel the current run and then launch a new job with the updated | ||
configuration. | ||
If the batch pipeline has already finished normally, then there's no running job to update—the new configuration | ||
would only apply to the next job submission. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
After being created, streaming pipeline can not be updated, because once a streaming job is running, its configuration | |
is immutable. To apply any changes, you must modify the pipeline's definition (e.g., update your code or template) | |
and then submit a new job. Essentially, you're creating a new instance of the pipeline with the desired updates. | |
For batch pipelines, if the job is running and you want to update its configuration, you must cancel it because | |
Dataflow jobs are immutable once they've started. Even though batch pipelines are designed to process finite data and | |
eventually finish on their own, you cannot update a running job. If you decide to change any parameters or the | |
pipeline logic while it's in progress, you need to cancel the current run and then launch a new job with the updated | |
configuration. | |
If the batch pipeline has already finished normally, then there's no running job to update—the new configuration | |
would only apply to the next job submission. | |
Once a streaming pipeline has been created and is running, its configuration cannot be changed because it is immutable. To make any modifications, you need to update the pipeline's definition (e.g., update your code or template), and then submit a new job.Essentially, you'll be creating a new instance of the pipeline with the desired updates. | |
For batch pipelines, if a job is currently running and you want to update its configuration, you must cancel the job. This is because once a Dataflow job has started, it becomes immutable. Although batch pipelines are designed to process a finite amount of data and will eventually be completed on their own, you cannot update a job that is in progress. If you need to change any parameters or the pipeline logic while the job is running, you will have to cancel the current run and then launch a new job with the updated configuration. | |
If the batch pipeline has already been completed successfully, then there is no running job to update; the new configuration will only be applied to the next job submission. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds description about the way to update pipelines in Dataflow.
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rst
or{issue_number}.significant.rst
, in newsfragments.