How to connect PolyBase to Sentry

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData drivers and PolyBase to create an external data source in SQL Server 2019 with access to live Sentry 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 API Driver for ODBC, you get access to your Sentry data directly alongside your SQL Server data. This article describes creating an external data source and external tables to grant access to live Sentry data using T-SQL queries.

NOTE: PolyBase is only available on SQL Server 19 and above.

The CData ODBC drivers offer unmatched performance for interacting with live Sentry data using PolyBase due to optimized data processing built into the driver. When you issue complex SQL queries from SQL Server to Sentry, the driver pushes down supported SQL operations, like filters and aggregations, directly to Sentry 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 Sentry data, using a single query to pull data from distributed sources.

Connect to Sentry

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

Using API Key Authentication

Sentry uses token-based authentication. To obtain an Auth Token:

  1. Log in to your Sentry account at https://sentry.io
  2. Navigate to Settings > Auth Tokens
  3. Click "Create New Token"
  4. Select the required scopes and click "Create Token"
  5. Copy the generated token (it will only be shown once)

After obtaining your Auth Token, set the following connection properties:

  • AuthScheme: Set this to APIKey.
Set the following in the ProfileSettings connection property:
  • APIKey: Set this to your Sentry Auth Token.
  • OrganizationId: Set this to your Sentry organization slug or ID.

Example Connection String

Profile=C:\profiles\Sentry.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_auth_token;OrganizationId=your_org_slug";

Connecting to Sentry

Once the authentication is configured, you can connect to Sentry and query data from any of the available tables such as Organizations, Projects, Issues, and Events.

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

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

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


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

Create an External Data Source for Sentry

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

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

For Sentry, 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_api_source
WITH ( 
  LOCATION = 'odbc://SERVER_URL',
  CONNECTION_OPTIONS = 'DSN=CData Sentry Sys',
  -- PUSHDOWN = ON | OFF,
  CREDENTIAL = api_creds
);

Create External Tables for Sentry

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

CREATE EXTERNAL TABLE UserOrganizations(
   [nvarchar](255) NULL,
   [nvarchar](255) NULL,
  ...
) WITH ( 
  LOCATION='UserOrganizations',
  DATA_SOURCE=cdata_api_source
);

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

Ready to get started?

Connect to live data from Sentry with the API Driver

Connect to Sentry