The tap-sftp extractor pulls data from SFTP that can then be sent to a destination using a loader.
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-sftp extractor to your
project using
:meltano add -
Configure the tap-sftp
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-sftp --variant singer-iomeltano config tap-sftp set --interactivemeltano config tap-sftp testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-sftp
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- catalog
- discover
- state
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-sftp settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-sftp list
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 plugin.
Host (host)
-
Environment variable:
TAP_SFTP_HOST
The SFTP server hostname.
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set host [value]Password (password)
-
Environment variable:
TAP_SFTP_PASSWORD
The pass for connecting the the SFTP server.
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set password [value]Port (port)
-
Environment variable:
TAP_SFTP_PORT
The SFTP server port.
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set port [value]Private Key File (private_key_file)
-
Environment variable:
TAP_SFTP_PRIVATE_KEY_FILE
A path to the private key file for connecting the the SFTP server.
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set private_key_file [value]Request Timeout (request_timeout)
-
Environment variable:
TAP_SFTP_REQUEST_TIMEOUT
The SFTP connection timeout in seconds. Defaults to 300.
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set request_timeout [value]Start Date (start_date)
-
Environment variable:
TAP_SFTP_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.
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set start_date [value]Tables (tables)
-
Environment variable:
TAP_SFTP_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.
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set tables [value]Username (username)
-
Environment variable:
TAP_SFTP_USERNAME
The username for connecting the the SFTP server.
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set username [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general
