Query SFTP Data through ODBC in Node.js

Node.js is a JavaScript runtime environment that allows you to run JavaScript code outside of a browser. With the CData ODBC Driver for SFTP, you can access live SFTP data from Node.js apps and scripts. In this article, we walk through installing node-odbc and the required tools to create a simple Node.js app with access to live SFTP data.

With built-in optimized data processing, the CData ODBC Driver offers unmatched performance for interacting with live SFTP data in Node.js. When you issue complex SQL queries from Node.js to SFTP, the driver pushes supported SQL operations, like filters and aggregations, directly to SFTP and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to SFTP Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Building node-odbc

In order to connect to SFTP through the CData ODBC Driver, you need to build node-odbc manually (after installing the required tools).

Installing the Required Tools

The following commands install the tools required to build node-odbc (note the -g parameter, which installs the tools globally).

npm i -g windows-build-tools
npm i -g node-gyp

Building node-odbc

After installing the required tools, create a directory for the Node.js app and install odbc (which builds the binary for us to use in our Node.js script).

mkdir nodeodbc
cd nodeodbc
npm i -g node

Querying SFTP from Node.js

With the ODBC Driver installed, a DSN Configured, and node-odbc built, we are ready to query live SFTP data from a Node.js app. The sample code below connects to a specific DSN and queries the MyDirectory table.

myscript.js

const odbc = require('odbc');

async function querySFTP() {
 const connection = await odbc.connect(`DSN=CData SFTP Source`);
 const data = await connection.query('SELECT Filesize, Filename FROM MyDirectory');
 console.log(data);
}

querySFTP();

Once you write the app, use node to execute the script:

node myscript.js

👁 Sample program results (Salesforce is shown).

Download a free, 30-day trial of the CData ODBC Driver for SFTP and start working with your live SFTP data in Node.js. Reach out to our Support Team if you have any questions.