The tap-sftp Singer tap pulls data from SFTP that can then be sent to a destination using a Singer target.

Alternative variants #

Multiple variants of tap-sftp are available. This document describes the default singer-io variant, which is recommended for new users.

Alternative variants are:

Standalone usage #

Install the package using pip:

pip install tap-sftp

For additional instructions, refer to the README in the repository.

Usage with Meltano #

Meltano helps you manage your configuration, incremental replication, and scheduled pipelines.

View the Meltano-specific tap-sftp instructions to learn more.

Capabilities #

These capabilities can also be overriden by specifying the capabilities key in your meltano.yml file.

Settings #

tap-sftp requires the configuration of the following settings:

The settings for tap tap-sftp that are known to Meltano are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

You can override these settings or specify additional ones in your meltano.yml by adding the settings key. Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this tap.

Host (host) #

The SFTP server hostname.

Port (port) #

The SFTP server port.

Username (username) #

The username for connecting the the SFTP server.

Password (password) #

The pass for connecting the the SFTP server.

Private Key File (private_key_file) #

A path to the private key file for connecting the the SFTP server.

Tables (tables) #

An array that consists of one or more objects that describe how to find files and emit records. Required in each table object - table_name, search_pattern,search_prefix, key_properties, delimiter.

Start Date (start_date) #

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

Request Timeout (request_timeout) #

The SFTP connection timeout in seconds. Defaults to 300.

Looking for help? #

If you're having trouble getting the tap-sftp tap to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!