You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by "exceptionfactory (via GitHub)" <gi...@apache.org> on 2023/06/28 15:22:36 UTC
[GitHub] [nifi] exceptionfactory commented on a diff in pull request #6918: NIFI-11129 - adding PutMongoBulk processor to use the bulkWrite API
exceptionfactory commented on code in PR #6918:
URL: https://github.com/apache/nifi/pull/6918#discussion_r1245397297
##########
nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/main/java/org/apache/nifi/processors/mongodb/PutMongoBulk.java:
##########
@@ -0,0 +1,353 @@
+/*
+ * 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.nifi.processors.mongodb;
+
+import com.mongodb.WriteConcern;
+import com.mongodb.client.MongoClient;
+import com.mongodb.client.ClientSession;
+import com.mongodb.client.MongoCollection;
+import com.mongodb.client.model.BulkWriteOptions;
+import com.mongodb.client.model.Collation;
+import com.mongodb.client.model.CollationAlternate;
+import com.mongodb.client.model.CollationCaseFirst;
+import com.mongodb.client.model.CollationMaxVariable;
+import com.mongodb.client.model.CollationStrength;
+import com.mongodb.client.model.DeleteManyModel;
+import com.mongodb.client.model.DeleteOneModel;
+import com.mongodb.client.model.DeleteOptions;
+import com.mongodb.client.model.InsertOneModel;
+import com.mongodb.client.model.ReplaceOneModel;
+import com.mongodb.client.model.ReplaceOptions;
+import com.mongodb.client.model.UpdateManyModel;
+import com.mongodb.client.model.UpdateOneModel;
+import com.mongodb.client.model.UpdateOptions;
+import com.mongodb.client.model.WriteModel;
+import org.apache.nifi.annotation.behavior.EventDriven;
+import org.apache.nifi.annotation.behavior.InputRequirement;
+import org.apache.nifi.annotation.behavior.InputRequirement.Requirement;
+import org.apache.nifi.annotation.behavior.SystemResource;
+import org.apache.nifi.annotation.behavior.SystemResourceConsideration;
+import org.apache.nifi.annotation.documentation.CapabilityDescription;
+import org.apache.nifi.annotation.documentation.Tags;
+import org.apache.nifi.components.PropertyDescriptor;
+import org.apache.nifi.expression.ExpressionLanguageScope;
+import org.apache.nifi.flowfile.FlowFile;
+import org.apache.nifi.logging.ComponentLog;
+import org.apache.nifi.processor.ProcessContext;
+import org.apache.nifi.processor.ProcessSession;
+import org.apache.nifi.processor.Relationship;
+import org.apache.nifi.processor.exception.ProcessException;
+import org.apache.nifi.processor.util.StandardValidators;
+import org.apache.nifi.stream.io.StreamUtils;
+import org.bson.BsonArray;
+import org.bson.BsonDocument;
+import org.bson.Document;
+import org.bson.conversions.Bson;
+
+import java.nio.charset.Charset;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+@EventDriven
+@Tags({ "mongodb", "insert", "update", "write", "put", "bulk" })
+@InputRequirement(Requirement.INPUT_REQUIRED)
+@CapabilityDescription("Writes the contents of a FlowFile to MongoDB as bulk-update")
+@SystemResourceConsideration(resource = SystemResource.MEMORY)
+public class PutMongoBulk extends AbstractMongoProcessor {
+ static final Relationship REL_SUCCESS = new Relationship.Builder().name("success")
+ .description("All FlowFiles that are written to MongoDB are routed to this relationship").build();
+ static final Relationship REL_FAILURE = new Relationship.Builder().name("failure")
+ .description("All FlowFiles that cannot be written to MongoDB are routed to this relationship").build();
+
+ static final PropertyDescriptor ORDERED = new PropertyDescriptor.Builder()
+ .name("Ordered")
+ .expressionLanguageSupported(ExpressionLanguageScope.NONE)
+ .description("Ordered execution of bulk-writes & break on error - otherwise arbitrary order & continue on error")
+ .required(false)
+ .addValidator(StandardValidators.BOOLEAN_VALIDATOR)
+ .allowableValues("true", "false")
+ .defaultValue("false")
+ .build();
+
+ static final PropertyDescriptor USE_TRANSACTION = new PropertyDescriptor.Builder()
+ .name("Use transaction")
+ .expressionLanguageSupported(ExpressionLanguageScope.NONE)
+ .description("Run all actions in one MongoDB transaction - does NOT work with a client service so far")
+ .required(false)
+ .addValidator(StandardValidators.BOOLEAN_VALIDATOR)
+ .allowableValues("true", "false")
+ .defaultValue("false")
+ .build();
+
+ static final PropertyDescriptor CHARACTER_SET = new PropertyDescriptor.Builder()
+ .name("Character Set")
+ .description("The Character Set in which the data is encoded")
+ .required(true)
+ .addValidator(StandardValidators.CHARACTER_SET_VALIDATOR)
+ .defaultValue("UTF-8")
+ .build();
+
+ private final static Set<Relationship> relationships;
+ private final static List<PropertyDescriptor> propertyDescriptors;
+
+ static {
+ List<PropertyDescriptor> _propertyDescriptors = new ArrayList<>();
+ _propertyDescriptors.addAll(descriptors);
+ _propertyDescriptors.add(WRITE_CONCERN);
+ _propertyDescriptors.add(ORDERED);
+ _propertyDescriptors.add(USE_TRANSACTION);
+ _propertyDescriptors.add(CHARACTER_SET);
+ propertyDescriptors = Collections.unmodifiableList(_propertyDescriptors);
+
+ final Set<Relationship> _relationships = new HashSet<>();
+ _relationships.add(REL_SUCCESS);
+ _relationships.add(REL_FAILURE);
+ relationships = Collections.unmodifiableSet(_relationships);
+ }
+
+ @Override
+ public Set<Relationship> getRelationships() {
+ return relationships;
+ }
+
+ @Override
+ public List<PropertyDescriptor> getSupportedPropertyDescriptors() {
+ return propertyDescriptors;
+ }
+
+ @Override
+ public void onTrigger(final ProcessContext context, final ProcessSession session) throws ProcessException {
+ final FlowFile flowFile = session.get();
+ if (flowFile == null) {
+ return;
+ }
+
+ final ComponentLog logger = getLogger();
+
+ final Charset charset = Charset.forName(context.getProperty(CHARACTER_SET).getValue());
+ final WriteConcern writeConcern = getWriteConcern(context);
+
+ ClientSession clientSession = null;
+ try {
+ final MongoCollection<Document> collection = getCollection(context, flowFile).withWriteConcern(writeConcern);
+ // Read the contents of the FlowFile into a byte array
+ final byte[] content = new byte[(int) flowFile.getSize()];
+ session.read(flowFile, in -> StreamUtils.fillBuffer(in, content, true));
+
+ // parse
+ final BsonArray updateItems = BsonArray.parse(new String(content, charset));
+
+ List<WriteModel<Document>> updateModels = new ArrayList<>();
+ for (Object item : updateItems) {
+ final BsonDocument updateItem = (BsonDocument) item;
+ if (updateItem.keySet().size() != 1) {
+ logger.error("Invalid bulk-update: more than one type given {}", String.join(", ", updateItem.keySet()));
+ session.transfer(flowFile, REL_FAILURE);
+ context.yield();
+ return;
+ }
+ final String updateType = updateItem.keySet().iterator().next();
+ final BsonDocument updateSpec = (BsonDocument) updateItem.get(updateType);
+ if ("insertOne".equals(updateType)) {
+ final InsertOneModel<Document> insertOneModel = new InsertOneModel<>(toBsonDocument((BsonDocument) updateSpec.get("document")));
+ updateModels.add(insertOneModel);
+ } else if ("updateOne".equals(updateType)) {
+ final UpdateOptions options = parseUpdateOptions(updateSpec);
+ final UpdateOneModel<Document> updateOneModel = new UpdateOneModel<>((BsonDocument) updateSpec.get("filter"), (BsonDocument) updateSpec.get("update"), options);
+ updateModels.add(updateOneModel);
+ } else if ("updateMany".equals(updateType)) {
+ final UpdateOptions options = parseUpdateOptions(updateSpec);
+ final UpdateManyModel<Document> updateManyModel = new UpdateManyModel<>((BsonDocument) updateSpec.get("filter"), (BsonDocument) updateSpec.get("update"), options);
+ updateModels.add(updateManyModel);
+ } else if ("replaceOne".equals(updateType)) {
+ final ReplaceOptions options = parseReplaceOptions(updateSpec);
+ final ReplaceOneModel<Document> replaceOneModel = new ReplaceOneModel<>((BsonDocument) updateSpec.get("filter"),
+ toBsonDocument((BsonDocument) updateSpec.get("replacement")), options);
+ updateModels.add(replaceOneModel);
+ } else if ("deleteOne".equals(updateType)) {
+ final DeleteOptions options = parseDeleteOptions(updateSpec);
+ final DeleteOneModel<Document> deleteOneModel = new DeleteOneModel<>((BsonDocument) updateSpec.get("filter"), options);
+ updateModels.add(deleteOneModel);
+ } else if ("deleteMany".equals(updateType)) {
+ final DeleteOptions options = parseDeleteOptions(updateSpec);
+ final DeleteManyModel<Document> deleteManyModel = new DeleteManyModel<>((BsonDocument) updateSpec.get("filter"), options);
+ updateModels.add(deleteManyModel);
+ } else {
+ logger.error("Invalid bulk-update: invalid update type {}", updateType);
+ session.transfer(flowFile, REL_FAILURE);
+ context.yield();
+ return;
+ }
+ }
+
+ if (context.getProperty(USE_TRANSACTION).asBoolean()) {
+ MongoClient currentMongoClient;
+ if (clientService != null) {
+ // (can still add - if it's ever needed)
+ throw new RuntimeException("Cannot have transactions and use a client service - so far");
+ } else {
+ currentMongoClient = this.mongoClient;
+ }
+ clientSession = currentMongoClient.startSession();
+ clientSession.startTransaction();
+ // now run this w/in a transaction
+ collection.bulkWrite(clientSession, updateModels, (new BulkWriteOptions().ordered(context.getProperty(ORDERED).asBoolean())));
+ } else {
+ collection.bulkWrite(updateModels, (new BulkWriteOptions().ordered(context.getProperty(ORDERED).asBoolean())));
+ }
+ logger.info("bulk-updated {} into MongoDB", flowFile);
+ // (could also return the result again as JSON - mostly not needed afaik)
+
+ session.getProvenanceReporter().send(flowFile, getURI(context));
+ session.transfer(flowFile, REL_SUCCESS);
+
+ if (clientSession != null) {
+ if (clientSession.hasActiveTransaction()) {
+ clientSession.commitTransaction();
+ }
+ clientSession.close();
+ }
+ } catch (Exception e) {
+ logger.error("Failed to bulk-update {} into MongoDB due to {}", new Object[] {flowFile, e}, e);
Review Comment:
The `Object[]` array wrapper is not necessary, and the `due to {}` convention is not necessary either, so it should be removed.
```suggestion
logger.error("Failed to bulk-update {} into MongoDB", flowFile, e);
```
--
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: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org