Ready to get started?

Learn more or sign up for a free trial:

CData Connect Server

Query FTP Data as a SQL Server in Node.js



Execute SQL Server queries against FTP data from Node.js.

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

CData Connect Server provides a pure SQL Server interface for FTP, allowing you to easily build reports from live FTP data in Node.js — without replicating the data to a natively supported database. As you build visualizations, Node.js generates SQL queries to gather data. Using optimized data processing out of the box, CData Connect Server pushes all supported SQL operations (filters, JOINs, etc) directly to FTP, leveraging server-side processing to quickly return the requested FTP data.

Create a Virtual SQL Server Database for FTP Data

CData Connect Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Login to Connect Server and click Connections.
  2. Select "FTP" from Available Data Sources.
  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 Changes
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, 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:

  • Host name, or address, and port: The address of your Connect Server instance and the port (1433)
  • Username and password: The username and password of a user you authorized on Connect Server
  • Database name: The database you configured for FTP (FTP1)

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

const sql = require('mssql');

const config = {
    user: 'your_connect_username', 
    password: 'your_connect_password', 
    server: 'connect_server_url', 
    port: 1433, // optional, defaults to 1433
    database: 'FTP1',
    authentication: {
        type: 'default'
    },
    options: {
        encrypt: true
    }
}

console.log("Starting...");
connectAndQuery();

async function connectAndQuery() {
    try {
        var poolConnection = await sql.connect(config);

        console.log("Reading rows from the table...");
        var resultSet = await poolConnection.request().query(`SELECT * FROM table_name`);

        console.log(`${resultSet.recordset.length} rows returned.`);

        // output column headers
        var columns = "";
        for (var column in resultSet.recordset.columns) {
            columns += column + ", ";
        }
        console.log("%s	", columns.substring(0, columns.length - 2));

        // ouput row contents from default record set
        resultSet.recordset.forEach(row => {
            console.log("%s	%s", row.CategoryName, row.ProductName);
        });

        // close connection only when we're certain application is finished
        poolConnection.close();
    } catch (err) {
        console.error(err.message);
    }
}

SQL Server Access to FTP Data from Node.js

You have retrieved live FTP Data using Node.js. Now, you can easily access data sources and more — all without replicating FTP data.

To get SQL data access to 200+ SaaS, Big Data, and NoSQL sources directly from your applications, try CData Connect Server.