We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Connect to SFTP Data in Ruby
Connect to SFTP data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.
The CData ODBC Driver for SFTP makes it easy to integrate connectivity to live SFTP data in Ruby. This article shows how to create a simple Ruby app that connects to SFTP data, executes a query, and displays the results.
Create an ODBC 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.
Installing Ruby and Necessary Gems
If you do not have Ruby installed, refer to the Ruby installation page. With Ruby installed, you will need to install the ruby-dbi, dbd-odbc, and ruby-odbc gems:
gem install dbi
gem install dbd-odbc
gem install ruby-odbc
Create a Ruby App with Connectivity to SFTP Data
Create a new Ruby file (for example: SFTPSelect.rb) and open it in a text editor. Copy the following code into your file:
#connect to the DSN
require 'dbi'
cnxn = DBI.connect('DBI:ODBC:CData SFTP Source','','')
#execute a SELECT query and store the result set
resultSet = cnxn.execute("SELECT Filesize, Filename FROM MyDirectory WHERE FilePath = /documents/doc.txt")
#display the names of the columns
resultSet.column_names.each do |name|
print name, "\t"
end
puts
#display the results
while row = resultSet.fetch do
(0..resultSet.column_names.size - 1).each do |n|
print row[n], "\t"
end
puts
end
resultSet.finish
#close the connection
cnxn.disconnect if cnxn
With the file completed, you are ready to display your SFTP data with Ruby. To do so, simply run your file from the command line:
ruby SFTPSelect.rb
Writing SQL-92 queries to SFTP allows you to quickly and easily incorporate SFTP data into your own Ruby applications. Download a free trial today!