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

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

CData Connect AI provides a pure MySQL, cloud-to-cloud interface for AlloyDB, allowing you to easily query live AlloyDB 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 AlloyDB, leveraging server-side processing to quickly return AlloyDB data.

Configure AlloyDB Connectivity for NodeJS

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

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "AlloyDB" from the Add Connection panel
👁 Selecting a data source

3. Enter the necessary authentication properties to connect to AlloyDB.

   The following connection properties are usually required in order to connect to AlloyDB.

   • Server: The host name or IP of the server hosting the AlloyDB database.
   • User: The user which will be used to authenticate with the AlloyDB server.
   • Password: The password which will be used to authenticate with the AlloyDB server.

   You can also optionally set the following:

   • Database: The database to connect to when connecting to the AlloyDB Server. If this is not set, the user's default database will be used.
   • Port: The port of the server hosting the AlloyDB database. This property is set to 5432 by default.

   Authenticating with Standard Authentication

   Standard authentication (using the user/password combination supplied earlier) is the default form of authentication.

   No further action is required to leverage Standard Authentication to connect.

   Authenticating with pg_hba.conf Auth Schemes

   There are additional methods of authentication available which must be enabled in the pg_hba.conf file on the AlloyDB server.

   Find instructions about authentication setup on the AlloyDB Server here.

   Authenticating with MD5 Authentication

   This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to md5.

   Authenticating with SASL Authentication

   This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to scram-sha-256.

   Authenticating with Kerberos

   The authentication with Kerberos is initiated by AlloyDB Server when the ∏ is trying to connect to it. You should set up Kerberos on the AlloyDB Server to activate this authentication method. Once you have Kerberos authentication set up on the AlloyDB Server, see the Kerberos section of the help documentation for details on how to authenticate with Kerberos. 👁 Configuring a connection (Salesforce is shown)
   

4. Click Save & Test
5. Navigate to the Permissions tab in the Add AlloyDB 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 AlloyDB data from Node.js.

Query AlloyDB from Node.js

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

Connect to AlloyDB 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: 'AlloyDB1'
	}
}

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);
})