How to connect PolyBase to SingleStore

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

Connect to SingleStore

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

The following connection properties are required in order to connect to data.

• Server: The host name or IP of the server hosting the SingleStore database.
• Port: The port of the server hosting the SingleStore database.
• Database (Optional): The default database to connect to when connecting to the SingleStore Server. If this is not set, tables from all databases will be returned.

Connect Using Standard Authentication

To authenticate using standard authentication, set the following:

• User: The user which will be used to authenticate with the SingleStore server.
• Password: The password which will be used to authenticate with the SingleStore server.

Connect Using Integrated Security

As an alternative to providing the standard username and password, you can set IntegratedSecurity to True to authenticate trusted users to the server via Windows Authentication.

Connect Using SSL Authentication

You can leverage SSL authentication to connect to SingleStore data via a secure session. Configure the following connection properties to connect to data:

• SSLClientCert: Set this to the name of the certificate store for the client certificate. Used in the case of 2-way SSL, where truststore and keystore are kept on both the client and server machines.
• SSLClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
• SSLClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
• SSLClientCertType: The certificate type of the client store.
• SSLServerCert: The certificate to be accepted from the server.

Connect Using SSH Authentication

Using SSH, you can securely login to a remote machine. To access SingleStore data via SSH, configure the following connection properties:

• SSHClientCert: Set this to the name of the certificate store for the client certificate.
• SSHClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
• SSHClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
• SSHClientCertType: The certificate type of the client store.
• SSHPassword: The password that you use to authenticate with the SSH server.
• SSHPort: The port used for SSH operations.
• SSHServer: The SSH authentication server you are trying to authenticate against.
• SSHServerFingerPrint: The SSH Server fingerprint used for verification of the host you are connecting to.
• SSHUser: Set this to the username that you use to authenticate with the SSH server.

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

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

NOTE: IDENTITY and SECRET correspond with the User and Password properties for SingleStore.

CREATE DATABASE SCOPED CREDENTIAL singlestore_creds
WITH IDENTITY = 'singlestore_username', SECRET = 'singlestore_password';

Create an External Data Source for SingleStore

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

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

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

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

Create External Tables for SingleStore

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

👁 Table definition in the DSN Configuration Wizard (Salesforce is shown)

Sample CREATE TABLE Statement

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

CREATE EXTERNAL TABLE Orders(
 ShipName [nvarchar](255) NULL,
 ShipCity [nvarchar](255) NULL,
 ...
) WITH ( 
 LOCATION='Orders',
 DATA_SOURCE=cdata_singlestore_source
);

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