Skip to content
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

Initial commit of boilerplate of change stream pipeline for bigtable #25153

Merged
merged 1 commit into from
Jan 26, 2023

Conversation

tonytanger
Copy link
Contributor

Adding the skeleton of the change stream pipeline of Google Cloud Bigtable. The logic is similar to that of Cloud Spanner's change stream connector.

Pipeline contains 3 steps

  • InitializeDoFn - Responsible to validating preconditions such as creating metadata table, ensuring options are valid and correct, and determine a valid start time for the pipeline.
  • DetectNewPartitionsDoFn - Manages the lifecycles of partitions being streamed. This includes initially outputting the initial list of partitions to be streamed, and as partitions split and merge, create new partitions to be streamed. DetectNewPartitions is also responsible to ensure all partitions are streamed and non are missing and keep track of the watermark of the entire pipeline.
  • ReadChangeStreamPartitionDoFn - Streams individual partitions and output data changes. It also handles termination, whether that's the end of the pipeline termination, or the partition has split or merged so it no longer exists.

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.

@tonytanger tonytanger marked this pull request as ready for review January 25, 2023 18:29
@github-actions
Copy link
Contributor

Assigning reviewers. If you would like to opt out of this review, comment assign to next reviewer:

R: @lukecwik for label java.
R: @Abacn for label io.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

* generated string.
* </ul>
*/
@Experimental
Copy link
Member

Choose a reason for hiding this comment

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

thanks for the good docs here. Do you think it makes sense to add some more documentation strings to the header of this file? e.g. links to how to start a changestream, the sort of data the transform outputs, the expected throughput, how to use with Beam schema (if supported), etc?

happy to leave for next PR, but I think it will be important.

@pabloem pabloem merged commit f565a94 into apache:master Jan 26, 2023
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.

2 participants