Learn more
 

Ready to get started?

Learn more:

SQL Server Connectivity Solutions

In this article

Related articles

Query SQL Server Data from Node.js


The API Server exposes Web services that allow connectivity to your data. Use the OData endpoint of the CData API Server to execute CRUD queries to SQL Server data from Node.js.

The CData API Server, when paired with the ADO.NET Provider for SQL Server, exposes SQL Server data (or data from any of 200+ other ADO.NET Providers) as an OData endpoint, which can be queried from Node.js using simple HTTP requests. This article shows how to use the API Server to request JSON-formatted SQL Server data in Node.js.

Set Up the API Server

Follow the steps below to begin producing secure SQL Server OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to SQL Server

After you deploy the API Server and the ADO.NET Provider for SQL Server, provide authentication values and other connection properties needed to connect to SQL Server by clicking Settings -> Connections and adding a new connection in the API Server administration console.

Connecting to Microsoft SQL Server

Connect to Microsoft SQL Server using the following properties:

  • Server: The name of the server running SQL Server.
  • User: The username provided for authentication with SQL Server.
  • Password: The password associated with the authenticating user.
  • Database: The name of the SQL Server database.

Connecting to Azure SQL Server and Azure Data Warehouse

You can authenticate to Azure SQL Server or Azure Data Warehouse by setting the following connection properties:

  • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to "SQL databases" (or "SQL data warehouses") -> "Select your database" -> "Overview" -> "Server name."
  • User: The name of the user authenticating to Azure.
  • Password: The password associated with the authenticating user.
  • Database: The name of the database, as seen in the Azure portal on the SQL databases (or SQL warehouses) page.

You can then choose the SQL Server entities you want to allow the API Server access to by clicking Settings -> Resources.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; all IP addresses except the local machine are restricted by default. You can authenticate as well as encrypt connections with SSL.

Consume SQL Server OData Feeds from Node.js

OData feeds are easy to work with in Node.js. You can use the HTTP client in Node.js to request JSON-formatted data from the API Server's OData endpoint. After making the request, you can construct the body of the response and call the JSON.parse() function to parse it into records.

The code below will make an authenticated request for Orders data. The example URL below applies a simple filter that searches for records with a value of USA in the ShipCountry column.

var http = require('http'); http.get({ protocol: "http:", hostname: "MyServer.com", port: MyPort, path: "/api.rsc/Orders?$filter=" + encodeURIComponent("ShipCountry eq 'USA'"), auth: 'MyUser:MyAuthtoken' }, function(res) { var body = ''; res.on('data', function(chunk) { body += chunk; }); res.on('end', function() { console.log(body); var jsonData = JSON.parse(body); }); }).on('error', function(e) { console.log("Error: ", e); });