How to Connect DBeaver to SFTP via a JDBC Driver

The CData JDBC Driver for SFTP implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to SFTP data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for SFTP Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for SFTP).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.sftp.SFTPDriver.
   • Set URL Template to jdbc:sftp:.
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.SFTP.jar).

Create a Connection to SFTP Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for SFTP) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using 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.

   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.

   Below is a typical connection string:

   jdbc:sftp:RemoteHost=MyFTPServer;
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query SFTP Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial