Ready to get started?

Learn more or sign up for a free trial:

CData Connect Server

Query REST Data as a SQL Server in Node.js



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

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

CData Connect Server provides a pure SQL Server interface for REST, allowing you to easily build reports from live REST 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 REST, leveraging server-side processing to quickly return the requested REST data.

Create a Virtual SQL Server Database for REST 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 "REST" from Available Data Sources.
  3. Enter the necessary authentication properties to connect to REST.

    See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models REST APIs as bidirectional database tables and XML/JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

    After setting the URI and providing any authentication values, set Format to "XML" or "JSON" and set DataModel to more closely match the data representation to the structure of your data.

    The DataModel property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

    • Document (default): Model a top-level, document view of your REST data. The data provider returns nested elements as aggregates of data.
    • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
    • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

    See the Modeling REST Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

  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 REST data from Node.js.

Query REST from Node.js

The following example shows how to define a connection and execute queries to REST 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 REST (REST1)

Connect to REST 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: 'REST1',
    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 REST Data from Node.js

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

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