Ready to get started?

Learn more about the CData ODBC Driver for SFTP or download a free trial:

Download Now

Connect to SFTP Data from PowerBuilder

This article demonstrates how to use the CData ODBC Driver for SFTP to connect to SFTP data and execute queries in PowerBuilder.

The CData ODBC Driver for SFTP can be used from any platform or development technology that supports ODBC, including PowerBuilder. This article shows how to connect to SFTP data and execute queries from the Database Painter and controls such as the DataWindow.

Connect to SFTP as an ODBC Data Source

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.

Create a Profile for the ODBC Driver for SFTP

Follow the steps below to use the Database Painter tool to create a database profile based on an ODBC DSN (data source name) for SFTP. In the Database Painter, you can use wizards and the UI to work with SFTP data.

  1. In PowerBuilder, click Tools -> Database Painter.
  2. In the Objects window in the Database Painter, right-click the ODBC node and click New Profile.
  3. On the Connection tab, enter a name for the profile and select the SFTP DSN in the Data Source menu.
  4. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using SFTP Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to ODBC data sources and execute queries. The following example shows how to retrieve SFTP data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "ODBC" SQLCA.DBParm = "ConnectString='DSN=CData SFTP Source'" CONNECT USING SQLCA; dw_mydirectory.SetTransObject(SQLCA); dw_mydirectory.Retrieve();