Ready to get started?

Learn more about the CData ODBC Driver for Phoenix or download a free trial:

Download Now

Connect to Phoenix as an External Data Source using PolyBase

Use the CData ODBC Driver for Phoenix and PolyBase to create an external data source in SQL Server 2019 with access to live Phoenix data.

PolyBase for SQL Server allows you to query external data by using the same Transact-SQL syntax used to query a database table. When paired with the CData ODBC Driver for Phoenix, you get access to your Phoenix data directly alongside your SQL Server data. This article walks through creating an external data source and external tables to grant access to live Phoenix data using T-SQL queries.

The CData ODBC drivers offer unmatched performance for interacting with live Phoenix data using PolyBase due to optimized data processing built into the driver. When you issue complex SQL queries from SQL Server to Phoenix, the driver pushes down supported SQL operations, like filters and aggregations, directly to Phoenix and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. And with PolyBase, you can also join SQL Server data with Phoenix data, using a single query to pull data from distributed sources.

Connect to Phoenix

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs. To create an external data source in SQL Server using PolyBase, configure a System DSN (CData Phoenix Sys is created automatically).

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.

Click "Test Connection" to ensure that the DSN is connected to Phoenix properly. Navigate to the Tables tab to review the table definitions for Phoenix.

Create an External Data Source for Phoenix Data

After configuring the connection, you need to create a master encryption key and a credential database for the external data source.

Creating a Master Encryption Key

Execute the following SQL command to create a new master key, 'ENCRYPTION,' to encrypt the credentials for the external data source.

CREATE MASTER KEY ENCRYPTION BY PASSWORD = 'password';

Creating a Credential Database

Execute the following SQL command to create credentials for the external data source connected to Phoenix data.

NOTE: Since Phoenix does not require a User or Password to authenticate, you may use whatever values you wish for IDENTITY and SECRET.

CREATE DATABASE SCOPED CREDENTIAL apachephoenix_creds
WITH IDENTITY = 'username', SECRET = 'password';

Create an External Data Source for Phoenix

Execute the following SQL command to create an external data source for Phoenix with PolyBase, using the DSN and credentials configured earlier.

NOTE: SERVERNAME and PORT corresponds to the Server and Port connection properties for Phoenix. PUSHDOWN is set to ON by default, meaning the ODBC Driver can leverage server-side processing for complex queries.

CREATE EXTERNAL DATA SOURCE cdata_apachephoenix_source
WITH ( 
  LOCATION = 'odbc://SERVERNAME[:PORT]',
  CONNECTION_OPTIONS = 'DSN=CData Phoenix Sys',
  -- PUSHDOWN = ON | OFF,
  CREDENTIAL = apachephoenix_creds
);

Create External Tables for Phoenix

After creating the external data source, use CREATE EXTERNAL TABLE statements to link to Phoenix data from your SQL Server instance. The table column definitions must match those exposed by the CData ODBC Driver for Phoenix. You can refer to the Tables tab of the DSN Configuration Wizard to see the table definition.

Sample CREATE TABLE Statement

The statement to create an external table based on a Phoenix MyTable would look similar to the following:

CREATE EXTERNAL TABLE MyTable(
  Id [nvarchar](255) NULL,
  Column1 [nvarchar](255) NULL,
  ...
) WITH ( 
  LOCATION='MyTable',
  DATA_SOURCE=cdata_apachephoenix_source
);

Having created external tables for Phoenix in your SQL Server instance, you are now able to query local and remote data simultaneously. Thanks to built-in query processing in the CData ODBC Driver, you know that as much query processing as possible is being pushed to Phoenix, freeing up local resources and computing power. Download a free, 30-day trial of the ODBC Driver for Phoenix and start working with live Phoenix data alongside your SQL Server data today.