

AWS Data Pipeline não está mais disponível para novos clientes. Os clientes existentes do AWS Data Pipeline podem continuar usando o serviço normalmente. [Saiba mais](https://aws.amazon.com/blogs/big-data/migrate-workloads-from-aws-data-pipeline/)

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# SqlActivity
<a name="dp-object-sqlactivity"></a>

Executa uma consulta SQL (script) em um banco de dados.

## Exemplo
<a name="sqlactivity-example"></a>

Veja a seguir um exemplo deste tipo de objeto.

```
{
  "id" : "{{MySqlActivity}}",
  "type" : "SqlActivity",
  "database" : { "ref": "{{MyDatabaseID}}" },
  "script" : "{{SQLQuery}}" | "scriptUri" : {{s3://scriptBucket/query.sql}},
  "schedule" : { "ref": "{{MyScheduleID}}" },
}
```

## Sintaxe
<a name="sqlactivity-syntax"></a>


****  

| Campos obrigatórios | Description | Tipo de slot | 
| --- | --- | --- | 
| banco de dados | O banco de dados em que o script SQL fornecido será executado. | Objeto de referência, por exemplo, “banco de dados”: {"ref”:” myDatabaseId “} | 

 


****  

| Campos de invocação de objetos | Description | Tipo de slot | 
| --- | --- | --- | 
| agendamento | Esse objeto é invocado durante a execução de um intervalo de programação. Você deve especificar uma referência de programação para outro objeto para definir a ordem de execução de dependência desse objeto. Você pode definir uma programação explicitamente no objeto, por exemplo, especificando `"schedule": {"ref": "DefaultSchedule"}`. <br />Na maioria dos casos, é melhor colocar a referência de programação no objeto de pipeline padrão para que todos os objetos herdem essa programação. <br />Se o pipeline tiver uma árvore de programações aninhada na programação principal, crie um objeto pai que tenha uma referência de programação. Para obter mais informações sobre o exemplo de configurações opcionais de programação, consulte [https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-object-schedule.html](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-object-schedule.html). | Objeto de referência, por exemplo, “agenda”: {"ref”:” myScheduleId “} | 

 


****  

| Grupo obrigatório (um dos seguintes é obrigatório) | Description | Tipo de slot | 
| --- | --- | --- | 
| script | O script SQL a ser executado. Você deve especificar script ou scriptUri. Quando o script é armazenado no Amazon S3, o script não é avaliado como uma expressão. Especificar vários valores para scriptArgument é útil quando o script é armazenado no Amazon S3. | String | 
| scriptUri | Um URI especificando o local de um script SQL a ser executado nesta atividade. | String | 

 


****  

| Grupo obrigatório (um dos seguintes é obrigatório) | Description | Tipo de slot | 
| --- | --- | --- | 
| runsOn | O recurso computacional para executar a atividade ou o comando. Por exemplo, uma instância do Amazon EC2 ou um cluster do Amazon EMR. | Objeto de referência, por exemplo, “runsOn”: {"ref”:” myResourceId “} | 
| workerGroup | O grupo de operadores. Isso é usado para tarefas de roteamento. Se você fornecer um valor de runsOn e workerGroup existir, será ignorado.workerGroup | String | 

 


****  

| Campos opcionais | Description | Tipo de slot | 
| --- | --- | --- | 
| attemptStatus | Status mais recente da atividade remota. | String | 
| attemptTimeout | Tempo limite para conclusão do trabalho remoto. Se configurada, uma atividade remota não concluída dentro do prazo definido poderá ser executada novamente. | Período | 
| dependsOn | Especifique a dependência em outro objeto executável. | Objeto de referência, por exemplo, “dependsOn”: {"ref”:” myActivityId “} | 
| failureAndRerunModo | Descreve o comportamento do nó do consumidor quando as dependências apresentam falhas ou são executadas novamente. | Enumeração | 
| input | Local dos dados de entrada. | Objeto de referência, por exemplo, “input”: {"ref”:” myDataNode Id "} | 
| lateAfterTimeout | O período desde o início programado do pipeline no qual a execução do objeto deve começar. | Período | 
| maxActiveInstances | O número máximo de instâncias ativas simultâneas de um componente. Novas execuções não contam para o número de instâncias ativas. | Inteiro | 
| maximumRetries | Quantidade máxima de novas tentativas com falha. | Inteiro | 
| onFail | Uma ação a ser executada quando há falha no objeto atual. | Objeto de referência, por exemplo, “onFail”: {"ref”:” myActionId “} | 
| onLateAction | Ações que devem ser acionadas se um objeto ainda não tiver sido programado ou ainda não tiver sido concluído no período de tempo desde o início programado do pipeline, conforme especificado por 'lateAfterTimeout'. | Objeto de referência, por exemplo, "onLateAction“: {" ref”:” myActionId “} | 
| onSuccess | Uma ação a ser executada quando o objeto atual é executado com êxito. | Objeto de referência, por exemplo, “onSuccess”: {"ref”:” myActionId “} | 
| saída | Local dos dados de saída. Isso só é útil para fazer referência a partir de um script (por exemplo\#{output.tablename}) e para criar a tabela de saída definindo 'createTableSql' no nó de dados de saída. O resultado da consulta SQL não é gravado no nó de dados de saída. | Objeto de referência, por exemplo, “output”: {"ref”:” myDataNode Id "} | 
| parent | Pai do objeto atual a partir do qual os slots serão herdados. | Objeto de referência, por exemplo, “parent”: {"ref”:” myBaseObject Id "} | 
| pipelineLogUri | O URI do S3 (como 's3://BucketName/Key/ ') para carregar registros para o pipeline. | String | 
| precondition | Se desejar, você pode definir uma precondição. Um nó de dados não fica marcado como "READY" até que todas as precondições tenham sido atendidas. | Objeto de referência, por exemplo, “pré-condição”: {"ref”:” myPreconditionId “} | 
| queue (fila) | [Apenas para o Amazon Redshift] Corresponde à configuração query\_group no Amazon Redshift, que permite atribuir e priorizar atividades simultâneas com base em sua colocação em filas. O Amazon Redshift limita o número de conexões simultâneas a 15. Para obter mais informações, consulte [Atribuir consultas a filas](https://docs.aws.amazon.com/redshift/latest/dg/cm-c-executing-queries.html) no Guia do desenvolvedor de banco de dados do Amazon Redshift. | String | 
| reportProgressTimeout | Tempo limite para as chamadas sucessivas de trabalho remoto para reportProgress. Se definidas, as atividades remotas sem progresso para o período especificado podem ser consideradas como interrompidas e executadas novamente. | Período | 
| retryDelay | A duração do tempo limite entre duas novas tentativas. | Período | 
| scheduleType | O tipo de programação permite que você especifique se os objetos na sua definição de pipeline devem ser programados no início ou no final do intervalo. Os valores são: `cron`, `ondemand` e `timeseries`.<br /> A programação `timeseries` significa que as instâncias são programadas no final de cada intervalo.<br />A programação `cron` significa que as instâncias são programadas no início de cada intervalo. <br />Uma programação `ondemand` permite que você execute um pipeline uma vez por ativação. Isso significa que você não precisa clonar nem recriar o pipeline para executá-lo novamente. Se você usar uma programação `ondemand`, ela precisará ser especificada no objeto padrão, além de ser a única `scheduleType` especificada para objetos no pipeline. Para usar pipelines `ondemand`, chame a operação `ActivatePipeline` para cada execução subsequente. | Enumeração | 
| scriptArgument | Uma lista de variáveis do script. Além disso, você pode colocar expressões diretamente no campo do script. Vários valores para scriptArgument são úteis quando o script é armazenado no Amazon S3. Exemplo: \# {format (@scheduledStartTime, "YY-MM-DD HH:MM:SS"}\\n\# {format (plusPeriod (@scheduledStartTime, “1 dia”), "HH:MM:SS"} YY-MM-DD  | String | 

 


****  

| Campos de tempo de execução | Description | Tipo de slot | 
| --- | --- | --- | 
| @activeInstances | Lista dos objetos da instância ativa agendados no momento. | Objeto de referência, por exemplo, “ActiveInstances”: {"ref”:” myRunnableObject Id "} | 
| @actualEndTime | Hora em que a execução deste objeto foi concluída. | DateTime | 
| @actualStartTime | Hora em que a execução deste objeto foi iniciada. | DateTime | 
| cancellationReason | O motivo do cancelamento, se esse objeto foi cancelado. | String | 
| @cascadeFailedOn | Descrição da cadeia de dependência na qual o objeto apresentou falha. | Objeto de referência, por exemplo, "cascadeFailedOn“: {" ref”:” myRunnableObject Id "} | 
| emrStepLog | Registros da etapa do EMR disponíveis somente nas tentativas de atividade do EMR. | String | 
| errorId | O ID do erro se esse objeto apresentou falha. | String | 
| errorMessage | A mensagem de erro se esse objeto apresentou falha. | String | 
| errorStackTrace | O rastreamento de pilha com erro se esse objeto apresentou falha. | String | 
| @finishedTime | A hora em que esse objeto terminou a execução. | DateTime | 
| hadoopJobLog | Registos de trabalho do Hadoop disponíveis nas tentativas de atividades baseadas em EMR. | String | 
| @healthStatus | O status de integridade do objeto que indica se houve sucesso ou falha na última instância concluída do objeto. | String | 
| @healthStatusFromInstanceId | ID do último objeto da instância concluído. | String | 
| @ healthStatusUpdated Hora | Hora em que o status de integridade foi atualizado pela última vez. | DateTime | 
| hostname | O nome do host do cliente que capturou a tentativa da tarefa. | String | 
| @lastDeactivatedTime | A hora em que esse objeto foi desativado pela última vez. | DateTime | 
| @ latestCompletedRun Hora | Hora da última execução concluída. | DateTime | 
| @latestRunTime | Hora da última execução programada. | DateTime | 
| @nextRunTime | Hora da próxima execução a ser programada. | DateTime | 
| reportProgressTime | A última vez que a atividade remota relatou progresso. | DateTime | 
| @scheduledEndTime | Horário de término da programação para o objeto. | DateTime | 
| @scheduledStartTime | Horário de início da programação para o objeto. | DateTime | 
| @status | O status deste objeto. | String | 
| @version | A versão do pipeline com que o objeto foi criado. | String | 
| @waitingOn | Descrição da lista de dependências em que este objeto está aguardando. | Objeto de referência, por exemplo, “waitingOn”: {"ref”:” myRunnableObject Id "} | 

 


****  

| Campos do sistema | Description | Tipo de slot | 
| --- | --- | --- | 
| @error | Erro ao descrever o objeto malformado. | String | 
| @pipelineId | ID do pipeline ao qual este objeto pertence. | String | 
| @sphere | A esfera de um objeto denota seu lugar no ciclo de vida: os objetos componentes dão origem aos objetos de instância que executam os objetos de tentativa. | String | 