Connect to SFTP Data in CloverDX (formerly CloverETL)

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.



Transfer SFTP data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for SFTP enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with SFTP as sources and destinations. In this article, you will use the JDBC Driver for SFTP to set up a simple transfer into a flat file. The CData JDBC Driver for SFTP enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with SFTP as sources and destinations. In this article, you will use the JDBC Driver for SFTP to set up a simple transfer into a flat file.

Connect to SFTP as a JDBC Data Source

  1. Create the connection to SFTP data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.sftp.jar file.
  3. Enter the JDBC URL.

    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.

    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.

    A typical JDBC URL is below:

    jdbc:sftp:RemoteHost=MyFTPServer;

Query SFTP Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the SFTP JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT Filesize, Filename FROM MyDirectory WHERE FilePath = /documents/doc.txt

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the MyDirectory table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.