pabloem commented on a change in pull request #14927: URL: https://github.com/apache/beam/pull/14927#discussion_r699560818
########## File path: sdks/java/io/mongodb/src/main/java/org/apache/beam/sdk/io/mongodb/UpdateField.java ########## @@ -0,0 +1,69 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.beam.sdk.io.mongodb; + +import com.google.auto.value.AutoValue; +import java.io.Serializable; +import org.apache.beam.sdk.annotations.Experimental; +import org.apache.beam.sdk.annotations.Experimental.Kind; +import org.checkerframework.checker.nullness.qual.Nullable; + +@Experimental(Kind.SOURCE_SINK) +@AutoValue +public abstract class UpdateField implements Serializable { + + abstract @Nullable String updateOperator(); + + abstract @Nullable String sourceField(); + + abstract @Nullable String destField(); + + private static Builder builder() { + return new AutoValue_UpdateField.Builder().setSourceField(null); + } + + abstract UpdateField.Builder toBuilder(); + + public static UpdateField create() { + return builder().build(); + } Review comment: This initial constructor creates an `UpdateField` object that is not valid, right? Doesn't it make sense to make this method private, and then make `fullUpdate` and `fieldUpdate` static constructor methods? ########## File path: sdks/java/io/mongodb/src/main/java/org/apache/beam/sdk/io/mongodb/UpdateConfiguration.java ########## @@ -0,0 +1,82 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.beam.sdk.io.mongodb; + +import com.google.auto.value.AutoValue; +import java.io.Serializable; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import org.apache.beam.sdk.annotations.Experimental; +import org.apache.beam.sdk.annotations.Experimental.Kind; +import org.checkerframework.checker.nullness.qual.Nullable; + +/** Builds a MongoDB UpdateConfiguration object. */ +@Experimental(Kind.SOURCE_SINK) +@AutoValue +@SuppressWarnings({ + "nullness" // TODO(https://issues.apache.org/jira/browse/BEAM-10402) +}) +public abstract class UpdateConfiguration implements Serializable { + + abstract @Nullable String updateKey(); Review comment: can we have more than one field as a key? ########## File path: sdks/java/io/mongodb/src/main/java/org/apache/beam/sdk/io/mongodb/MongoDbIO.java ########## @@ -106,6 +112,27 @@ * .withNumSplits(30)) * * }</pre> + * + * * + * + * <p>To configure a MongoDB sink and update, you must specify a connection {@code URI}, a {@code + * Database} * name, a {@code Collection} name. It matches the key with _id in target collection. + * For instance: * * + * + * <pre>{@code + * * pipeline + * * .apply(...) + * * .apply(MongoDbIO.write() + * * .withUri("mongodb://localhost:27017") + * * .withDatabase("my-database") + * * .withCollection("my-collection") + * * .withUpdateConfiguration(UpdateConfiguration.create().withUpdateKey("key1") + * * .withUpdateFields(UpdateField.of("$set", "source-field1", "dest-field1"), + * * UpdateField.of("$set","source-field2", "dest-field2"), + * * //pushes entire input doc to the dest field + * * UpdateField.of("$push", "dest-field3") ))); Review comment: we're going to have to update the Javadoc herer to match the final API ########## File path: sdks/java/io/mongodb/src/main/java/org/apache/beam/sdk/io/mongodb/UpdateField.java ########## @@ -0,0 +1,69 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.beam.sdk.io.mongodb; + +import com.google.auto.value.AutoValue; +import java.io.Serializable; +import org.apache.beam.sdk.annotations.Experimental; +import org.apache.beam.sdk.annotations.Experimental.Kind; +import org.checkerframework.checker.nullness.qual.Nullable; + +@Experimental(Kind.SOURCE_SINK) +@AutoValue +public abstract class UpdateField implements Serializable { + + abstract @Nullable String updateOperator(); + + abstract @Nullable String sourceField(); + + abstract @Nullable String destField(); + + private static Builder builder() { + return new AutoValue_UpdateField.Builder().setSourceField(null); + } + + abstract UpdateField.Builder toBuilder(); + + public static UpdateField create() { + return builder().build(); + } + + @AutoValue.Builder + abstract static class Builder { + abstract UpdateField.Builder setUpdateOperator(@Nullable String updateOperator); + + abstract UpdateField.Builder setSourceField(@Nullable String sourceField); + + abstract UpdateField.Builder setDestField(@Nullable String destField); + + abstract UpdateField build(); + } + + /** Sets the limit of documents to find. */ + public UpdateField fullUpdate(String updateOperator, String destField) { + return toBuilder().setUpdateOperator(updateOperator).setDestField(destField).build(); + } Review comment: In this case, we're inserting the full record into one field of the destination, right? e.g.: original ``` { "key": "mykey1", "value1": "myvalue1", "value2": ["1", "2"], "value3": "thisvalue" } ``` newvalue ``` { "key": "mykey1", "value1": "myvalue1UPD", "value2": ["1", "2", "3", "4"], "value3": "thisvalueISUPDATED" } ``` Given configuration `UpdateField.fullUpdate("$push", "value4")`: result ``` { "key": "mykey1", "value1": "myvalue1", "value2": ["1", "2"], "value3": "thisvalue" "value4": { "key": "mykey1", "value1": "myvalue1UPD", "value2": ["1", "2", "3", "4"], "value3": "thisvalueISUPDATED" } } ``` Is this correct / intended? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
