QuerySalesforceObject 2025.5.31.15¶
Pacote¶
org.apache.nifi | nifi-salesforce-nar
Descrição¶
Recupera registros de um sObject do Salesforce. Os usuários podem adicionar condições de filtro arbitrárias definindo a propriedade “Condição WHERE personalizada”. O processador também pode executar uma consulta personalizada, embora não haja suporte ao processamento de registro nesse caso. Suporte à recuperação incremental: os usuários podem definir um campo na propriedade “Age Field” (Campo de idade) que será usado para determinar quando o registro foi criado. Quando essa propriedade for definida, o processador recuperará novos registros. O carregamento incremental e o processamento baseado em registros são compatíveis apenas em consultas baseadas em propriedades. Também é possível definir um valor de corte inicial para a idade, filtrando todos os registros mais antigos, mesmo na primeira execução. No caso de “Property Based Query” (Consulta baseada em propriedade), esse processador deve ser executado somente no nó primário. O atributo FlowFile “record.count” indica quantos registros foram recuperados e gravados na saída. O processador pode aceitar uma entrada FlowFile opcional e fazer referência aos atributos do FlowFile na consulta. Quando a opção “Include Deleted Records” (Incluir registros excluídos) for verdadeira, o processador incluirá os registros excluídos (exclusões flexíveis) nos resultados usando a “queryAll” API. O campo “IsDeleted” será incluído automaticamente nos resultados ao consultar registros excluídos.
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 |
O nome de um campo TIMESTAMP que será usado para filtrar registros usando uma janela de tempo limitada. O processador retornará apenas os registros com um valor de carimbo de data/hora mais recente do que o carimbo de data/hora registrado após a última execução do processador. |
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. |