Query FTP Data as a SQL Server Database in Node.js

You can use CData Connect AI to query FTP data through a SQL Server interface. Follow the procedure below to create a virtual database for FTP in Connect AI and start querying using Node.js.

CData Connect AI provides a pure MySQL, cloud-to-cloud interface for FTP, allowing you to easily query live FTP data in Node.js — without replicating the data to a natively supported database. As you query data in Node.js, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc) directly to FTP, leveraging server-side processing to quickly return FTP data.

Configure FTP Connectivity for NodeJS

Connectivity to FTP from NodeJS is made possible through CData Connect AI. To work with FTP data from NodeJS, we start by creating and configuring a FTP connection.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "FTP" from the Add Connection panel

3. Enter the necessary authentication properties to connect to FTP.

   To connect to FTP or SFTP servers, specify at least RemoteHost and FileProtocol. Specify the port with RemotePort.

   Set User and Password to perform Basic authentication. Set SSHAuthMode to use SSH authentication. See the Getting Started section of the data provider help documentation for more information on authenticating via SSH.

   Set SSLMode and SSLServerCert to secure connections with SSL.

   The data provider lists the tables based on the available folders in your FTP server. 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 folders to list as views.
   • FileRetrievalDepth: Set this to retrieve and list files recursively from the root table.

   Stored Procedures are available to download files, upload files, and send protocol commands. See the Data Model chapter of the FTP data provider documentation for more information.

   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add FTP Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to FTP data from Node.js.

Query FTP from Node.js

The following example shows how to define a connection and execute queries to FTP with the SQL Server module. You will need the following information:

• server: tds.cdata.com
• port: 14333
• user: a Connect AI user (e.g. [email protected])
• password: the PAT for the above user
• database: The connection you configured for FTP (FTP1)

Connect to FTP data and start executing queries with the code below:

var sql = require('mssql')
var config = {
	server: 'tds.cdata.com',
	port: 14333, 
	user: '[email protected]', //update me
	password: 'CONNECT_USER_PAT', //update me	
	options: {
		encrypt: true,
		database: 'FTP1'
	}
}

sql.connect(config, err => { 
    if(err){
        throw err ;
    }
    new sql.Request().query('SELECT * FROM MyDirectory', (err, result) => {
        console.dir(result)
    })
        
});

sql.on('error', err => {
    console.log("SQL Error: " ,err);
})