QuerySalesforceObject 2025.10.2.19¶
Bundle¶
org.apache.nifi | nifi-salesforce-nar
Beschreibung¶
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.
Eingabeanforderung¶
ALLOWED
Unterstützt sensible dynamische Eigenschaften¶
false
Eigenschaften¶
Eigenschaft |
Beschreibung |
|---|---|
age-delay |
Der Endzeitstempel des Zeitfensters wird um den in dieser Eigenschaft konfigurierten Wert nach vorne verschoben. Bei einem Eigenschaftswert von 10 Sekunden würde zum Beispiel ein Endzeitstempel von 12:30:45 in 12:30:35 geändert werden. |
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 |
Gibt an, ob ein FlowFile erstellt werden soll, wenn die Salesforce REST-API keine Datensätze zurückgibt. |
custom-soql-query |
Geben Sie die auszuführende SOQL-Abfrage an. |
custom-where-condition |
Ein benutzerdefinierter Ausdruck, der in der WHERE-Klausel der Abfrage hinzugefügt wird |
field-names |
Durch Kommas getrennte Liste der Feldnamen, die vom abzufragenden Objekt angefordert werden. Wenn Sie dieses Feld leer lassen, werden alle Felder abgefragt. |
include-deleted-records |
Bei „true“ nimmt der Prozessor gelöschte Datensätze (IsDeleted = true) in die Abfrageergebnisse auf. Wenn diese Option aktiviert ist, verwendet der Prozessor die Funktion „queryAll“-API. |
initial-age-filter |
Diese Eigenschaft gibt die Startzeit an, die der Prozessor bei der Ausführung der ersten Abfrage anwendet. |
oauth2-access-token-provider |
Dienst, der OAuth2-Zugriffstoken für die Authentifizierung über den HTTP-Autorisierungs-Header bereitstellt. |
query-type |
Wählen Sie, ob Sie die Abfrage über Parameter oder eine vollständige benutzerdefinierte Abfrage bereitstellen möchten. |
read-timeout |
Maximal zulässige Zeit für das Lesen einer Antwort aus der Salesforce REST-API |
record-writer |
Dienst, der für das Schreiben von Datensätzen verwendet wird, die von der Salesforce REST-API zurückgegeben werden. |
salesforce-api-version |
Die Versionsnummer der Salesforce REST-API, die an die URL nach dem Pfad services/data angehängt ist. Siehe Salesforce-Dokumentation für unterstützte Versionen |
salesforce-url |
Die URL der Salesforce-Instanz einschließlich der Domäne ohne zusätzliche Pfadangaben, z. B. https://MyDomainName.my.salesforce.com |
sobject-name |
Das Salesforce sObject, das abgefragt werden soll |
Statusmanagement¶
Bereiche |
Beschreibung |
|---|---|
CLUSTER |
Wenn „Age Field“ eingestellt ist, wird nach der Durchführung einer Abfrage der Zeitpunkt der Ausführung gespeichert. Nachfolgende Abfragen werden mit einer zusätzlichen Bedingung ergänzt, so dass nur Datensätze abgerufen werden, die neuer sind als die gespeicherte Ausführungszeit (angepasst mit dem optionalen Wert von „Age Delay“). Der Status wird im gesamten Cluster gespeichert, sodass dieser Prozessor nur auf dem primären Knoten ausgeführt werden kann. Wenn ein neuer primärer Knoten ausgewählt wird, kann der neue Knoten dort weitermachen, wo der vorherige Knoten aufgehört hat, ohne die Daten zu duplizieren. |
Beziehungen¶
Name |
Beschreibung |
|---|---|
failure |
Wenn die Abfrage fehlschlägt, wird die Eingabedatei an diese Beziehung gesendet. |
original |
Die Eingabedatei wird an diese Beziehung gesendet, wenn die Abfrage erfolgreich war. |
success |
Für FlowFiles, die als Ergebnis einer erfolgreichen Abfrage erstellt wurden. |
Schreibt Attribute¶
Name |
Beschreibung |
|---|---|
mime.type |
Setzt das Attribut „mime.type“ auf den vom Record Writer angegebenen MIME-Typ. |
record.count |
Legt die Anzahl der Datensätze im FlowFile fest. |
total.record.count |
Legt die Gesamtzahl der Datensätze im FlowFile fest. |