Bridge SFTP Connectivity with Apache NiFi

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SFTP JDBC Driver

An easy-to-use database-like interface for Java based applications and reporting tools access to remote files and directories.



Access and process SFTP data in Apache NiFi using the CData JDBC Driver.

Apache NiFi supports powerful and scalable directed graphs of data routing, transformation, and system mediation logic. When paired with the CData JDBC Driver for SFTP, NiFi can work with live SFTP data. This article describes how to connect to and query SFTP data from an Apache NiFi Flow.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live SFTP data. When you issue complex SQL queries to SFTP, the driver pushes supported SQL operations, like filters and aggregations, directly to SFTP and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze SFTP data using native data types.

Connecting to SFTP Data in Apache NiFi

  1. Download the CData JDBC Driver for SFTP installer, unzip the package, and run the JAR file to install the driver.
  2. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.sftp.jar (and cdata.jdbc.sftp.lic), to the Apache NiFi lib subfolder, for example, C:\nifi-1.3.0-bin\nifi-1.3.0\lib.

    On Windows, the default location for the CData JDBC Driver is C:\Program Files\CData\CData JDBC Driver for SFTP.

  3. Start Apache NiFi. For example:

    cd C:\nifi-1.3.0-bin\nifi-1.3.0\bin
    run-nifi.bat
    
  4. Navigate to the Apache NiFi UI in your web browser: typically http://localhost:8080/nifi
  5. Click the (Configuration) button from the Operate sidebar.
  6. In the NiFi Flow Configuration page, navigate to the Controller Services tab.
  7. Click the button to create a new controller service.
  8. In the Add Controller Service page, select DBCPConnection Pool, and then click Add.
  9. Click the gear button to configure the new DBCPConnection Pool.
  10. In the Configure Controller Service page, navigate to the Properties tab. Fill in the properties:

    PropertyValue
    Database Connection URLjdbc:sftp:RemoteHost=MyFTPServer;
    Database Driver Class Namecdata.jdbc.sftp.SFTPDriver

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the SFTP JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.sftp.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    SFTP can be used to transfer files to and from SFTP servers using the SFTP Protocol. To connect, specify the RemoteHost;. service uses the User and Password and public key authentication (SSHClientCert). Choose an SSHAuthMode and specify connection values based on your selection.

    Set the following connection properties to control the relational view of the file system:

    • RemotePath: Set this to the current working directory.
    • TableDepth: Set this to control the depth of subfolders to report as views.
    • FileRetrievalDepth: Set this to retrieve files recursively and list them in the Root table.
    Stored Procedures are available to download files, upload files, and send protocol commands. See gdatamodel for more on using SQL to interact with the server.

  11. Click the button to enable the new DBCPConnection Pool.

Your SFTP data is now available for use in Apache NiFi. For example, you can use the DBCPConnection Pool as the source for a QueryDatabaseTable processor.

Download a free, 30-day trial of the CData JDBC Driver for SFTP and start working with your live SFTP data in Apache NiFi. Reach out to our Support Team if you have any questions.