Build a Simple VCL Application for SFTP Data

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 retrieve and update SFTP data. This article will walk through connecting to SFTP and creating a simple VCL application with the Form Designer.

Create a Connection to SFTP Data

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 use the Data Explorer to create a FireDAC connection to SFTP data.

1. In a new VCL Forms application, expand the FireDAC node in the Data Explorer.
2. Right-click the ODBC Data Source node in the Data Explorer.
3. Click Add New Connection.
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.

👁 A FireDAC connection to the ODBC data source. (Salesforce is shown.)

Create VCL Applications with Connectivity to SFTP Data

Follow the procedure below to start executing queries to SFTP data from a simple VCL application that displays the results of a query in a grid.

1. Drop a TFDConnection component onto the form and set the following properties:

   • ConnectionDefName: Select the FireDAC connection to SFTP data.
   • Connected: Select True from the menu and, in the dialog that appears, enter your credentials.

2. Drop a TFDQuery component onto the form and set the properties below:

   • Connection: Set this property to the TFDConnection component, if this component is not already specified.

   • SQL: Click the button in the SQL property and enter a query. For example:

     SELECT Filesize, Filename FROM MyDirectory WHERE FilePath = /documents/doc.txt
     

   • Active: Set this property to true.

3. Drop a TDataSource component onto the form and set the following property:

   • DataSet: In the menu for this property, select the name of the TFDQuery component.

4. Drop a TDBGrid control onto the form and set the following property:

   • DataSource: Select the name of the TDataSource.
5. Drop a TFDGUIxWaitCursor onto the form — this is required to avoid a run-time error.

👁 Components in FireDAC used to databind an editable grid to the data source. (Salesforce is shown.)

You now have an executable application that displays the results of the SQL Query set in the TFDQuery object.

👁 The Data Displayed in 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
• Viewing SFTP Data in RAD Studio Data Explorer