jfrazee commented on a change in pull request #4253: URL: https://github.com/apache/nifi/pull/4253#discussion_r510490268
########## File path: nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/cosmos/document/PutAzureCosmosDBRecord.java ########## @@ -0,0 +1,217 @@ +/* + * 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.azure.cosmos.document; + +import java.io.IOException; +import java.io.InputStream; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.UUID; + +import com.azure.cosmos.CosmosContainer; +import com.azure.cosmos.CosmosException; +import com.azure.cosmos.implementation.ConflictException; + +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.AllowableValue; +import org.apache.nifi.components.PropertyDescriptor; +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.schema.access.SchemaNotFoundException; +import org.apache.nifi.serialization.MalformedRecordException; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.record.Record; +import org.apache.nifi.serialization.record.RecordFieldType; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.util.DataTypeUtils; + +@EventDriven +@Tags({ "azure", "cosmos", "insert", "record", "put" }) +@InputRequirement(Requirement.INPUT_REQUIRED) +@CapabilityDescription("This processor is a record-aware processor for inserting data into Cosmos DB with Core SQL API. It uses a configured record reader and " + + "schema to read an incoming record set from the body of a Flowfile and then inserts those records into " + + "a configured Cosmos DB Container.") +@SystemResourceConsideration(resource = SystemResource.MEMORY) +public class PutAzureCosmosDBRecord extends AbstractAzureCosmosDBProcessor { + + private String conflictHandlingStrategy; + static final AllowableValue IGNORE_CONFLICT = new AllowableValue("ignore", "Ignore", "Conflicting records will not be inserted, and FlowFile will not be routed to failure"); + static final AllowableValue UPSERT_CONFLICT = new AllowableValue("upsert", "Upsert", "Conflicting records will be upserted, and FlowFile will not be routed to failure"); + + static final PropertyDescriptor RECORD_READER_FACTORY = new PropertyDescriptor.Builder() + .name("record-reader") + .displayName("Record Reader") + .description("Specifies the Controller Service to use for parsing incoming data and determining the data's schema") + .identifiesControllerService(RecordReaderFactory.class) + .required(true) + .build(); + + static final PropertyDescriptor INSERT_BATCH_SIZE = new PropertyDescriptor.Builder() + .name("insert-batch-size") + .displayName("Insert Batch Size") + .description("The number of records to group together for one single insert operation against Cosmos DB") + .defaultValue("20") + .required(false) + .addValidator(StandardValidators.POSITIVE_INTEGER_VALIDATOR) + .build(); + + static final PropertyDescriptor CONFLICT_HANDLE_STRATEGY = new PropertyDescriptor.Builder() + .name("azure-cosmos-conflict-handling-strategy") + .displayName("Cosmos DB Conflict Handling Strategy") + .description("Choose whether to ignore or upsert when conflict error occurs during insertion") + .required(false) + .allowableValues(IGNORE_CONFLICT, UPSERT_CONFLICT) + .defaultValue(IGNORE_CONFLICT.getValue()) + .addValidator(StandardValidators.NON_BLANK_VALIDATOR) + .build(); + + + private final static Set<Relationship> relationships; + private final static List<PropertyDescriptor> propertyDescriptors; + + static { + List<PropertyDescriptor> _propertyDescriptors = new ArrayList<>(); + _propertyDescriptors.addAll(descriptors); + _propertyDescriptors.add(RECORD_READER_FACTORY); + _propertyDescriptors.add(INSERT_BATCH_SIZE); + _propertyDescriptors.add(CONFLICT_HANDLE_STRATEGY); + 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; + } + + protected void bulkInsert(final List<Map<String, Object>> records) throws CosmosException{ + // In the future, this method will be replaced by calling createItems API + // for example, this.container.createItems(records); + // currently, no createItems API available in Azure Cosmos Java SDK + final ComponentLog logger = getLogger(); + final CosmosContainer container = getContainer(); + for (Map<String, Object> record : records){ + try { + container.createItem(record); + } catch (ConflictException e) { + // insert with unique id is expected. In case conflict occurs, use the selected strategy. + // By default, it will ignore. + if (conflictHandlingStrategy != null && conflictHandlingStrategy.equals(UPSERT_CONFLICT.getValue())){ + container.upsertItem(record); + } else { + if (logger.isDebugEnabled()) { + logger.debug("Ignoring duplicate based on selected conflict resolution strategy"); + } + } + } + } + } + + @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 RecordReaderFactory recordParserFactory = context.getProperty(RECORD_READER_FACTORY) + .asControllerService(RecordReaderFactory.class); + + final String partitionKeyField = context.getProperty(PARTITION_KEY).getValue(); + List<Map<String, Object>> batch = new ArrayList<>(); + int ceiling = context.getProperty(INSERT_BATCH_SIZE).asInteger(); + boolean error = false; + try (final InputStream inStream = session.read(flowFile); + final RecordReader reader = recordParserFactory.createRecordReader(flowFile, inStream, getLogger())) { + + RecordSchema schema = reader.getSchema(); + Record record; + + while ((record = reader.nextRecord()) != null) { + // Convert each Record to HashMap + Map<String, Object> contentMap = (Map<String, Object>) DataTypeUtils.convertRecordFieldtoObject(record, RecordFieldType.RECORD.getRecordDataType(schema)); + if(contentMap.containsKey("id")) { + Object val = contentMap.get("id"); + if (val == null) { + // dont put null to id + contentMap.put("id", UUID.randomUUID().toString()); + } else if (!(val instanceof String)) { + contentMap.put("id", contentMap.get("id").toString()); + } + } + if (!contentMap.containsKey(partitionKeyField)) { + // We set partition key field value with flowfile.uuid if not exists + contentMap.put(partitionKeyField, flowFile.getAttribute("uuid")); Review comment: I think this should be an error. * This could change the type of the field creating a data quality problem; e.g., suppose `partitionKeyField` is supposed to be a location, this populates that with a UUID. * Additionally, this is the FlowFile UUID so for FlowFiles with a large number of records it's not going to partition well. ########## File path: nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/services/azure/cosmos/document/AzureCosmosDBConnectionControllerService.java ########## @@ -0,0 +1,163 @@ +/* + * 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.services.azure.cosmos.document; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; + +import com.azure.cosmos.ConsistencyLevel; +import com.azure.cosmos.CosmosClient; +import com.azure.cosmos.CosmosClientBuilder; +import com.azure.cosmos.CosmosException; + +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.annotation.lifecycle.OnEnabled; +import org.apache.nifi.annotation.lifecycle.OnStopped; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.components.ValidationContext; +import org.apache.nifi.components.ValidationResult; +import org.apache.nifi.controller.AbstractControllerService; +import org.apache.nifi.controller.ConfigurationContext; +import org.apache.nifi.processors.azure.cosmos.document.AzureCosmosDBUtils; +import org.apache.nifi.services.azure.cosmos.AzureCosmosDBConnectionService; +import org.apache.nifi.util.StringUtils; + +@Tags({"azure", "cosmos", "document", "service"}) +@CapabilityDescription( + "Provides a controller service that configures a connection to Cosmos DB (Core SQL API) " + + " and provides access to that connection to other Cosmos DB-related components." +) +public class AzureCosmosDBConnectionControllerService extends AbstractControllerService implements AzureCosmosDBConnectionService { Review comment: Hey, sorry, I missed something going through this. The naming convention for controller services like this is `*ClientService`, so we need `AzureCosmosDBConnectionControllerService` => `AzureCosmosDBClientService`. ```suggestion public class AzureCosmosDBClientService extends AbstractControllerService implements AzureCosmosDBClientControllerService { ``` ########## File path: nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/cosmos/document/PutAzureCosmosDBRecord.java ########## @@ -0,0 +1,217 @@ +/* + * 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.azure.cosmos.document; + +import java.io.IOException; +import java.io.InputStream; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.UUID; + +import com.azure.cosmos.CosmosContainer; +import com.azure.cosmos.CosmosException; +import com.azure.cosmos.implementation.ConflictException; + +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.AllowableValue; +import org.apache.nifi.components.PropertyDescriptor; +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.schema.access.SchemaNotFoundException; +import org.apache.nifi.serialization.MalformedRecordException; +import org.apache.nifi.serialization.RecordReader; +import org.apache.nifi.serialization.RecordReaderFactory; +import org.apache.nifi.serialization.record.Record; +import org.apache.nifi.serialization.record.RecordFieldType; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.util.DataTypeUtils; + +@EventDriven +@Tags({ "azure", "cosmos", "insert", "record", "put" }) +@InputRequirement(Requirement.INPUT_REQUIRED) +@CapabilityDescription("This processor is a record-aware processor for inserting data into Cosmos DB with Core SQL API. It uses a configured record reader and " + + "schema to read an incoming record set from the body of a Flowfile and then inserts those records into " + + "a configured Cosmos DB Container.") +@SystemResourceConsideration(resource = SystemResource.MEMORY) +public class PutAzureCosmosDBRecord extends AbstractAzureCosmosDBProcessor { + + private String conflictHandlingStrategy; + static final AllowableValue IGNORE_CONFLICT = new AllowableValue("ignore", "Ignore", "Conflicting records will not be inserted, and FlowFile will not be routed to failure"); + static final AllowableValue UPSERT_CONFLICT = new AllowableValue("upsert", "Upsert", "Conflicting records will be upserted, and FlowFile will not be routed to failure"); + + static final PropertyDescriptor RECORD_READER_FACTORY = new PropertyDescriptor.Builder() + .name("record-reader") + .displayName("Record Reader") + .description("Specifies the Controller Service to use for parsing incoming data and determining the data's schema") + .identifiesControllerService(RecordReaderFactory.class) + .required(true) + .build(); + + static final PropertyDescriptor INSERT_BATCH_SIZE = new PropertyDescriptor.Builder() + .name("insert-batch-size") + .displayName("Insert Batch Size") + .description("The number of records to group together for one single insert operation against Cosmos DB") + .defaultValue("20") + .required(false) + .addValidator(StandardValidators.POSITIVE_INTEGER_VALIDATOR) + .build(); + + static final PropertyDescriptor CONFLICT_HANDLE_STRATEGY = new PropertyDescriptor.Builder() + .name("azure-cosmos-conflict-handling-strategy") + .displayName("Cosmos DB Conflict Handling Strategy") + .description("Choose whether to ignore or upsert when conflict error occurs during insertion") + .required(false) + .allowableValues(IGNORE_CONFLICT, UPSERT_CONFLICT) + .defaultValue(IGNORE_CONFLICT.getValue()) + .addValidator(StandardValidators.NON_BLANK_VALIDATOR) + .build(); + + + private final static Set<Relationship> relationships; + private final static List<PropertyDescriptor> propertyDescriptors; + + static { + List<PropertyDescriptor> _propertyDescriptors = new ArrayList<>(); + _propertyDescriptors.addAll(descriptors); + _propertyDescriptors.add(RECORD_READER_FACTORY); + _propertyDescriptors.add(INSERT_BATCH_SIZE); + _propertyDescriptors.add(CONFLICT_HANDLE_STRATEGY); + 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; + } + + protected void bulkInsert(final List<Map<String, Object>> records) throws CosmosException{ + // In the future, this method will be replaced by calling createItems API + // for example, this.container.createItems(records); + // currently, no createItems API available in Azure Cosmos Java SDK + final ComponentLog logger = getLogger(); + final CosmosContainer container = getContainer(); + for (Map<String, Object> record : records){ + try { + container.createItem(record); + } catch (ConflictException e) { + // insert with unique id is expected. In case conflict occurs, use the selected strategy. + // By default, it will ignore. + if (conflictHandlingStrategy != null && conflictHandlingStrategy.equals(UPSERT_CONFLICT.getValue())){ + container.upsertItem(record); + } else { + if (logger.isDebugEnabled()) { + logger.debug("Ignoring duplicate based on selected conflict resolution strategy"); + } + } + } + } + } + + @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 RecordReaderFactory recordParserFactory = context.getProperty(RECORD_READER_FACTORY) + .asControllerService(RecordReaderFactory.class); + + final String partitionKeyField = context.getProperty(PARTITION_KEY).getValue(); + List<Map<String, Object>> batch = new ArrayList<>(); + int ceiling = context.getProperty(INSERT_BATCH_SIZE).asInteger(); + boolean error = false; + try (final InputStream inStream = session.read(flowFile); + final RecordReader reader = recordParserFactory.createRecordReader(flowFile, inStream, getLogger())) { + + RecordSchema schema = reader.getSchema(); + Record record; + + while ((record = reader.nextRecord()) != null) { + // Convert each Record to HashMap + Map<String, Object> contentMap = (Map<String, Object>) DataTypeUtils.convertRecordFieldtoObject(record, RecordFieldType.RECORD.getRecordDataType(schema)); + if(contentMap.containsKey("id")) { + Object val = contentMap.get("id"); + if (val == null) { + // dont put null to id + contentMap.put("id", UUID.randomUUID().toString()); + } else if (!(val instanceof String)) { + contentMap.put("id", contentMap.get("id").toString()); + } Review comment: ```suggestion final Object idObj = contentMap.get("id"); final String idStr = String.valueOf(idObj); if (idObj == null || StringUtils.isBlank(idStr)) { contentMap.put("id", UUID.randomUUID().toString()); } else { contentMap.put("id", idStr); } ``` This needs to check for an empty id string too. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
