Skip to content

Only update watermark if the new value is larger than the existing value - #36456

Closed
chenxuesdu wants to merge 5 commits into
apache:masterfrom
chenxuesdu:fixwatermark
Closed

Only update watermark if the new value is larger than the existing value#36456
chenxuesdu wants to merge 5 commits into
apache:masterfrom
chenxuesdu:fixwatermark

Conversation

@chenxuesdu

Copy link
Copy Markdown
Contributor

The updateWatermark is called in
QueryChangeStreamAction.updateWatermarkCallback.This funtion update the watermark in a async way, so the update order is not guaranteed.

Updated the update watermark logic so that we only move the watermark of one partition forward.

Please add a meaningful description for your change here


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

The updateWatermark is called in
QueryChangeStreamAction.updateWatermarkCallback.This funtion update the
watermark in a async way, so the update order is not guaranteed.

Updated the update watermark logic so that we only move the watermark of
one partition forward.
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @chenxuesdu, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the reliability of watermark management within the Spanner Change Streams connector. By introducing a conditional update mechanism, it guarantees that partition watermarks only advance forward, mitigating issues that could arise from asynchronous updates being processed out of sequence. This ensures data processing integrity and consistent progress tracking.

Highlights

  • Watermark Update Logic: The updateWatermark method in PartitionMetadataDao now only updates a partition's watermark if the new timestamp is strictly greater than the existing one.
  • Asynchronous Update Safety: This change prevents watermarks from moving backward due to out-of-order asynchronous updates, ensuring monotonic progress in data processing.
  • Partition Existence Check: Added a null check for the partition object before attempting to update its watermark, logging a debug message if the partition is not found.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

*/
public Void updateWatermark(String partitionToken, Timestamp watermark) {
transaction.buffer(createUpdateMetadataWatermarkMutationFrom(partitionToken, watermark));
final Struct partition = getPartition(partitionToken);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be further optimized by only read watermark column, not the whole partition.
partitionToken is the key, maybe have a function getWatermark(partitionToken). Thanks.

@github-actions

github-actions Bot commented Oct 9, 2025

Copy link
Copy Markdown
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

transaction.buffer(createUpdateMetadataWatermarkMutationFrom(partitionToken, watermark));
final Struct partition = getPartition(partitionToken);
if (partition == null) {
LOG.debug("Partiton {} cannot find.", partitionToken);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "cannot be found"

return null;
}
final Timestamp currentWatermark = partition.getTimestamp(COLUMN_WATERMARK);
if (watermark.compareTo(currentWatermark) > 0) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where does this compare to run (since it's not part of the transaction)? Does it happen atomically along with the read and write? Or are we getting a snapshot, comparing it on the user worker and then writing the value? I'm asking because we need to make sure that if two different processes are trying to update the watermark for the same partition they won't race with each other.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This compare happens transaction. The function updatewermark is in transaction:
public void updateWatermark(String partitionToken, Timestamp watermark) {
runInTransaction(
transaction -> transaction.updateWatermark(partitionToken, watermark), "updateWatermark");
}

chenxuesdu and others added 3 commits October 9, 2025 15:04
The updateWatermark is called in
QueryChangeStreamAction.updateWatermarkCallback.This funtion update the watermark in a async way, so the update order is not guaranteed.

Updated the update watermark logic so that we only move the watermark of one partition forward.
@jiangzzhu

Copy link
Copy Markdown
Contributor

@acrites and @tianz101 , please review #36463 instead. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants