Query PostgreSQL Data through ODBC in Node.js

Node.js is a JavaScript runtime environment that allows you to run JavaScript code outside of a browser. With the CData ODBC Driver for PostgreSQL, you can access live PostgreSQL data from Node.js apps and scripts. In this article, we walk through installing node-odbc and the required tools to create a simple Node.js app with access to live PostgreSQL data.

With built-in optimized data processing, the CData ODBC Driver offers unmatched performance for interacting with live PostgreSQL data in Node.js. When you issue complex SQL queries from Node.js to PostgreSQL, the driver pushes supported SQL operations, like filters and aggregations, directly to PostgreSQL and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to PostgreSQL Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

To connect to PostgreSQL, set the Server, Port (the default port is 5432), and Database connection properties and set the User and Password you wish to use to authenticate to the server. If the Database property is not specified, the data provider connects to the user's default database.

SSH Connectivity for PostgreSQL

You can use SSH (Secure Shell) to authenticate with PostgreSQL, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).

SSH Connections to PostgreSQL in Password Auth Mode

To connect to PostgreSQL via SSH in Password Auth mode, set the following connection properties:

• User: PostgreSQL User name
• Password: PostgreSQL Password
• Database: PostgreSQL database name
• Server: PostgreSQL Server name
• Port: PostgreSQL port number like 3306
• UserSSH: "true"
• SSHAuthMode: "Password"
• SSHPort: SSH Port number
• SSHServer: SSH Server name
• SSHUser: SSH User name
• SSHPassword: SSH Password

SSH Connections to PostgreSQL in Public Key Auth Mode

To connect to PostgreSQL via SSH in Password Auth mode, set the following connection properties:

• User: PostgreSQL User name
• Password: PostgreSQL Password
• Database: PostgreSQL database name
• Server: PostgreSQL Server name
• Port: PostgreSQL port number like 3306
• UserSSH: "true"
• SSHAuthMode: "Public_Key"
• SSHPort: SSH Port number
• SSHServer: SSH Server name
• SSHUser: SSH User name
• SSHClientCret: the path for the public key certificate file

Building node-odbc

In order to connect to PostgreSQL through the CData ODBC Driver, you need to build node-odbc manually (after installing the required tools).

Installing the Required Tools

The following commands install the tools required to build node-odbc (note the -g parameter, which installs the tools globally).

npm i -g windows-build-tools
npm i -g node-gyp

Building node-odbc

After installing the required tools, create a directory for the Node.js app and install odbc (which builds the binary for us to use in our Node.js script).

mkdir nodeodbc
cd nodeodbc
npm i -g node

Querying PostgreSQL from Node.js

With the ODBC Driver installed, a DSN Configured, and node-odbc built, we are ready to query live PostgreSQL data from a Node.js app. The sample code below connects to a specific DSN and queries the Orders table.

myscript.js

const odbc = require('odbc');

async function queryPostgreSQL() {
 const connection = await odbc.connect(`DSN=CData PostgreSQL Source`);
 const data = await connection.query('SELECT ShipName, ShipCity FROM Orders');
 console.log(data);
}

queryPostgreSQL();

Once you write the app, use node to execute the script:

node myscript.js

👁 Sample program results (Salesforce is shown).

Download a free, 30-day trial of the CData ODBC Driver for PostgreSQL and start working with your live PostgreSQL data in Node.js. Reach out to our Support Team if you have any questions.