Skip to content

Consolidate duplicate ShardedKey implementations in core module#38145

Closed
Eliaaazzz wants to merge 2 commits into
apache:masterfrom
Eliaaazzz:address-37990-shardedkey-consolidation
Closed

Consolidate duplicate ShardedKey implementations in core module#38145
Eliaaazzz wants to merge 2 commits into
apache:masterfrom
Eliaaazzz:address-37990-shardedkey-consolidation

Conversation

@Eliaaazzz

@Eliaaazzz Eliaaazzz commented Apr 11, 2026

Copy link
Copy Markdown
Contributor

Consolidate the two duplicate ShardedKey classes in the Java SDK core module into a single unified implementation. The deprecated org.apache.beam.sdk.values.ShardedKey (already @Deprecated since its introduction) and its internal companion org.apache.beam.sdk.coders.ShardedKeyCoder (@VisibleForTesting) are removed in favor of the single org.apache.beam.sdk.util.ShardedKey.

What changed:

  • Removed org.apache.beam.sdk.values.ShardedKey (deprecated, int-based shard) and org.apache.beam.sdk.coders.ShardedKeyCoder (internal, @VisibleForTesting)
  • Added of(K, int) factory method and getShardNumber() accessor to org.apache.beam.sdk.util.ShardedKey — the int is stored as a 4-byte big-endian byte array and survives coder round-trips
  • Improved toString() to display integer shard number (not raw byte array) for 4-byte shard IDs, preserving log readability
  • Migrated all consumers across core SDK (WriteFiles, ShardingFunction), BigQuery IO (BatchLoads, WriteTables, WritePartition, WriteBundlesToFiles, StreamingWriteTables, GenerateShardedTable), Flink runner, and Spark runner
  • Simplified auto-sharded write paths in WriteFiles and BatchLoads that previously had awkward conversion code between the two ShardedKey types
  • Added tests for int-based shard methods, equality, and coder round-trip
  • Updated CHANGES.md with Breaking Changes entry

Wire format note: The removed ShardedKeyCoder had a different wire format from ShardedKey.Coder (reversed field order, VarInt vs ByteArray shard encoding). ShardedKeyCoder was NOT a Beam standard/model coder — it was @VisibleForTesting and only used transiently within pipeline constructions (GroupByKey, sharding), never for persistent state or checkpoints. The standard model coder (ShardedKey.Coder in sdk.util, registered in ModelCoderRegistrar) is unchanged.

Fixes #37990


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.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 streamlines the Apache Beam Java SDK by consolidating duplicate ShardedKey implementations. By unifying these classes, the change reduces technical debt, eliminates potential confusion regarding shard ID types, and simplifies the auto-sharded write paths in various IO components. The refactoring ensures that existing consumers can continue to use integer-based shard identifiers seamlessly through new helper methods, while improving the overall maintainability of the codebase.

Highlights

  • Consolidation of ShardedKey: Merged the two duplicate ShardedKey implementations into a single, unified class located in the core utility package.
  • API Improvements: Added a new factory method and accessor for integer-based shard numbers to ensure backward compatibility and ease of use.
  • Refactoring and Cleanup: Removed the deprecated ShardedKey and ShardedKeyCoder classes and updated all internal references across the SDK, BigQuery IO, and runners.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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.

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.

@Eliaaazzz Eliaaazzz force-pushed the address-37990-shardedkey-consolidation branch from cf8f823 to 3ea385d Compare April 11, 2026 08:22
Remove the deprecated org.apache.beam.sdk.values.ShardedKey and the
internal (@VisibleForTesting) org.apache.beam.sdk.coders.ShardedKeyCoder,
consolidating into the single org.apache.beam.sdk.util.ShardedKey.

- Add of(K, int) factory and getShardNumber() accessor to util.ShardedKey
  so callers using integer shard numbers migrate without logic changes.
  The int is stored as a 4-byte big-endian byte array and round-trips
  through the Coder.
- toString() displays integer shard number for 4-byte shard IDs instead
  of raw byte array, preserving log readability.
- Migrate all consumers across core SDK, BigQuery IO, WriteFiles,
  ShardingFunction, Flink runner, and Spark runner.
- Simplify auto-sharded write paths in WriteFiles and BatchLoads that
  previously required awkward conversion between the two ShardedKey types.
- Add tests for int-based shard methods and coder round-trip behavior.
- Update CHANGES.md with Breaking Changes entry.

Wire format note: the removed ShardedKeyCoder (sdk.coders) had a
different wire format from ShardedKey.Coder (sdk.util) — reversed field
order and VarInt vs ByteArray shard encoding. ShardedKeyCoder was NOT a
Beam standard/model coder and was only used transiently within pipeline
constructions (GroupByKey, sharding), never for persistent state or
checkpoints. The standard model coder (ShardedKey.Coder) is unchanged.
@Eliaaazzz Eliaaazzz closed this Apr 11, 2026
@Eliaaazzz Eliaaazzz deleted the address-37990-shardedkey-consolidation branch April 11, 2026 08:30
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.

Duplicate ShardedKey implementations in core module

1 participant