How to connect to SFTP Data with Squirrel SQL client

The CData JDBC Driver for SFTP enables you to execute queries to SFTP data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for SFTP data and execute queries.

Add the JDBC Driver for SFTP

Follow the steps below to add the driver JAR.

1. In Squirrel SQL, click Windows -> View Drivers.
2. Click the plus icon to open the Add Driver wizard.
3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for SFTP.
4. In the Example URL box, enter jdbc:sftp:
5. In the Extra Class Path tab, click Add.
6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.sftp.SFTPDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

1. Click Windows -> View Aliases.
2. In the pane that lists the aliases, click the plus icon.

3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

   • Name: Enter a name for the alias; for example, CData SFTP Source.
   • Driver: Select the CData JDBC Driver for SFTP.
   • URL: Enter jdbc:sftp:
4. If you want to define any additional properties, click Properties.
5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
6. In the Specify column, select the checkboxes for the required connection properties.

   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.

   Below is a typical connection string:

   jdbc:sftp:RemoteHost=MyFTPServer;
7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query SFTP Data

After the metadata has loaded, a new tab for the SFTP data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example: