Query Lakebase Data as a MySQL Database in Node.js

You can use the SQL Gateway from the ODBC Driver for Lakebase to query Lakebase data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and start querying using Node.js.

Connect to Lakebase 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 Databricks Lakebase, start by setting the following properties:

• DatabricksInstance: The Databricks instance or server hostname, provided in the format instance-abcdef12-3456-7890-abcd-abcdef123456.database.cloud.databricks.com.
• Server: The host name or IP address of the server hosting the Lakebase database.
• Port (optional): The port of the server hosting the Lakebase database, set to 5432 by default.
• Database (optional): The database to connect to after authenticating to the Lakebase Server, set to the authenticating user's default database by default.

OAuth Client Authentication

To authenicate using OAuth client credentials, you need to configure an OAuth client in your service principal. In short, you need to do the following:

1. Create and configure a new service principal
2. Assign permissions to the service principal
3. Create an OAuth secret for the service principal

For more information, refer to the Setting Up OAuthClient Authentication section in the Help documentation.

OAuth PKCE Authentication

To authenticate using the OAuth code type with PKCE (Proof Key for Code Exchange), set the following properties:

• AuthScheme: OAuthPKCE.
• User: The authenticating user's user ID.

For more information, refer to the Help documentation.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Lakebase data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

👁 Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query Lakebase from Node.js

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

• Host name or address, and port: The machine and port where the MySQL remoting service is listening for MySQL connections.
• Username and password: The username and password of a user you authorized on the Users tab of the SQL Gateway.
• Database name: The DSN you configured for the MySQL remoting service.

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

var mysql = require('mysql');
var connection = mysql.createConnection({
 host : 'localhost',
 database : 'CData Lakebase Sys',
 port	 : '3306',
 user : 'mysql_user',
 password : 'test'
});
connection.connect();
connection.query('SELECT * FROM Orders', function(err, rows, fields) {
 if (err) throw err;
 console.log(rows);
});

connection.end();