Connect to SFTP Data in DBArtisan

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SFTP ODBC Driver

The SFTP ODBC Driver is a powerful tool that allows you to connect with live data from remote files and directories, directly from any applications that support ODBC connectivity.

Access remote data like you would a database through a standard ODBC Driver interface.



Use wizards in DBArtisan to configure SFTP data as a data source.

The CData ODBC 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 an data source for SFTP in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.

Integrate SFTP Data into DBArtisan Projects

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

You can then 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 ODBC.
  3. Enter a name for the data source and select the DSN.
  4. 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.