The tap-sftp
extractor
pulls data from
SFTP that can
then be sent to a destination using a
loader.
Airbyte Usage Notice
Container-based connectors
can introduce deployment challenges including the potential need to run
Docker-in-Docker (not currently supported by services like AWS ECS, Meltano
Cloud, etc. see
FAQ
and
Airbyte's ECS deployment docs
for more details). Before using this variant we recommend considering if/how
you will be able to deploy container-based connectors to production.
For more context on how this Airbyte integration works please checkout out the
FAQ in the Meltano Docs.
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 airbytemeltano 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:
- about
- catalog
- discover
- schema-flattening
- state
- stream-maps
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:
airbyte_config.credentials.auth_methodairbyte_config.credentials.auth_ssh_keyairbyte_config.credentials.auth_user_passwordairbyte_config.file_patternairbyte_config.file_typesairbyte_config.folder_pathairbyte_config.hostairbyte_config.portairbyte_config.userairbyte_spec.imageairbyte_spec.tagdocker_mounts
Expand To Show SDK Settings
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.
Airbyte Config Credentials Auth Method (airbyte_config.credentials.auth_method)
-
Environment variable:
TAP_SFTP_AIRBYTE_CONFIG_CREDENTIALS_AUTH_METHOD
SSH_PASSWORD_AUTH, SSH_KEY_AUTH
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set airbyte_config credentials.auth_method [value]Airbyte Config Credentials Auth Ssh Key (airbyte_config.credentials.auth_ssh_key)
-
Environment variable:
TAP_SFTP_AIRBYTE_CONFIG_CREDENTIALS_AUTH_SSH_KEY
OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set airbyte_config credentials.auth_ssh_key [value]Airbyte Config Credentials Auth User Password (airbyte_config.credentials.auth_user_password)
-
Environment variable:
TAP_SFTP_AIRBYTE_CONFIG_CREDENTIALS_AUTH_USER_PASSWORD
OS-level password for logging into the jump server host
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set airbyte_config credentials.auth_user_password [value]Airbyte Config File Pattern (airbyte_config.file_pattern)
-
Environment variable:
TAP_SFTP_AIRBYTE_CONFIG_FILE_PATTERN
The regular expression to specify files for sync in a chosen Folder Path
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set airbyte_config file_pattern [value]Airbyte Config File Types (airbyte_config.file_types)
-
Environment variable:
TAP_SFTP_AIRBYTE_CONFIG_FILE_TYPES
Coma separated file types. Currently only 'csv' and 'json' types are supported.
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set airbyte_config file_types [value]Airbyte Config Folder Path (airbyte_config.folder_path)
-
Environment variable:
TAP_SFTP_AIRBYTE_CONFIG_FOLDER_PATH
The directory to search files for sync
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set airbyte_config folder_path [value]Airbyte Config Host (airbyte_config.host)
-
Environment variable:
TAP_SFTP_AIRBYTE_CONFIG_HOST
The server host address
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set airbyte_config host [value]Airbyte Config Port (airbyte_config.port)
-
Environment variable:
TAP_SFTP_AIRBYTE_CONFIG_PORT
The server port
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set airbyte_config port [value]Airbyte Config User (airbyte_config.user)
-
Environment variable:
TAP_SFTP_AIRBYTE_CONFIG_USER
The server user
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set airbyte_config user [value]Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_SFTP_AIRBYTE_SPEC_IMAGE -
Default Value:
airbyte/source-sftp
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set airbyte_spec image [value]Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_SFTP_AIRBYTE_SPEC_TAG -
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set airbyte_spec tag [value]Docker Mounts (docker_mounts)
-
Environment variable:
TAP_SFTP_DOCKER_MOUNTS
Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set docker_mounts [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_SFTP_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_SFTP_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_SFTP_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_SFTP_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-sftp set stream_maps [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-yellow){kind=icon}
