Ready to get started?

Download a free trial of the SFTP ODBC Driver to get started:

 Download Now

Learn more:

SFTP Icon 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.

Access SFTP Data from MySQL in PHP



Connect to SFTP through the standard MySQL libraries in PHP.

You can use the CData SQL Gateway and ODBC Driver for SFTP to access SFTP data from MySQL clients, without needing to perform an ETL or cache data. Follow the steps below to connect to SFTP data in real time through PHP's standard MySQL interfaces, mysqli and PDO_MySQL.

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.

Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Connect in PHP

The following examples show how to use object-oriented interfaces to connect and execute queries. Initialize the connection object with the following parameters to connect to the virtual MySQL database:

  • Host: Specify the remote host location where the service is running. In this case "localhost" is used for the remote host setting since the service is running on the local machine.
  • Username: Specify the username for a user you authorized on the SQL Gateway's Users tab.
  • Password: Specify the password for the authorized user account.
  • Database Name: Specify the system DSN as the database name.
  • Port: Specify the port the service is running on; port 3306 in this example.

mysqli

<?php
$mysqli = new mysqli("localhost", "user", "password", "CData SFTP Sys","3306");
?>

PDO

<?php
$pdo = new PDO('mysql:host=localhost;dbname=CData SFTP Sys;port=3306', 'user', 'password');
?>

Query in PHP

With the connection established, you can then access tables. The following steps walk through the example:

  1. Query the table; for example, MyDirectory. The results will be stored as an associative array in the $result object.
  2. Iterate over each row and column, printing the values to display in the PHP page.
  3. Close the connection.

mysqli

$result = $mysqli->query("SELECT Filesize, Filename FROM MyDirectory WHERE FilePath = /documents/doc.txt");
while($row = $result->fetch_assoc()) {
  foreach ($row as $k=>$v) {
    echo "$k : $v";
    echo "<br>"; 
  }
}
$mysqli->close();

PDO

$result = $pdo->query("SELECT Filesize, Filename FROM MyDirectory WHERE FilePath = /documents/doc.txt");
while($row = $result->fetch(PDO::FETCH_ASSOC)) {
  foreach ($row as $k=>$v) {
    echo "$k : $v";
    echo "<br>"; 
  }
}
$result = null;
$pdo = null;