Package org.apache.nifi.processors.standard

Class PutSQL

java.lang.Object
org.apache.nifi.components.AbstractConfigurableComponent
org.apache.nifi.processor.AbstractSessionFactoryProcessor
org.apache.nifi.processors.standard.PutSQL
All Implemented Interfaces:
org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.processor.Processor
@SupportsBatching @InputRequirement(INPUT_REQUIRED) @Tags({"sql","put","rdbms","database","update","insert","relational"}) @CapabilityDescription("Executes a SQL UPDATE or INSERT command. The content of an incoming FlowFile is expected to be the SQL command to execute. The SQL command may use the ? to escape parameters. In this case, the parameters to use must exist as FlowFile attributes with the naming convention sql.args.N.type and sql.args.N.value, where N is a positive integer. The sql.args.N.type is expected to be a number indicating the JDBC Type. The content of the FlowFile is expected to be in UTF-8 format.") @ReadsAttribute(attribute="fragment.identifier",description="If the <Support Fragment Transactions> property is true, this attribute is used to determine whether or not two FlowFiles belong to the same transaction.") @ReadsAttribute(attribute="fragment.count",description="If the <Support Fragment Transactions> property is true, this attribute is used to determine how many FlowFiles are needed to complete the transaction.") @ReadsAttribute(attribute="fragment.index",description="If the <Support Fragment Transactions> property is true, this attribute is used to determine the order that the FlowFiles in a transaction should be evaluated.") @ReadsAttribute(attribute="sql.args.N.type",description="Incoming FlowFiles are expected to be parametrized SQL statements. The type of each Parameter is specified as an integer that represents the JDBC Type of the parameter.") @ReadsAttribute(attribute="sql.args.N.value",description="Incoming FlowFiles are expected to be parametrized SQL statements. The value of the Parameters are specified as sql.args.1.value, sql.args.2.value, sql.args.3.value, and so on. The type of the sql.args.1.value Parameter is specified by the sql.args.1.type attribute.") @ReadsAttribute(attribute="sql.args.N.format",description="This attribute is always optional, but default options may not always work for your data. Incoming FlowFiles are expected to be parametrized SQL statements. In some cases a format option needs to be specified, currently this is only applicable for binary data types, dates, times and timestamps. Binary Data Types (defaults to \'ascii\') - ascii: each string character in your attribute value represents a single byte. This is the format provided by Avro Processors. base64: the string is a Base64 encoded string that can be decoded to bytes. hex: the string is hex encoded with all letters in upper case and no \'0x\' at the beginning. Dates/Times/Timestamps - Date, Time and Timestamp formats all support both custom formats or named format (\'yyyy-MM-dd\',\'ISO_OFFSET_DATE_TIME\') as specified according to java.time.format.DateTimeFormatter. If not specified, a long value input is expected to be an unix epoch (milli seconds from 1970/1/1), or a string value in \'yyyy-MM-dd\' format for Date, \'HH:mm:ss.SSS\' for Time (some database engines e.g. Derby or MySQL do not support milliseconds and will truncate milliseconds), \'yyyy-MM-dd HH:mm:ss.SSS\' for Timestamp is used.") @WritesAttributes(@WritesAttribute(attribute="sql.generated.key",description="If the database generated a key for an INSERT statement and the Obtain Generated Keys property is set to true, this attribute will be added to indicate the generated key, if possible. This feature is not supported by all database vendors.")) public class PutSQL extends org.apache.nifi.processor.AbstractSessionFactoryProcessor

  • Field Details

  • Constructor Details

    • PutSQL

      public PutSQL()

  • Method Details

    • getSupportedPropertyDescriptors

      protected List<org.apache.nifi.components.PropertyDescriptor> getSupportedPropertyDescriptors()
      Overrides:
      getSupportedPropertyDescriptors in class org.apache.nifi.components.AbstractConfigurableComponent

    • customValidate

      protected final Collection<org.apache.nifi.components.ValidationResult> customValidate(org.apache.nifi.components.ValidationContext context)
      Overrides:
      customValidate in class org.apache.nifi.components.AbstractConfigurableComponent

    • getRelationships

      public Set<org.apache.nifi.processor.Relationship> getRelationships()
      Specified by:
      getRelationships in interface org.apache.nifi.processor.Processor
      Overrides:
      getRelationships in class org.apache.nifi.processor.AbstractSessionFactoryProcessor

    • onFlowFileError

      private ExceptionHandler.OnError<PutSQL.FunctionContext,org.apache.nifi.flowfile.FlowFile> onFlowFileError(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSession session, RoutingResult result)

    • onGroupError

      private ExceptionHandler.OnError<RollbackOnFailure,PartialFunctions.FlowFileGroup> onGroupError(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSession session, RoutingResult result)

    • getFlowFilesOnRelationship

      private List<org.apache.nifi.flowfile.FlowFile> getFlowFilesOnRelationship(RoutingResult result, org.apache.nifi.processor.Relationship relationship)

    • addErrorAttributesToFlowFilesInGroup

      private List<org.apache.nifi.flowfile.FlowFile> addErrorAttributesToFlowFilesInGroup(org.apache.nifi.processor.ProcessSession session, List<org.apache.nifi.flowfile.FlowFile> flowFilesOnRelationship, List<org.apache.nifi.flowfile.FlowFile> flowFilesInGroup, Exception exception)

    • onBatchUpdateError

      private ExceptionHandler.OnError<PutSQL.FunctionContext,PutSQL.StatementFlowFileEnclosure> onBatchUpdateError(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSession session, RoutingResult result)

    • constructProcess

      @OnScheduled public void constructProcess()

    • onTrigger

      public void onTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSessionFactory sessionFactory) throws org.apache.nifi.processor.exception.ProcessException
      Throws:
      org.apache.nifi.processor.exception.ProcessException

    • pollFlowFiles

      private PutSQL.FlowFilePoll pollFlowFiles(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSession session, PutSQL.FunctionContext functionContext, RoutingResult result)
      Pulls a batch of FlowFiles from the incoming queues. If no FlowFiles are available, returns null. Otherwise, a List of FlowFiles will be returned.

      If all FlowFiles pulled are not eligible to be processed, the FlowFiles will be penalized and transferred back to the input queue and an empty List will be returned.

      Otherwise, if the Support Fragmented Transactions property is true, all FlowFiles that belong to the same transaction will be sorted in the order that they should be evaluated.

      Parameters:
      context - the process context for determining properties
      session - the process session for pulling FlowFiles
      Returns:
      a FlowFilePoll containing a List of FlowFiles to process, or null if there are no FlowFiles to process

    • determineGeneratedKey

      private String determineGeneratedKey(PreparedStatement stmt)
      Returns the key that was generated from the given statement, or null if no key was generated or it could not be determined.
      Parameters:
      stmt - the statement that generated a key
      Returns:
      the key that was generated from the given statement, or null if no key was generated, or it could not be determined.

    • getSQL

      private String getSQL(org.apache.nifi.processor.ProcessSession session, org.apache.nifi.flowfile.FlowFile flowFile)
      Determines the SQL statement that should be executed for the given FlowFile
      Parameters:
      session - the session that can be used to access the given FlowFile
      flowFile - the FlowFile whose SQL statement should be executed
      Returns:
      the SQL that is associated with the given FlowFile

    • isFragmentedTransactionReady

      boolean isFragmentedTransactionReady(List<org.apache.nifi.flowfile.FlowFile> flowFiles, Long transactionTimeoutMillis) throws IllegalArgumentException
      Determines which relationship the given FlowFiles should go to, based on a transaction timing out or transaction information not being present. If the FlowFiles should be processed and not transferred to any particular relationship yet, will return null
      Parameters:
      flowFiles - the FlowFiles whose relationship is to be determined
      transactionTimeoutMillis - the maximum amount of time (in milliseconds) that we should wait for all FlowFiles in a transaction to be present before routing to failure
      Returns:
      the appropriate relationship to route the FlowFiles to, or null if the FlowFiles should instead be processed
      Throws:
      IllegalArgumentException

    • addErrorAttributesToFlowFile

      private org.apache.nifi.flowfile.FlowFile addErrorAttributesToFlowFile(org.apache.nifi.processor.ProcessSession session, org.apache.nifi.flowfile.FlowFile flowFile, Exception exception)