VOOZH about

URL: https://www.cdata.com/kb/tech/postgresql-cloud-nodejs.rst

โ‡ฑ Query PostgreSQL Data as a SQL Server Database in Node.js


Query PostgreSQL Data as a SQL Server Database in Node.js

๐Ÿ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Execute SQL Server queries against PostgreSQL data from Node.js.

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

CData Connect AI provides a pure MySQL, cloud-to-cloud interface for PostgreSQL, allowing you to easily query live PostgreSQL data in Node.js โ€” without replicating the data to a natively supported database. As you query data in Node.js, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc) directly to PostgreSQL, leveraging server-side processing to quickly return PostgreSQL data.

Configure PostgreSQL Connectivity for NodeJS

Connectivity to PostgreSQL from NodeJS is made possible through CData Connect AI. To work with PostgreSQL data from NodeJS, we start by creating and configuring a PostgreSQL connection.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. ๐Ÿ‘ Adding a Connection
  3. Select "PostgreSQL" from the Add Connection panel
  4. ๐Ÿ‘ Selecting a data source
  5. Enter the necessary authentication properties to connect to PostgreSQL.

    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
    ๐Ÿ‘ Configuring a connection (Salesforce is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add PostgreSQL Connection page and update the User-based permissions. ๐Ÿ‘ Updating permissions

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

  1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create. ๐Ÿ‘ Creating a new PAT
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to PostgreSQL data from Node.js.

Query PostgreSQL from Node.js

The following example shows how to define a connection and execute queries to PostgreSQL with the SQL Server module. You will need the following information:

  • server: tds.cdata.com
  • port: 14333
  • user: a Connect AI user (e.g. [email protected])
  • password: the PAT for the above user
  • database: The connection you configured for PostgreSQL (PostgreSQL1)

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

var sql = require('mssql')
var config = {
	server: 'tds.cdata.com',
	port: 14333, 
	user: '[email protected]', //update me
	password: 'CONNECT_USER_PAT', //update me	
	options: {
		encrypt: true,
		database: 'PostgreSQL1'
	}
}

sql.connect(config, err => { 
 if(err){
 throw err ;
 }
 new sql.Request().query('SELECT * FROM Orders', (err, result) => {
 console.dir(result)
 })
 
});

sql.on('error', err => {
 console.log("SQL Error: " ,err);
})