Query SFTP Data in MySQL Workbench

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.



Execute MySQL queries against live SFTP data from MySQL Workbench.

You can use the SQL Gateway from the ODBC Driver for SFTP to query SFTP data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live SFTP data in MySQL Workbench.

Connect to SFTP Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to SFTP data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query SFTP from MySQL Workbench

The steps below outline connecting to the virtual SFTP database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live SFTP data.

Connect to SFTP through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for SFTP).
  3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
  4. Click Store in Vault to set and store the password.
  5. Click Test Connection to ensure the connection is configured properly and click OK.

Query SFTP Data

  1. Open the connection you just created (CData SQL Gateway for SFTP).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve SFTP data, like SELECT * FROM `CData SFTP Sys`.MyDirectory;

With access to live SFTP data from MySQL Workbench, you can easily query and update SFTP, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for SFTP and the CData SQL Gateway.