Manage SFTP Data in DBArtisan as a JDBC Source

The CData JDBC Driver for SFTP seamlessly integrates SFTP data into database management tools like DBArtisan by enabling you to access SFTP data as a database. This article shows how to create a JDBC source for SFTP in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate SFTP Data into DBArtisan Projects

Follow the steps below to register SFTP data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in 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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

   jdbc:sftp:RemoteHost=MyFTPServer;

6. Finish the wizard to connect to SFTP data. SFTP entities are displayed in the Datasource Explorer.

You can now work with SFTP data as you work with any other database. See the driver help documentation for more information on the queries supported by the SFTP API.