QuerySalesforceObject 2025.10.2.19¶
Pacote¶
org.apache.nifi | nifi-salesforce-nar
Descrição¶
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.
Requisito de entrada¶
ALLOWED
Oferece suporte a propriedades dinâmicas confidenciais¶
falso
Propriedades¶
Propriedade |
Descrição |
|---|---|
age-delay |
O carimbo de data/hora final da janela de tempo será ajustado mais cedo pelo valor configurado nessa propriedade. Por exemplo, com um valor de propriedade de 10 segundos, um carimbo de data/hora final de 12:30:45 seria alterado para 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 |
Especifica se deve ou não criar um FlowFile quando a REST API Salesforce não retorna nenhum registro |
custom-soql-query |
Especifique a consulta SOQL a ser executada. |
custom-where-condition |
Uma expressão personalizada a ser adicionada na cláusula WHERE da consulta |
field-names |
Lista de nomes de campos solicitados do sObject separados por vírgulas para consulta. Quando esse campo é deixado em branco, todos os campos são consultados. |
include-deleted-records |
Se verdadeiro, o processador incluirá registros excluídos (IsDeleted = true) nos resultados de consulta. Quando ativado, o processador usará a “queryAll” API. |
initial-age-filter |
Essa propriedade especifica a hora de início que o processador aplica ao executar a primeira consulta. |
oauth2-access-token-provider |
Serviço que fornece tokens de acesso OAuth2 para autenticação usando o cabeçalho de autorização HTTP |
query-type |
Opte por fornecer a consulta por parâmetros ou uma consulta personalizada completa. |
read-timeout |
Tempo máximo permitido para ler uma resposta da REST API do Salesforce |
record-writer |
Serviço usado para gravar os registros retornados da REST API Salesforce |
salesforce-api-version |
O número da versão da REST API do Salesforce anexado ao URL após o caminho services/data. Consulte a documentação do Salesforce para obter as versões compatíveis |
salesforce-url |
O URL da instância do Salesforce, incluindo o domínio sem informações adicionais de caminho, como https://MyDomainName.my.salesforce.com |
sobject-name |
O sObject do Salesforce a ser consultado |
Gerenciamento do estado¶
Escopos |
Descrição |
|---|---|
CLUSTER |
Quando “Campo de idade” é definido, após a realização de uma consulta, a hora da execução é armazenada. As consultas subsequentes serão acrescidas de uma condição adicional para que apenas os registros mais recentes do que o tempo de execução armazenado (ajustado com o valor opcional de “Age Delay” (Atraso de idade) sejam recuperados. O estado é armazenado em todo o cluster para que esse processador possa ser executado somente no nó primário e, se um novo nó primário for selecionado, o novo nó poderá continuar de onde o nó anterior parou, sem duplicar os dados. |
Relações¶
Nome |
Descrição |
|---|---|
failure |
O FlowFile de entrada é enviado para essa relação quando a consulta falha. |
original |
O FlowFile de entrada é enviado para essa relação quando a consulta é bem-sucedida. |
success |
Para FlowFiles criados como resultado de uma consulta bem-sucedida. |
Grava atributos¶
Nome |
Descrição |
|---|---|
mime.type |
Define o atributo mime.type como o tipo MIME especificado pelo Record Writer. |
record.count |
Define o número de registros no FlowFile. |
total.record.count |
Define o número total de registros no FlowFile. |