Expose Public API for Iceberg Side Input Cache by jrmccluskey · Pull Request #40140 · apache/beam

jrmccluskey · 2026-09-16T17:39:27Z

Exposes the public API for use of the iceberg side input caching pattern, adds relevant unit and integration testing.

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)

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

codecov · 2026-09-16T18:45:05Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 58.42%. Comparing base (bdf650a) to head (f08a2ba).
⚠️ Report is 15 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff              @@
##             master   #40140      +/-   ##
============================================
+ Coverage     55.09%   58.42%   +3.33%     
- Complexity     1722    13592   +11870     
============================================
  Files          1076     2577    +1501     
  Lines        171812   269247   +97435     
  Branches       1262    11076    +9814     
============================================
+ Hits          94652   157314   +62662     
- Misses        74891   105982   +31091     
- Partials       2269     5951    +3682

Flag	Coverage Δ
java	`64.60% <ø> (-3.09%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions · 2026-09-17T14:17:42Z

Assigning reviewers:

R: @chamikaramj for label java.
R: @ahmedabu98 for label iceberg.

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

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).

…erg/IcebergIO.java Co-authored-by: Ahmed Abualsaud <65791736+ahmedabu98@users.noreply.github.com>

ahmedabu98 · 2026-09-17T17:02:36Z

      }

+      PCollectionView<Map<String, SerializableTableSpec>> metadataView = null;
+      if (getUsingSideInputTableCache()) {


Can we also throw if the sub-options are set without side-input enabled?

ahmedabu98 · 2026-09-21T15:27:13Z

+            .apply(
+                "EvolveSchemaMidExecution",
+                ParDo.of(new EvolveSchemaMidExecutionDoFn(catalogConfig, tableId.toString())))
+            .setRowSchema(v2BeamSchema);


This updates the table before the record reaches the sink or the metadata view step, so TableMetadataDriver's first poll is still after the update happens.

We'd need an initial record to pass through, then a second record that triggers the update.

ahmedabu98 · 2026-09-21T15:27:17Z

+      if (table.schema().findField("city") == null) {
+        table.updateSchema().addColumn("city", Types.StringType.get()).commit();
+      }


I'm realizing we can't really use schema evolution to prove this because PCollection schemas are fixed. We won't be able to test with two different rows

We can use partition spec evolution (e.g. table.updateSpec().addField("city").commit();). And validate after the pipeline runs by loading the table and verifying that:

two DataFiles were written (one for each row)

the first DataFile has the old spec (unpartitioned)

the second DataFile has the new spec (e.g. "city")

Can use this to check added files:
SnapshotChanges.builderFor(table).build().addedDataFiles();

Okay I think that's updated correctly

ahmedabu98

LGTM, thanks!

…#40248) * Expose Public API for Iceberg Side Input Cache (#40140) * Expose Public API for Iceberg Side Input Cache * Update sdks/java/io/iceberg/src/main/java/org/apache/beam/sdk/io/iceberg/IcebergIO.java Co-authored-by: Ahmed Abualsaud <65791736+ahmedabu98@users.noreply.github.com> * Streamline API, remove redundant checks * Check polled table metric * Evolve Iceberg schema mid-execution in streaming side input cache test * Throw if sub-options are enabled without side input cache enabled * test with partition spec evolution --------- Co-authored-by: Ahmed Abualsaud <65791736+ahmedabu98@users.noreply.github.com> * Address wrap-up items for Iceberg side input table cache (#40222) * Address wrap-up items for Iceberg side input table cache - Bind historical sort orders unchecked via SortOrderParser.fromJson(schema, node, getOrderId()) in SerializableTableSpec. - Expose Hadoop Configuration via IcebergCatalogConfig.getHadoopConfiguration() and propagate to SerializableTableSpec.getFileIO(conf) through SideInputTable in write transforms. - Add worker-local transient Guava cache to ExtractTableIdsDoFn to eliminate hot-key shuffle bottlenecks on streaming writes. - Add comprehensive unit and integration tests. * Propagate Clock to ExtractTableIdsDoFn for deterministic cache expiration in tests - Ensure TableMetadataDriver passes its Clock to ExtractTableIdsDoFn so virtual-time advancement in tests (e.g. testUnusedTablesEvictedFromStreamingCache) correctly expires worker-local table ID caches instead of using wall-clock time. - Fixes testUnusedTablesEvictedFromStreamingCache flakiness on CI environments with limited concurrency. * Make streaming refresh and spec evolution tests robust against worker cache TTL - Advance ControllableTestClock on trigger rows in testMetadataRefreshedAcrossIntervals, testMetadataRefreshedAcrossIntervalsAsSideInput, and testMetadataRefreshedAcrossIntervalsAsSideInputWithMultipleTables so worker-local table ID caches expire as intended across virtual intervals. - In testStreamingSpecEvolutionWithoutPipelineRestart, wait for the worker-local cache TTL (500ms) to elapse after spec evolution before emitting the second element. * Declare jackson-databind dependency in Iceberg IO module - Add library.java.jackson_databind to dependencies in sdks/java/io/iceberg/build.gradle to resolve usedUndeclaredArtifacts dependency analysis warning caused by JsonNode usage in SerializableTableSpec. * Avoid potential flakes in EvolveSpec DoFn, address nits * Simplify worker-local cache in TableMetadataDriver using LinkedHashMap LRU - Replace Guava Cache, CacheBuilder, and Ticker in ExtractTableIdsDoFn with a standard LinkedHashMap-based LRU cache capped at 10,000 entries. - Track lastEmitted timestamp per table identifier and emit when (now - lastEmitted) >= refreshInterval / 2. - Remove getClock() and setClock() from TableMetadataDriver and its Builder to keep the AutoValue API clean and free of testing methods. - Provide testing hooks via static globalTestClock and instance setClock on ExtractTableIdsDoFn. * simplify dofn + fix unit test --------- Co-authored-by: Ahmed Abualsaud <65791736+ahmedabu98@users.noreply.github.com>

Expose Public API for Iceberg Side Input Cache

f08a2ba

github-actions Bot added java io iceberg Iceberg IO connector labels Sep 16, 2026

jrmccluskey requested a review from ahmedabu98 September 16, 2026 18:49

ahmedabu98 reviewed Sep 17, 2026

View reviewed changes

github-actions Bot added the Next Action: Reviewers label Sep 17, 2026

jrmccluskey and others added 4 commits September 17, 2026 10:20

Update sdks/java/io/iceberg/src/main/java/org/apache/beam/sdk/io/iceb…

b4fe590

…erg/IcebergIO.java Co-authored-by: Ahmed Abualsaud <65791736+ahmedabu98@users.noreply.github.com>

Streamline API, remove redundant checks

ec7e951

Check polled table metric

71b2a61

Evolve Iceberg schema mid-execution in streaming side input cache test

5294cf3

ahmedabu98 reviewed Sep 21, 2026

View reviewed changes

jrmccluskey added 2 commits September 21, 2026 16:06

Throw if sub-options are enabled without side input cache enabled

9ec64da

test with partition spec evolution

bf90988

ahmedabu98 approved these changes Sep 21, 2026

View reviewed changes

jrmccluskey merged commit 9dbf3e7 into apache:master Sep 21, 2026
20 checks passed

jrmccluskey mentioned this pull request Sep 23, 2026

[Cherry-pick][#39723] Iceberg Side Input Cache Public API and Wrap-Up #40248

Merged

3 tasks

Navigation Menu

Repository navigation

Expose Public API for Iceberg Side Input Cache - #40140

Expose Public API for Iceberg Side Input Cache#40140
jrmccluskey merged 7 commits into
apache:masterfrom
jrmccluskey:feat/iceberg-side-input-table-cache-pr4

jrmccluskey commented Sep 16, 2026 •

edited

Loading

Uh oh!

codecov Bot commented Sep 16, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Sep 17, 2026

Uh oh!

ahmedabu98 Sep 17, 2026

Uh oh!

ahmedabu98 Sep 21, 2026

Uh oh!

ahmedabu98 Sep 21, 2026

Uh oh!

jrmccluskey Sep 21, 2026

Uh oh!

ahmedabu98 left a comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

jrmccluskey commented Sep 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

GitHub Actions Tests Status (on master branch)

Uh oh!

codecov Bot commented Sep 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Sep 17, 2026

Uh oh!

ahmedabu98 Sep 17, 2026

Choose a reason for hiding this comment

Uh oh!

ahmedabu98 Sep 21, 2026

Choose a reason for hiding this comment

Uh oh!

ahmedabu98 Sep 21, 2026

Choose a reason for hiding this comment

Uh oh!

jrmccluskey Sep 21, 2026

Choose a reason for hiding this comment

Uh oh!

ahmedabu98 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jrmccluskey commented Sep 16, 2026 •

edited

Loading

codecov Bot commented Sep 16, 2026 •

edited

Loading