We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →How to connect PolyBase to Couchbase
Use CData drivers and PolyBase to create an external data source in SQL Server 2019 with access to live Couchbase 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 Couchbase, you get access to your Couchbase data directly alongside your SQL Server data. This article describes creating an external data source and external tables to grant access to live Couchbase data using T-SQL queries.
NOTE: PolyBase is only available on SQL Server 19 and above, and only for Standard SQL Server.
The CData ODBC drivers offer unmatched performance for interacting with live Couchbase data using PolyBase due to optimized data processing built into the driver. When you issue complex SQL queries from SQL Server to Couchbase, the driver pushes down supported SQL operations, like filters and aggregations, directly to Couchbase 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 Couchbase data, using a single query to pull data from distributed sources.
Connect to Couchbase
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 Couchbase Sys is created automatically).
To connect using the Login method, set User, Password, and Server to the credentials for the account and the address of the server you want to connect to.
Click "Test Connection" to ensure that the DSN is connected to Couchbase properly. Navigate to the Tables tab to review the table definitions for Couchbase.
Create an External Data Source for Couchbase 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 Couchbase data.
NOTE: IDENTITY and SECRET correspond with the User and Password properties for Couchbase.
CREATE DATABASE SCOPED CREDENTIAL couchbase_creds WITH IDENTITY = 'couchbase_username', SECRET = 'couchbase_password';
Create an External Data Source for Couchbase
Execute a CREATE EXTERNAL DATA SOURCE SQL command to create an external data source for Couchbase with PolyBase:
- Set the LOCATION parameter , using the DSN and credentials configured earlier.
PUSHDOWN is set to ON by default, meaning the ODBC Driver can leverage server-side processing for complex queries.
CREATE EXTERNAL DATA SOURCE cdata_couchbase_source WITH ( LOCATION = 'odbc://SERVER_URL', CONNECTION_OPTIONS = 'DSN=CData Couchbase Sys', -- PUSHDOWN = ON | OFF, CREDENTIAL = couchbase_creds );
Create External Tables for Couchbase
After creating the external data source, use CREATE EXTERNAL TABLE statements to link to Couchbase data from your SQL Server instance. The table column definitions must match those exposed by the CData ODBC Driver for Couchbase. 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 Couchbase Customer would look similar to the following:
CREATE EXTERNAL TABLE Customer( FirstName [nvarchar](255) NULL, TotalDue [nvarchar](255) NULL, ... ) WITH ( LOCATION='Customer', DATA_SOURCE=cdata_couchbase_source );
Having created external tables for Couchbase 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 Couchbase, freeing up local resources and computing power. Download a free, 30-day trial of the ODBC Driver for Couchbase and start working with live Couchbase data alongside your SQL Server data today.