Ready to get started?

Learn more about the CData JDBC Driver for SFTP or download a free trial:

Download Now

Connect to SFTP Data in DBeaver

Manage SFTP data with visual tools in DBeaver like the query browser.

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 Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
  2. In the Driver Name box, enter a user-friendly name for the driver.
  3. To add the .jar, click Add File.
  4. In the create new driver dialog that appears, select the cdata.jdbc.sftp.jar file, located in the lib subfolder of the installation directory.
  5. Click the Find Class button and select the SFTPDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.sftp.SFTPDriver.
  6. Add jdbc:sftp: in the URL Template field.

Create a Connection to SFTP Data

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

  1. In the Databases menu, click New Connection.
  2. In the Create new connection wizard that results, select the driver.
  3. On the next page of the wizard, click the driver properties tab.
  4. Enter values for authentication credentials and other properties required to connect to SFTP.

    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;

Query SFTP Data

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

 
 
ダウンロード