-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat(firestore): add DML stages (Insert, Upsert) and atomic execution option to Java SDK pipelines #14040
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
wu-hui
wants to merge
1
commit into
main
Choose a base branch
from
feat-java-pipeline-dml
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+379
−0
Open
feat(firestore): add DML stages (Insert, Upsert) and atomic execution option to Java SDK pipelines #14040
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
78 changes: 78 additions & 0 deletions
78
...ogle-cloud-firestore/src/main/java/com/google/cloud/firestore/pipeline/stages/Insert.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* | ||
| * Copyright 2026 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.cloud.firestore.pipeline.stages; | ||
|
|
||
| import com.google.api.core.BetaApi; | ||
| import com.google.api.core.InternalApi; | ||
| import com.google.cloud.firestore.PipelineUtils; | ||
| import com.google.cloud.firestore.pipeline.expressions.Expression; | ||
| import com.google.firestore.v1.Value; | ||
| import java.util.ArrayList; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| @InternalApi | ||
| public final class Insert extends Stage { | ||
|
|
||
| @Nullable private final String collectionPath; | ||
| @Nullable private final Expression documentIdExpr; | ||
|
|
||
| private Insert( | ||
| @Nullable String collectionPath, | ||
| @Nullable Expression documentIdExpr, | ||
| InternalOptions options) { | ||
| super("insert", buildOptions(collectionPath, documentIdExpr, options)); | ||
| this.collectionPath = collectionPath; | ||
| this.documentIdExpr = documentIdExpr; | ||
| } | ||
|
|
||
| @BetaApi | ||
| public Insert() { | ||
| this(null, null, InternalOptions.EMPTY); | ||
| } | ||
|
|
||
| @BetaApi | ||
| public Insert withCollection(String collectionPath) { | ||
| return new Insert(collectionPath, this.documentIdExpr, this.options); | ||
| } | ||
|
|
||
| @BetaApi | ||
| public Insert withDocumentId(Expression documentIdExpr) { | ||
| return new Insert(this.collectionPath, documentIdExpr, this.options); | ||
| } | ||
|
|
||
| private static InternalOptions buildOptions( | ||
| @Nullable String collectionPath, | ||
| @Nullable Expression documentIdExpr, | ||
| InternalOptions baseOptions) { | ||
| Map<String, Value> optsMap = new HashMap<>(baseOptions.options); | ||
| if (collectionPath != null) { | ||
| String path = collectionPath.startsWith("/") ? collectionPath : "/" + collectionPath; | ||
| optsMap.put("collection", Value.newBuilder().setReferenceValue(path).build()); | ||
| } | ||
| if (documentIdExpr != null) { | ||
| optsMap.put("document_id", PipelineUtils.encodeValue(documentIdExpr)); | ||
| } | ||
| return new InternalOptions(optsMap); | ||
| } | ||
|
|
||
| @Override | ||
| Iterable<Value> toStageArgs() { | ||
| return new ArrayList<>(); | ||
| } | ||
| } |
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
97 changes: 97 additions & 0 deletions
97
...ogle-cloud-firestore/src/main/java/com/google/cloud/firestore/pipeline/stages/Upsert.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| /* | ||
| * Copyright 2026 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.cloud.firestore.pipeline.stages; | ||
|
|
||
| import com.google.api.core.BetaApi; | ||
| import com.google.api.core.InternalApi; | ||
| import com.google.cloud.firestore.PipelineUtils; | ||
| import com.google.cloud.firestore.pipeline.expressions.Expression; | ||
| import com.google.cloud.firestore.pipeline.expressions.Selectable; | ||
| import com.google.firestore.v1.Value; | ||
| import java.util.ArrayList; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| @InternalApi | ||
| public final class Upsert extends Stage { | ||
|
|
||
| @Nullable private final Selectable[] transformedFields; | ||
| @Nullable private final String collectionPath; | ||
| @Nullable private final Expression documentIdExpr; | ||
|
|
||
| private Upsert( | ||
| @Nullable Selectable[] transformedFields, | ||
| @Nullable String collectionPath, | ||
| @Nullable Expression documentIdExpr, | ||
| InternalOptions options) { | ||
| super("upsert", buildOptions(collectionPath, documentIdExpr, options)); | ||
| this.transformedFields = transformedFields; | ||
| this.collectionPath = collectionPath; | ||
| this.documentIdExpr = documentIdExpr; | ||
| } | ||
|
|
||
| @BetaApi | ||
| public Upsert() { | ||
| this(null, null, null, InternalOptions.EMPTY); | ||
| } | ||
|
|
||
| @BetaApi | ||
| public Upsert(Selectable... transformedFields) { | ||
| this(transformedFields, null, null, InternalOptions.EMPTY); | ||
| } | ||
|
|
||
| @BetaApi | ||
| public Upsert withCollection(String collectionPath) { | ||
| return new Upsert(this.transformedFields, collectionPath, this.documentIdExpr, this.options); | ||
| } | ||
|
|
||
| @BetaApi | ||
| public Upsert withDocumentId(Expression documentIdExpr) { | ||
| return new Upsert(this.transformedFields, this.collectionPath, documentIdExpr, this.options); | ||
| } | ||
|
|
||
| private static InternalOptions buildOptions( | ||
| @Nullable String collectionPath, | ||
| @Nullable Expression documentIdExpr, | ||
| InternalOptions baseOptions) { | ||
| Map<String, Value> optsMap = new HashMap<>(baseOptions.options); | ||
| if (collectionPath != null) { | ||
| String path = collectionPath.startsWith("/") ? collectionPath : "/" + collectionPath; | ||
| optsMap.put("collection", Value.newBuilder().setReferenceValue(path).build()); | ||
| } | ||
| if (documentIdExpr != null) { | ||
| optsMap.put("document_id", PipelineUtils.encodeValue(documentIdExpr)); | ||
| } | ||
| return new InternalOptions(optsMap); | ||
| } | ||
|
|
||
| @Override | ||
| Iterable<Value> toStageArgs() { | ||
| List<Value> args = new ArrayList<>(); | ||
| if (transformedFields != null && transformedFields.length > 0) { | ||
| Map<String, Expression> map = PipelineUtils.selectablesToMap(transformedFields); | ||
| Map<String, Value> encodedMap = new HashMap<>(); | ||
| for (Map.Entry<String, Expression> entry : map.entrySet()) { | ||
| encodedMap.put(entry.getKey(), PipelineUtils.encodeValue(entry.getValue())); | ||
| } | ||
| args.add(PipelineUtils.encodeValue(encodedMap)); | ||
| } | ||
| return args; | ||
| } | ||
| } | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The manual loop to encode each entry of the map is redundant.
PipelineUtils.encodeValuerecursively encodes map values, so we can pass theMap<String, Expression>directly toPipelineUtils.encodeValueto simplify the implementation.