QuerySalesforceObject 2025.10.2.19¶

捆绑包¶

org.apache.nifi | nifi-salesforce-nar

描述¶

Retrieves records from a Salesforce sObject. Users can add arbitrary filter conditions by setting the 'Custom WHERE Condition' property. The processor can also run a custom query, although record processing is not supported in that case. Supports incremental retrieval: users can define a field in the 'Age Field' property that will be used to determine when the record was created. When this property is set the processor will retrieve new records. Incremental loading and record-based processing are only supported in property-based queries. It 's also possible to define an initial cutoff value for the age, filtering out all older records even for the first run. In case of'Property Based Query 'this processor should run on the Primary Node only. FlowFile attribute' record.count 'indicates how many records were retrieved and written to the output. The processor can accept an optional input FlowFile and reference the FlowFile attributes in the query. When'Include Deleted Records 'is true, the processor will include deleted records (soft-deletes) in the results by using the' queryAll 'API. The'IsDeleted' field will be automatically included in the results when querying deleted records.

标签¶

query、salesforce、sobject、soql

输入要求¶

ALLOWED

支持敏感的动态属性¶

false

属性¶

属性	描述
age-delay	时间窗口的结束时间戳将根据此属性中配置的数量提前进行调整。例如，如果属性值为 10 秒，则结束时间戳 12:30:45 会更改为 12:30:35。
age-field	The name of a TIMESTAMP field that will be used to filter records using a bounded time window. The processor will return only those records with a timestamp value newer than the timestamp recorded after the last processor run.
create-zero-record-files	指定在 Salesforce REST API 不返回任何记录时是否创建 FlowFile
custom-soql-query	指定要运行的 SOQL 查询。
custom-where-condition	要在查询的 WHERE 子句中添加的自定义表达式
field-names	指定的要从 sObject 中查询的字段名称列表，以逗号分隔。当此字段留空时，将查询所有字段。
include-deleted-records	如果为 true，则处理器将在查询结果中包含已删除的记录 (IsDeleted = true)。启用后，处理器将使用“queryAll”API
initial-age-filter	此属性指定处理器在运行第一个查询时适用的开始时间。
oauth2-access-token-provider	提供 OAuth2 访问令牌以使用 HTTP 授权标头进行身份验证的服务
query-type	选择按参数提供查询或完整的自定义查询。
read-timeout	允许读取 Salesforce REST API 响应的最大时间
record-writer	用于写入 Salesforce REST API 返回的记录的服务
salesforce-api-version	在 URL 的 services/data 路径之后附加的Salesforce REST API 的版本号。有关支持的版本，请参阅 Salesforce 文档
salesforce-url	Salesforce 实例的 URL，包括没有其他路径信息的域，例如 https://MyDomainName.my.salesforce.com (https://MyDomainName.my.salesforce.com)
sobject-name	要查询的 Salesforce sObject

状态管理¶

范围	描述
CLUSTER	设置“Age Field”时，在执行查询后，将存储执行时间。随后的查询将增加一个附加条件，以便只检索比存储的执行时间（用可选的“Age Delay”值调整）新的记录。状态存储在整个集群中，因此该处理器只能在主节点上运行，如果选择了新的主节点，则新节点可以从前一个节点中断的地方继续，而无需复制数据。

范围

描述

CLUSTER

设置“Age Field”时，在执行查询后，将存储执行时间。随后的查询将增加一个附加条件，以便只检索比存储的执行时间（用可选的“Age Delay”值调整）新的记录。状态存储在整个集群中，因此该处理器只能在主节点上运行，如果选择了新的主节点，则新节点可以从前一个节点中断的地方继续，而无需复制数据。

关系¶

名称	描述
failure	查询失败后，输入 FlowFile 将发送到此关系。
original	查询成功后，输入 FlowFile 将发送到此关系。
success	用于因请求成功而创建的 FlowFiles。

写入属性¶

名称	描述
mime.type	将 mime.type 属性设置为记录写入器指定的 MIME 类型。
record.count	设置 FlowFile 中的记录数。
total.record.count	设置 FlowFile 中的记录总数。

另请参阅¶

org.apache.nifi.processors.salesforce.PutSalesforceObject