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.
入力要件¶
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 |
HTTP Authorization Headerを使用した認証のための OAuth2 アクセストークンを提供するサービス。 |
query-type |
パラメーターでクエリを提供するか、完全なカスタムクエリを提供するかを選択します。 |
read-timeout |
Salesforce REST API からの応答を読み取るために許容される最大時間 |
record-writer |
Salesforce REST API から返された記録の書き込みに使用するサービスです。 |
salesforce-api-version |
サービス/データパスの後に、 URL に追加される Salesforce REST API のバージョン番号。サポートされるバージョンについては、Salesforce ドキュメントを参照してください。 |
salesforce-url |
https://MyDomainName.my.salesforce.com のように、追加のパス情報を含まないドメインを含む Salesforce インスタンスの URL を指定します。 |
sobject-name |
クエリ対象の Salesforce sObject |
状態管理¶
スコープ |
説明 |
|---|---|
CLUSTER |
'Age Field' がセットされている場合、クエリ実行後に実行時刻が保存されます。それ以降のクエリは、保存された実行時間 (オプション値の 'Age Delay' で調整) より新しい記録のみが検索されるように、追加の条件で補強されます。状態はクラスタリングに保存され、このプロセッサーがPrimary Nodeで実行されます。新しいプライマリ・ノードが選択された場合、新しいノードはデータを複製することなく、前のノードが停止した場所を引き継ぐことができます。 |
リレーションシップ¶
名前 |
説明 |
|---|---|
failure |
クエリが失敗した場合、入力フローファイルはこのリレーションシップに送られます。 |
original |
クエリが成功すると、入力フローファイルはこのリレーションシップに送信されます。 |
success |
クエリに成功した結果、作成された FlowFiles の場合。 |
属性の書き込み¶
名前 |
説明 |
|---|---|
mime.type |
mime.type属性をRecord Writerで指定された MIME Typeにセットします。 |
record.count |
FlowFile の記録数をセット。 |
total.record.count |
FlowFile の総記録数をセット。 |