Skip to content

docs: deprecate the enableSnappy option in bigtable-beam-import - #4635

Merged
mutianf merged 1 commit into
googleapis:mainfrom
mutianf:deprecate-enable-snappy
Sep 8, 2026
Merged

docs: deprecate the enableSnappy option in bigtable-beam-import#4635
mutianf merged 1 commit into
googleapis:mainfrom
mutianf:deprecate-enable-snappy

Conversation

@mutianf

@mutianf mutianf commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

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:

  • @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

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:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Fixes #<issue_number_goes_here> ☕️

If you write sample code, please follow the samples format.

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
@mutianf
mutianf requested a review from a team as a code owner September 8, 2026 20:34
@product-auto-label product-auto-label Bot added size: m Pull request size is medium. api: bigtable Issues related to the googleapis/java-bigtable-hbase API. labels Sep 8, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

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.

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.

@mutianf
mutianf merged commit 292cfa5 into googleapis:main Sep 8, 2026
17 of 18 checks passed
@mutianf
mutianf deleted the deprecate-enable-snappy branch September 9, 2026 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: bigtable Issues related to the googleapis/java-bigtable-hbase API. size: m Pull request size is medium.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants