Tarefa FTP

Aplica-se a:SQL Server SSIS Integration Runtime no Azure Data Factory

A tarefa FTP carrega e baixa arquivos de dados, bem como gerencia diretórios em servidores. Por exemplo, um pacote pode baixar arquivos de dados de um servidor remoto ou de um local de Internet como parte de um fluxo de trabalho de pacote do Integration Services. Você pode usar a tarefa FTP para os seguintes propósitos:

  • Copiar diretórios e arquivos de dados de um diretório para outro, antes ou depois de mover dados, e aplicar transformações nos dados.

  • Fazer logon em um local FTP de origem e copiar arquivos ou pacotes em um diretório de destino.

  • Baixar arquivos de um local FTP e aplicar transformações em dados de coluna antes de carregar os dados em um banco de dados.

Em tempo de execução, a tarefa FTP é conectada a um servidor usando um gerenciador de conexões de FTP. O gerenciador de conexões de FTP é configurado separadamente da tarefa FTP e, em seguida, é referido na tarefa FTP. O gerenciador de conexões de FTP inclui as configurações do servidor, as credenciais para acessar o servidor FTP e as opções como o tempo limite e o número de tentativas para conexão com o servidor. Para obter mais informações, consulte Gerenciador de Conexões de FTP.

Importante

O gerenciador de conexões de FTP dá suporte apenas para autenticação anônima e autenticação básica. Ele não suporta a Autenticação do Windows.

Ao acessar um arquivo local ou um diretório local, a tarefa FTP usa um gerenciador de conexões de arquivos ou informações de caminho armazenadas em uma variável. Por outro lado, ao acessar um arquivo remoto ou um diretório remoto, a tarefa FTP usa um caminho especificado diretamente no servidor remoto, conforme especificado no gerenciador de conexões de FTP, ou as informações de caminho armazenadas em uma variável. Para obter mais informações, confira Gerenciador de Conexões de Arquivos e Variáveis do Integration Services (SSIS).

Isso significa que a tarefa FTP pode receber vários arquivos e excluir diversos arquivos remotos, mas a tarefa só poderá enviar um arquivo e só poderá excluir um arquivo local se usar um gerenciador de conexões, porque um gerenciador de conexões de arquivos pode acessar só um arquivo. Para acessar vários arquivos locais, a tarefa FTP deve usar uma variável para fornecer as informações de caminho. Por exemplo, uma variável que contém "C:\Test*.txt" fornece um caminho que dá suporte à exclusão ou ao envio de todos os arquivos com uma extensão .txt no diretório Test.

Para enviar vários arquivos e acessar diversos arquivos locais e diretórios, você também pode executar diversas vezes a tarefa FTP incluindo a tarefa em um Loop Foreach. O Loop Foreach pode enumerar arquivos em um diretório usando o enumerador For Each File. Para obter mais informações, consulte Contêiner Loop Foreach.

A tarefa de FTP dá suporte para os caracteres curinga ? e * nos caminhos. Isso permite que a tarefa acesse vários arquivos. Porém, você só pode usar caracteres curinga na parte do caminho que especifica o nome de arquivo. Por exemplo, C:\MyDirectory\*.txt é um caminho válido, mas C:\*\MyText.txt não é.

Os operações de FTP podem ser configuradas para interromper a tarefa Sistema de Arquivos quando a operação falha ou para transferir arquivos no modo ASCII. As operações que enviam e recebem cópias de arquivos podem ser configuradas para substituir arquivos de destino e diretórios.

Operações de FTP predefinidas

A tarefa FTP inclui um conjunto predefinido de operações. A tabela a seguir descreve essas operações.

Operação Descrição
Enviar arquivos Envia um arquivo do computador local para o servidor FTP.
Receber arquivos Salva um arquivo do servidor FTP no computador local.
Criar diretório local Cria uma pasta no computador local.
Criar diretório remoto Cria uma pasta no servidor FTP.
Remover diretório local Exclui uma pasta no computador local.
Remover diretório remoto Exclui uma pasta no servidor FTP.
Excluir arquivos locais Exclui um arquivo no computador local.
Excluir arquivos remotos Exclui um arquivo no servidor FTP.

Entradas de log personalizadas disponíveis na tarefa FTP

A tabela a seguir relaciona as entradas de log personalizadas da tarefa FTP. Para obter mais informações, consulte Log do SSIS (Integration Services).

Entrada de log Descrição
FTPConnectingToServer Indica que a tarefa iniciou uma conexão com o servidor FTP.
FTPOperation Informa o início e o tipo de operação de FTP que a tarefa executa.

Você pode definir propriedades pelo Designer do SSIS ou programaticamente.

Para obter informações sobre como definir essas propriedades no Designer do SSIS, confira Definir as propriedades de uma tarefa ou um contêiner.

Para obter mais informações sobre como definir essas propriedades de forma programática, consulte FtpTask.

Editor da Tarefa FTP (página Geral)

Use a página Geral da caixa de diálogo Editor da Tarefa FTP para especificar o gerenciador de conexões que estabelece conexão com o servidor FTP com o qual a tarefa se comunica. Você também pode nomear e descrever a tarefa FTP.

Opções

FtpConnection
Selecione um gerenciador de conexões FTP existente ou clique em <Nova conexão…> para criar um gerenciador de conexões.

Importante

O gerenciador de conexões de FTP dá suporte apenas para autenticação anônima e autenticação básica. Ele não suporta a Autenticação do Windows.

Tópicos relacionados: Gerenciador de Conexões de FTP, Editor do Gerenciador de Conexões de FTP

StopOnFailure
Indique se a tarefa FTP deve ser encerrada se a operação FTP falhar.

Nome
Forneça um nome exclusivo para a tarefa FTP. Esse nome é usado como rótulo no ícone de tarefa.

Observação

Os nomes das tarefas devem ser exclusivos em um pacote.

Descrição
Digite uma descrição para a tarefa FTP.

Editor da Tarefa FTP (página Transferência de Arquivos)

Use a página Transferência de Arquivos da caixa de diálogo Editor da Tarefa FTP para configurar a operação FTP executada pela tarefa.

Opções

IsRemotePathVariable
Indique se o caminho remoto deve ser armazenado em uma variável. As opções dessa propriedade são listadas na tabela a seguir.

Valor Descrição
Verdadeiro O caminho de destino é armazenado em uma variável. Ao selecionar esse valor, a opção dinâmica RemoteVariableserá exibida.
Falso O caminho de destino é especificado em um gerenciador de conexões de Arquivo. Ao selecionar esse valor, a opção dinâmica RemotePathserá exibida.

OverwriteFileAtDestination
Especifique se um arquivo no destino pode ser substituído.

IsLocalPathVariable
Indique se o caminho local deve ser armazenado em uma variável. As opções dessa propriedade são listadas na tabela a seguir.

Valor Descrição
Verdadeiro O caminho de destino é armazenado em uma variável. Ao selecionar esse valor, a opção dinâmica LocalVariableserá exibida.
Falso O caminho de destino é especificado em um gerenciador de conexões de Arquivo. Ao selecionar esse valor, a opção dinâmica LocalPathserá exibida.

Operação
Selecione a operação FTP a executar. As opções dessa propriedade são listadas na tabela a seguir.

Valor Descrição
Enviar arquivos Enviar arquivos. Ao selecionar esse valor, as opções dinâmicas LocalVariable, LocalPathRemoteVariable e RemotePathserão exibidas.
Receber arquivos Receber arquivos. Ao selecionar esse valor, as opções dinâmicas LocalVariable, LocalPathRemoteVariable e RemotePathserão exibidas.
Criar diretório local Criar um diretório local. Ao selecionar esse valor, as opções dinâmicas LocalVariable e LocalPathserão exibidas.
Criar diretório remoto Criar um diretório remoto. Ao selecionar esse valor, as opções dinâmicas RemoteVariable e RemotelPathserão exibidas.
Remover diretório local Remover diretório local. Ao selecionar esse valor, as opções dinâmicas LocalVariable e LocalPathserão exibidas.
Remover diretório remoto Remover um diretório remoto. Ao selecionar esse valor, as opções dinâmicas RemoteVariable e RemotePathserão exibidas.
Excluir arquivos locais Excluir arquivos locais. Ao selecionar esse valor, as opções dinâmicas LocalVariable e LocalPathserão exibidas.
Excluir arquivos remotos Excluir arquivos remotos. Ao selecionar esse valor, as opções dinâmicas RemoteVariable e RemotePathserão exibidas.

IsTransferASCII
Indique se os arquivos transferidos para e do servidor FTP remoto devem ser transferidos em modo ASCII.

Opções dinâmicas de IsRemotePathVariable

IsRemotePathVariable = True

RemoteVariable
Selecione uma variável definida pelo usuário existente ou clique em <Nova variável...> para criar uma variável definida pelo usuário.

Tópicos relacionados: variáveis do Integration Services (SSIS), Adicionar variável

IsRemotePathVariable = False

RemotePath
Selecione um gerenciador de conexões FTP existente ou clique em <Nova conexão…> para criar um gerenciador de conexões.

Tópicos relacionados:Gerenciador de Conexões de FTP, Editor do Gerenciador de Conexões de FTP

Opções dinâmicas de IsLocalPathVariable

IsLocalPathVariable = True

LocalVariable
Selecione uma variável definida pelo usuário existente ou clique em <Nova variável...> para criar uma variável.

Tópicos relacionados: variáveis do Integration Services (SSIS), Adicionar variável

IsLocalPathVariable = False

LocalPath
Selecione um gerenciador de conexões de arquivos existente ou clique em <Nova conexão…> para criar um gerenciador de conexões.

Tópicos relacionados: Gerenciador de Conexões de Arquivos Simples

Consulte Também

Tarefas do Integration Services
Fluxo de Controle