tap-sftp - Meltano Hub

SFTP

tap-sftp (meltanolabs variant)🥈

File Transfer Protocl

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
```
:

meltano add extractor tap-sftp

Configure the tap-sftp settings using

meltano config

:

meltano config tap-sftp set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-sftp test

Next 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:

decryption_configs
host
password
port
private_key_file
request_timeout
start_date
tables
username

You can also list these settings using

meltano config

with the list 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.

Decryption Configs (decryption_configs)

Environment variable: TAP_SFTP_DECRYPTION_CONFIGS

A configuration for using AWS SSM Parameter Store as the source for the private key file. The tap will download the private key from SSM and use it to authenticate. The keys required are - SSM_key_name, gnupghome, passphrase.

Configure this setting directly using the following Meltano command:

meltano config tap-sftp set decryption_configs [value]

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 (Array containing the unique keys of the table. Defaults to ['_sdc_source_file', '_sdc_source_lineno'], representing the file name and line number. Specify an emtpy array ([]) to load all new files without a replication key), delimiter, encoding (defaults to utf-8), sanitize_header (specifies whether to clean up header names so that they are more likely to be accepted by a target SQL database. Replacing things like columns starting with numbers, special characters with underscores, etc.).

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?

If you're having trouble getting the tap-sftp extractor 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.

Install

meltano add extractor tap-sftp

Maintenance Status

Repo

https://github.com/MeltanoLabs/tap-sftp

Maintainer

Keywords