Ready to get started?

Learn more or sign up for a free trial:

CData Connect Server

Query Harvest Data as a SQL Server in Node.js



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

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

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

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

    Start by setting the Profile connection property to the location of the Harvest Profile on disk (e.g. C:\profiles\Harvest.apip). Next, set the ProfileSettings connection property to the connection string for Harvest (see below).

    Harvest API Profile Settings

    To authenticate to Harvest, you can use either Token authentication or the OAuth standard. Use Basic authentication to connect to your own data. Use OAuth to allow other users to connect to their data.

    Using Token Authentication

    To use Token Authentication, set the APIKey to your Harvest Personal Access Token in the ProfileSettings connection property. In addition to APIKey, set your AccountId in ProfileSettings to connect.

    Using OAuth Authentication

    First, register an OAuth2 application with Harvest. The application can be created from the "Developers" section of Harvest ID.

    After setting the following connection properties, you are ready to connect:

    • ProfileSettings: Set your AccountId in ProfileSettings.
    • AuthScheme: Set this to OAuth.
    • OAuthClientId: Set this to the client ID that you specified in your app settings.
    • OAuthClientSecret: Set this to the client secret that you specified in your app settings.
    • CallbackURL: Set this to the Redirect URI that you specified in your app settings.
    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage how the driver obtains and refreshes the OAuthAccessToken.
  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 Harvest data from Node.js.

Query Harvest from Node.js

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

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

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

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