Skip to content

normalize firestoreIO - #39941

Open
aIbrahiim wants to merge 2 commits into
apache:masterfrom
aIbrahiim:normalize-firestore
Open

normalize firestoreIO#39941
aIbrahiim wants to merge 2 commits into
apache:masterfrom
aIbrahiim:normalize-firestore

Conversation

@aIbrahiim

@aIbrahiim aIbrahiim commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Adds Java SchemaTransform providers for Firestore read and write so Firestore can be used from Beam YAML

Read (firestore_read:v1) lists documents from a collection and outputs Beam Rows using a JSON schema. Write (firestore_write:v1) takes Rows and upserts them with batchWrite. FirestoreUtils handles document toRow conversion, with config classes for both sides.

Registers ReadFromFirestore and WriteToFirestore in standard_io.yaml, pointing at the GCP expansion service jar.

Unit tests: FirestoreSchemaTransformProviderTest and FirestoreUtilsTest.

I validated locally:

./gradlew :sdks:java:io:google-cloud-platform:test \
  --tests "org.apache.beam.sdk.io.gcp.firestore.FirestoreSchemaTransformProviderTest" \
  --tests "org.apache.beam.sdk.io.gcp.firestore.FirestoreUtilsTest" 

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.

@Abacn

Abacn commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Same as other IOs, we should be able to add a basic integration test (e.g. in extended tests), one can use 'firestoredb' as default firestore database, like other tests did

def firestoreDb = project.findProperty('firestoreDb') ?: 'firestoredb'

@aIbrahiim

Copy link
Copy Markdown
Contributor Author

Run Yaml_Xlang_Direct PostCommit databases

@aIbrahiim

Copy link
Copy Markdown
Contributor Author

cc: @Abacn

Comment thread sdks/python/setup.py
@@ -535,6 +535,7 @@ def get_portability_package_data():
# errors raised during async flushes instead of swallowing them.
'google-cloud-bigtable>=2.42.0,<3',
'google-cloud-build>=3.35.0,<4',
'google-cloud-firestore>=2.0.0,<3',

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.

This is only used in tests. Consider put it into 'test' extra and make the import optional in integration_tests.py

@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Assigning reviewers:

R: @shunping for label python.
R: @Abacn for label java.

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

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