docs: deprecate the enableSnappy option in bigtable-beam-import - #4635
Merged
Conversation
The flag has been a no-op since googleapis#4338 (released in 2.14.0), which moved the import job to HBase 2.x / Hadoop 3. Its only effect was swapping in a custom SDK container image and enabling use_runner_v2 so that workers could decompress Snappy; that block was deleted in googleapis#4338 and nothing has read getEnableSnappy() since. Snappy compressed snapshots are now read natively. Mark the option deprecated rather than removing it so existing invocations keep working: - @deprecated on the getter/setter, and the --help description now says the option is ignored. - Log a warning when --enableSnappy=true is passed so it is not silently dropped. - README: collapse the duplicated "Snappy compressed Snapshots" command block (identical to the preferred method except for the flag) into a note that no extra configuration is needed, plus a deprecation warning. - SNAPSHOT_IMPORT_USAGE.md: mark ENABLE_SNAPPY deprecated. - run-snapshot-import.sh: stop passing --enableSnappy; warn if ENABLE_SNAPPY is set in the environment. - EndToEndIT: drop the setEnableSnappy(true) call; the test still imports the snappy snapshot. Change-Id: I7113f112309c7813fba7cc0d7c9b73401029d620
Contributor
There was a problem hiding this comment.
Code Review
This pull request deprecates the enableSnappy flag and ENABLE_SNAPPY environment variable across the Bigtable Beam import tool, including documentation, scripts, and Java code. Since the import job now runs on HBase 2.x / Hadoop 3, Snappy compressed snapshots are supported natively without extra configuration. The flag is now ignored and triggers a warning if set. I have no feedback to provide.
vermas2012
approved these changes
Sep 8, 2026
This file contains hidden or 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
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.
The flag has been a no-op since #4338 (released in 2.14.0), which moved the import job to HBase 2.x / Hadoop 3. Its only effect was swapping in a custom SDK container image and enabling use_runner_v2 so that workers could decompress Snappy; that block was deleted in #4338 and nothing has read getEnableSnappy() since. Snappy compressed snapshots are now read natively.
Mark the option deprecated rather than removing it so existing invocations keep working:
Change-Id: I7113f112309c7813fba7cc0d7c9b73401029d620
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #<issue_number_goes_here> ☕️
If you write sample code, please follow the samples format.