QuerySalesforceObject 2025.10.2.19¶
Bundle¶
org.apache.nifi | nifi-salesforce-nar
Description¶
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.
Exigences en matière d’entrées¶
ALLOWED
Prend en charge les propriétés dynamiques sensibles¶
false
Propriétés¶
Propriété |
Description |
|---|---|
age-delay |
L’horodatage de fin de la fenêtre temporelle sera avancé de la valeur configurée dans cette propriété. Par exemple, avec une valeur de propriété de 10 secondes, un horodatage de fin de 12:30:45 sera remplacé par 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 |
Indique s’il faut ou non créer un FlowFile lorsque le REST API de Salesforce ne renvoie aucun enregistrement |
custom-soql-query |
Indique la requête SOQL à exécuter. |
custom-where-condition |
Une expression personnalisée à ajouter dans la clause WHERE de la requête |
field-names |
Liste séparée par des virgules des noms de champs demandés à l’objet sObject devant faire l’objet d’une requête. Si ce champ n’est pas renseigné, tous les champs font l’objet d’une requête. |
include-deleted-records |
Si c’est le cas, le processeur inclura les enregistrements supprimés (IsDeleted = true) dans les résultats de la requête. Lorsque cette option est activée, le processeur utilise la fonction “queryAll” API. |
initial-age-filter |
Cette propriété indique l’heure de début que le processeur applique lors de l’exécution de la première requête. |
oauth2-access-token-provider |
Service fournissant des jetons d’accès à OAuth2 pour l’authentification à l’aide de l’en-tête d’autorisation HTTP |
query-type |
Choisissez de fournir la requête par paramètres ou une requête personnalisée complète. |
read-timeout |
Temps maximum autorisé pour la lecture d’une réponse de la part de Salesforce REST API |
record-writer |
Service utilisé pour écrire les enregistrements renvoyés par la base de données Salesforce REST API |
salesforce-api-version |
Le numéro de version de Salesforce REST API ajouté à URL après le chemin des services/données. Consultez la documentation de Salesforce pour connaître les versions prises en charge |
salesforce-url |
L’URL de l’instance Salesforce, y compris le domaine sans informations de chemin supplémentaires, tel que https://MyDomainName.my.salesforce.com |
sobject-name |
L’objet Salesforce sObject à interroger |
Gestion de l’État¶
Champs d’application |
Description |
|---|---|
CLUSTER |
Lorsque “Age Field” est défini, après l’exécution d’une requête, l’heure d’exécution est enregistrée. Les requêtes suivantes seront complétées par une condition supplémentaire afin que seuls les enregistrements plus récents que l’heure d’exécution enregistrée (ajustée avec la valeur facultative de “Age Delay”) soient récupérés. L’état est stocké dans le clustering afin que ce processeur puisse être exécuté sur le nœud principal uniquement et que, si un nouveau nœud principal est sélectionné, le nouveau nœud puisse reprendre là où le précédent s’est arrêté, sans dupliquer les données. |
Relations¶
Nom |
Description |
|---|---|
failure |
Le FlowFile d’entrée est envoyé vers cette relation lorsque la requête échoue. |
original |
Le FlowFile d’entrée est envoyé vers cette relation lorsque la requête réussit. |
success |
Pour les FlowFiles créés à la suite d’une requête réussie. |
Écrit les attributs¶
Nom |
Description |
|---|---|
mime.type |
L’ensemble de l’attribut mime.type est défini sur le type MIME spécifié par le Record Writer. |
record.count |
Définit le nombre d’enregistrements dans le FlowFile. |
total.enregistrement.count |
Définit le nombre total d’enregistrements dans le FlowFile. |