SFTP Connector (Source and Sink) for Confluent Platform
The Kafka Connect SFTP Source Connector provides the capability to watch an SFTP directory for files and read the data as new files are written to the SFTP input directory. Once a file has been read, it is placed into the configured finished.path
directory. Each record in the input file is converted based on the user-supplied schema or an auto-generated schema.
The Kafka Connect SFTP Sink connector exports data from Apache Kafka® topics to files in an SFTP directory. Supported format are CSV/TSV, Avro, JSON and Parquet.
Prerequisites
The following are required to run the Connect SFTP Connector:
- Kafka Broker: Confluent Platform 3.3.0 or above, or Kafka 0.11.0 or above
- Connect: Confluent Platform 4.0.0 or above, or Kafka 1.0.0 or above
- Java 1.8
Install the SFTP Connector
You can install this connector by using the instructions or you can
manually download the ZIP file.
Install the connector using Confluent Hub
- Prerequisite
- Confluent Hub Client must be installed. This is installed by default with Confluent Enterprise.
Navigate to your Confluent Platform installation directory and run the following command to install the latest (latest
) connector version. The connector must be installed on every machine where Connect will run.
confluent-hub install confluentinc/kafka-connect-sftp:latest
You can install a specific version by replacing latest
with a version number. For example:
confluent-hub install confluentinc/kafka-connect-sftp:1.1.0-preview
Configuration Properties
For a complete list of configuration properties for the sink connector, see SFTP Sink Connector Configuration Properties.
For a list of configuration properties for the source connectors, refer to the specific connector documentation.
Additional Documentation
SFTP CONNECTOR SOURCE AND SINK