Ready to get started?

Download a free trial of the Bitbucket ODBC Driver to get started:

 Download Now

Learn more:

Bitbucket Icon Bitbucket ODBC Driver

The Bitbucket ODBC Driver is a powerful tool that allows you to connect with live data from Bitbucket, directly from any applications that support ODBC connectivity.

Access Bitbucket data like you would a database - read, write, and update Bitbucket 0, etc. through a standard ODBC Driver interface.

Establish a Live Connection with Bitbucket Data using Tableau Bridge



The CData ODBC Driver for Bitbucket enables you to integrate live Bitbucket data into Tableau Cloud dashboards using the Tableau Bridge.

The Tableau Bridge enables you to publish dashboards to Tableau Cloud while maintaining live connectivity with any data source. In this article, you will use the Tableau Bridge to maintain data freshness in a published workbook by listening for changes in the underlying Bitbucket data.

The CData ODBC drivers offer unmatched performance for interacting with live Bitbucket data in Tableau Cloud due to optimized data processing built into the driver. When you issue complex SQL queries from Tableau Cloud to Bitbucket, the driver pushes 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. With built-in dynamic metadata querying, you can visualize and analyze Bitbucket data using native Tableau data types.

Connect to Bitbucket as an ODBC Data Source

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.

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.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Add Bitbucket Data to a Dashboard

  1. From a new workbook, click Data -> New Data Source -> Other Databases (ODBC).
    Select the CData Data Source Name (for example: CData Bitbucket Source).
  2. In the Database menu, select CData.
  3. In the Table box, enter a table name or click New Custom SQL to enter an SQL query. This article retrieves the Issues table.
  4. Drag the table onto the join area. At this point, you can include multiple tables, leveraging the built-in SQL engine to process complex data requests.
  5. Click the tab for your worksheet. Columns are listed as Dimensions and Measures, which you can drag and drop onto the dashboard to create visualizations.

Set Up Tableau Bridge as a Service

  1. In the Server menu, select Start Tableau Bridge Client.
  2. Sign in to the Tableau Bridge using a site admin level account.
  3. If prompted, select the Tableau Cloud site where you want to publish live data. The bridge client will open and is accessible from the system tray.
  4. By default, the Tableau Bridge client is set to Application mode. Select 'Switch to service' to enable Tableau Bridge to handle live connections.
  5. Log in to your Tableau Cloud site as an administrator.
  6. From your site, click Settings, then Bridge.
  7. In the Bridge settings, under Enable Clients to Maintain Live Connections, check the box labeled 'Enable Tableau Bridge clients to maintain live connections to on-premises data.'

Publish a Dashboard Containing the Live Data Source

Having configured both the Tableau Bridge and Tableau Cloud to enable live data connections, you can now publish your workbook to Tableau Cloud. From the Server menu, select Publish Workbook.

After choosing the workbook name and project that you wish to publish to, configure the deployment so that the CData ODBC driver for Bitbucket is embedded in your workbook as a separate, live data source.

  1. Under Data Sources, select the option to Edit the embedded data sources in the workbook.
  2. Change Publish Type to 'Published separately,' then select a desired means of authentication.
  3. Last, select 'Maintain connection to a live data source' and click the green Publish Workbook button.

The published workbook now updates alongside the underlying Bitbucket data. From a published dashboard, simply click the Refresh button to reflect the most recent changes.