Connect to Bitbucket Data as an External Source in Dremio

The CData JDBC Driver for Bitbucket implements JDBC Standards and allows various applications, including Dremio, to work with live Bitbucket data. Dremio is a data lakehouse platform designed to empower self-service, interactive analytics on the data lake. With the CData JDBC driver, you can include live Bitbucket data as a part of your enterprise data lake. This article describes how to connect to Bitbucket data from Dremio as an External Source.

The CData JDBC Driver enables high-speed access to live Bitbucket data in Dremio. Once you install the driver, authenticate with Bitbucket and gain immediate access to Bitbucket data within your data lake. By surfacing Bitbucket data using native data types and handling complex filters, aggregations, & other operations automatically, the CData JDBC Driver grants seamless access to Bitbucket data.

Prerequisites

This article assumes you are utilizing Docker to run Dremio. You can create a Docker container with the Dremio service using a command similar to the follow:

docker run -d --name dremio -p 9047:9047 -p 31010:31010 dremio/dremio-oss

Where dremio is the name of the container, 9047 is the container's port for the Dremio web interface and 31010 is the port that maps to the Dremio query service. dremio/dremio-oss specifies the image to use.

Build the ARP Connector

To use the CData JDBC Driver in Dremio, you need to build an Advanced Relation Pushdown (ARP) Connector. You can view the source code for the Connector on GitHub or download the ZIP file (GitHub.com) directly. Once you copy or extract the files, run the following command from the root directory of the connector (the directory containing the pom.xml file) to build the connector.

mvn clean install

NOTE: The CData ARP Connectors are build to be compiled with Java 11. Be sure to install Java 11 and use the correct version. You can update your Java version using a command similar to the following:

sudo update-alternatives --config java

Once the JAR file for the connector is built (in the target directory), you are ready to copy the ARP connector and JDBC Driver to your Dremio instance.

Installing the Connector and JDBC Driver

Install the ARP Connector to %DREMIO_HOME%/jars/ and the JDBC Driver for Bitbucket to %DREMIO_HOME%/jars/3rdparty. You can use commands similar to the following:

ARP Connector

docker cp PATH\TO\dremio-bitbucket-plugin-{DREMIO_VERSION}.jar dremio_image_name:/opt/dremio/jars/

JDBC Driver for Bitbucket

docker cp PATH\TO\cdata.jdbc.bitbucket.jar dremio_image_name:/opt/dremio/jars/3rdparty/

Connecting to Bitbucket

Bitbucket will now appear as an External Source option in Dremio. The ARP Connector built uses a JDBC URL to connect to Bitbucket data. The JDBC Driver has a built-in connection string designer that you can use (see below).

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Bitbucket JDBC Driver. Double-click the JAR file or execute the jar file from the command line.

java -jar cdata.jdbc.bitbucket.jar

Fill in the connection properties and copy the connection string to the clipboard.

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.

NOTE: To use the JDBC Driver in Dremio, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Add the Runtime Key (RTK) to the JDBC URL. You will end up with a JDBC URL similar to the following:

jdbc:bitbucket:RTK=5246...;Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH

Access Bitbucket as an External Source

To add Bitbucket as an External Source, click to add a new source and select Bitbucket. Copy the JDBC URL and paste it into the New Bitbucket Source wizard.

Save the connection and you are ready to query live Bitbucket data in Dremio, easily incorporating Bitbucket data into your data lake.

More Information & Free Trial

Using the CData JDBC Driver for Bitbucket in Dremio, you can incorporate live Bitbucket data into your data lake. Check out our CData JDBC Driver for Bitbucket page for more information about connecting to Bitbucket. Download a free, 30 day trial of the CData JDBC Driver for Bitbucket and get started today.