Viewing SFTP Data in RAD Studio Data Explorer

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for SFTP, you gain access to live SFTP data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to both retrieve and update SFTP data. This article will walk through connecting to SFTP using the Data Explorer.

Configure a Connection to SFTP

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.

Connecting to SFTP Data Using Data Explorer

You can create a simple application for displaying SFTP data by utilizing the CData FireDAC Components for SFTP and a new VCL Forms Application:

1. Open the Data Explorer in RAD Studio and expand FireDAC.
2. Right-click the ODBC Data Source node in the Data Explorer.
3. Click Add New Connection. 👁 Adding a New Connection. (Salesforce is shown.)
   
4. Enter a name for the connection.
5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for SFTP. 👁 Setting the Connection Parameters. (Salesforce is shown.)
   
6. Back in the Data Explorer, expand the tables for the connection.

7. Create a new VCL Forms application and drag a table (for example: MyDirectory) onto the form.

   👁 Placing the Table on the Form. (Salesforce is shown.)
   
8. Select the MyDirectoryTable object on the form and set the Active property to true.

9. Right-click on the object, bind visually, and link everything (*) to a new control (TStringGrid).

   👁 Visually Binding the Table. (Salesforce is shown.)
   

10. Arrange the TStringGrid on the form and run the application to see the MyDirectory data.

    👁 The Table data on a Form. (Salesforce is shown.)
    

Related Articles

Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.

• DataBind Controls to SFTP Data in C++Builder
• DataBind Controls to SFTP Data in Delphi
• Build a Simple VCL Application for SFTP Data