Query Phoenix Data as a MySQL Database in Node.js

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Phoenix ODBC Driver

The Phoenix ODBC Driver is a powerful tool that allows you to connect with HBase through Apache Phoenix, directly from any applications that support ODBC connectivity.

Access Phoenix like you would a relational database - read, write, and update through a standard ODBC Driver interface.



Execute MySQL queries against Phoenix data from Node.js.

You can use the SQL Gateway from the ODBC Driver for Phoenix to query Phoenix 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 Phoenix 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.

Connect to Apache Phoenix via the Phoenix Query Server. Set the Server and Port (if different from the default port) properties to connect to Apache Phoenix. The Server property will typically be the host name or IP address of the server hosting Apache Phoenix.

Authenticating to Apache Phoenix

By default, no authentication will be used (plain). If authentication is configured for your server, set AuthScheme to NEGOTIATE and set the User and Password properties (if necessary) to authenticate through Kerberos.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Phoenix 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.

Query Phoenix from Node.js

The following example shows how to define a connection and execute queries to Phoenix 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 Phoenix data and start executing queries with the code below:

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

connection.end();