Ready to get started?

Learn more or sign up for a free trial:

CData Connect Server

Query SFTP Data in MySQL Workbench

Create a virtual MySQL database for SFTP data in CData Connect (or Connect Server) and work with live SFTP data in MySQL Workbench.

MySQL Workbench allows users to administer MySQL environments and gain better visibility into databases. When paired with CData Connect (on-premise or Connect Server), you get live access to SFTP data as if it were a MySQL database. This article shows how to create a virtual database for SFTP in Connect and work with live SFTP data in MySQL Workbench.

Create a Virtual MySQL Database for SFTP Data

CData Connect uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Login to Connect and click Connections.
  2. Select "SFTP" from Available Data Sources.
  3. Enter the necessary authentication properties 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.

  4. Click Save Changes
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to SFTP from MySQL Workbench.

Query SFTP from MySQL Workbench

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

Connect to SFTP through Connect

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData Connect).
  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 Connect).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve SFTP data, like SELECT * FROM sftpdb.MyDirectory;

With access to live SFTP data from MySQL Workbench, you can easily query and update SFTP, just like you would a MySQL database. Request a demo of the CData Connect and start working with SFTP just like a MySQL database today.