How to connect PolyBase to Bitbucket

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 Bitbucket, you get access to your Bitbucket data directly alongside your SQL Server data. This article describes creating an external data source and external tables to grant access to live Bitbucket 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 Bitbucket data using PolyBase due to optimized data processing built into the driver. When you issue complex SQL queries from SQL Server to Bitbucket, the driver pushes down supported SQL operations, like filters and aggregations, directly to Bitbucket 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 Bitbucket data, using a single query to pull data from distributed sources.

Connect to Bitbucket

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 Bitbucket Sys is created automatically).

For most queries, you must set the Workspace. The only exception to this is the Workspaces table, which does not require this property to be set, as querying it provides a list of workspace slugs that can be used to set Workspace. To query this table, you must set Schema to 'Information' and execute the query SELECT * FROM Workspaces>.

Setting Schema to 'Information' displays general information. To connect to Bitbucket, set these parameters:

• Schema: To show general information about a workspace, such as its users, repositories, and projects, set this to Information. Otherwise, set this to the schema of the repository or project you are querying. To get a full set of available schemas, query the sys_schemas table.
• Workspace: Required if you are not querying the Workspaces table. This property is not required for querying the Workspaces table, as that query only returns a list of workspace slugs that can be used to set Workspace.

Authenticating to Bitbucket

Bitbucket supports OAuth authentication only. To enable this authentication from all OAuth flows, you must create a custom OAuth application, and set AuthScheme to OAuth.

Be sure to review the Help documentation for the required connection properties for you specific authentication needs (desktop applications, web applications, and headless machines).

Creating a custom OAuth application

From your Bitbucket account:

1. Go to Settings (the gear icon) and select Workspace Settings.
2. In the Apps and Features section, select OAuth Consumers.
3. Click Add Consumer.
4. Enter a name and description for your custom application.
5. Set the callback URL:
   • For desktop applications and headless machines, use http://localhost:33333 or another port number of your choice. The URI you set here becomes the CallbackURL property.
   • For web applications, set the callback URL to a trusted redirect URL. This URL is the web location the user returns to with the token that verifies that your application has been granted access.
6. If you plan to use client credentials to authenticate, you must select This is a private consumer. In the driver, you must set AuthScheme to client.
7. Select which permissions to give your OAuth application. These determine what data you can read and write with it.
8. To save the new custom application, click Save.
9. After the application has been saved, you can select it to view its settings. The application's Key and Secret are displayed. Record these for future use. You will use the Key to set the OAuthClientId and the Secret to set the OAuthClientSecret.

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

Create an External Data Source for Bitbucket 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 Bitbucket data.

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

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

Create an External Data Source for Bitbucket

Execute a CREATE EXTERNAL DATA SOURCE SQL command to create an external data source for Bitbucket with PolyBase:

• Set the LOCATION parameter , using the DSN and credentials configured earlier.

For Bitbucket, set SERVERNAME to the URL or address for your server (e.g. 'localhost' or '127.0.0.1' for local servers; the remote URL for remote servers). Leave PORT empty. PUSHDOWN is set to ON by default, meaning the ODBC Driver can leverage server-side processing for complex queries.

CREATE EXTERNAL DATA SOURCE cdata_bitbucket_source
WITH ( 
  LOCATION = 'odbc://SERVER_URL',
  CONNECTION_OPTIONS = 'DSN=CData Bitbucket Sys',
  -- PUSHDOWN = ON | OFF,
  CREDENTIAL = bitbucket_creds
);

Create External Tables for Bitbucket

After creating the external data source, use CREATE EXTERNAL TABLE statements to link to Bitbucket data from your SQL Server instance. The table column definitions must match those exposed by the CData ODBC Driver for Bitbucket. 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 Bitbucket Issues would look similar to the following:

CREATE EXTERNAL TABLE Issues(
  Title [nvarchar](255) NULL,
  ContentRaw [nvarchar](255) NULL,
  ...
) WITH ( 
  LOCATION='Issues',
  DATA_SOURCE=cdata_bitbucket_source
);

Having created external tables for Bitbucket 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 Bitbucket, freeing up local resources and computing power. Download a free, 30-day trial of the ODBC Driver for Bitbucket and start working with live Bitbucket data alongside your SQL Server data today.