VOOZH about

URL: https://www.cdata.com/kb/tech/sftp-odbc-coldfusion.rst

⇱ Import Real-Time SFTP Data via ODBC in ColdFusion to Build Applications

Import Real-Time SFTP Data via ODBC in ColdFusion to Build Applications

👁 Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
Use CData ODBC drivers to import and use SFTP data in ColdFusion.

Adobe ColdFusion is a web and mobile application development platform. It uses its own scripting language, ColdFusion Markup Language (CFML), to create data-driven websites as well as generate remote services, such as REST. When ColdFusion is paired with the CData ODBC Driver for SFTP, you can link your ColdFusion web and mobile applications to operational SFTP data. This allows for your applications to be more robust and complete. This article details how to use the ODBC driver to create a table populated with SFTP data from within a ColdFusion markup file.

To follow along with this tutorial, you need to install the CData ODBC Driver for SFTP and Adobe ColdFusion.

Configuring the Connection

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 process. 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.

Adding a Data Source and Creating a Table

After creating a DSN, follow the steps below to add a new data source, test our connection to it, create a ColdFusion markup file, and, finally, import SFTP Data and display it in a table in ColdFusion:

  1. From the ColdFusion administrator interface, choose Data & Services. 👁 Selecting Data & Services
  2. Here, click "Add New Data Source". The data source name can be any name, provided it conforms to the ColdFusion variable naming conventions. For our ODBC driver, choose "ODBC Socket", then click the "Add" button. 👁 Adding Data Source Name
  3. From the ODBC DSN Dropdown menu select CData SFTP Sys. Under the Advanced Settings section, leave the Connection String blank. Note that any properties specified in this input field will override the ones specified in the DSN Configuration. 👁 Populating driver properties
  4. Now, test the connection by pressing the check mark to the left of the CDataSFTPODBC data source you just created. When the data source reports an "OK" status, it is ready for use. 👁 Testing the connection
  5. Next, create a new ColdFusion Markup file (.cfm) and place it in the wwwroot directory ("C:\ColdFusion2021\cfusion\wwwroot") for ColdFusion.

    The following code queries the data source: 

     
 <cfquery name="SFTPQuery" dataSource="CDataSFTPODBC"> 
 SELECT * FROM MyDirectory 
 </cfquery>
    And a CFTable can be used to quickly output the table in HTML: 
     
 <cftable 
 query = "SFTPQuery" 
 border = "1" 
 colHeaders 
 colSpacing = "2" 
 headerLines = "2" 
 HTMLTable 
 maxRows = "500" 
 startRow = "1"> 

 <cfcol header="<b>Filesize</b>" align="Left" width=2 text="Filesize"/> 

 <cfcol header="<b>Filename</b>" align="Left" width=15 text="Filename"/> 

 ...

 </cftable>
    Full code, including the HTML portion is available below: 
     
 <html> 
 <head><title>CData Software | SFTP MyDirectory Table Demo </title></head> 
 <body> 
 <cfoutput>#ucase("SFTP MyDirectory Table Demo")#</cfoutput> 
 <cfquery name="SFTPQuery" dataSource="CDataSFTPODBC"> 

 SELECT * FROM MyDirectory 

 </cfquery> 
 <cftable 
 query = "SFTPQuery" 
 border = "1" 
 colHeaders 
 colSpacing = "2" 
 headerLines = "2" 
 HTMLTable 
 maxRows = "500" 
 startRow = "1"> 
 <cfcol header="<b>Filesize</b>" align="Left" width=2 text="Filesize"/> 

 <cfcol header="<b>Filename</b>" align="Left" width=15 text="Filename"/> 

 ...

 </cftable> 
 </body> 

 </html>
  6. Finally, run the code in a browser. It produces a table populated with SFTP data! 👁 Running the code

As a note, the CData ODBC Drivers also support parameterized queries using the cfqueryparam element. For example: 

SELECT * FROM Account WHERE name =

Get Started Today

Download a free, 30-day trial of the CData ODBC Driver for SFTP and start building SFTP-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.

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.