Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Connect to Bitbucket Data in DBeaver
Use the CData ODBC Driver to connect to Bitbucket data in DBeaver.
NOTE: The Legacy ODBC driver was removed in DBeaver Community Edition 23.1. As an alternative, you can use a CData JDBC Driver (learn how here: How to Connect DBeaver to Bitbucket via JDBC). If you need to use ODBC Drivers, refer to the DBeaver Documentation.
The CData ODBC Driver for Bitbucket enables access to live data from Bitbucket under the ODBC standard, allowing you work with Bitbucket data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to manage Bitbucket data with visual tools in DBeaver like the query browser.
The CData ODBC drivers offer unmatched performance for interacting with live Bitbucket data in DBeaver due to optimized data processing built into the driver. When you issue complex SQL queries from DBeaver 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 manage and analyze Bitbucket data.
Connect to Bitbucket
If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.
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:
- Go to Settings (the gear icon) and select Workspace Settings.
- In the Apps and Features section, select OAuth Consumers.
- Click Add Consumer.
- Enter a name and description for your custom application.
- 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.
- 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.
- Select which permissions to give your OAuth application. These determine what data you can read and write with it.
- To save the new custom application, click Save.
- 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.
Finally, set the "Map To WVarchar connection property to False in the DSN Configuration window for the driver. This configuration will allow string types to be mapped to SQL_VARCHAR and prevent SQL_WVARCHAR types from being displayed as NULL.
![Setting the Map To WVarchar property](../articles/odbc-dbeaver-1.png)
Connecting to the Bitbucket ODBC Data Source in DBeaver
- Open the DBeaver application and in the Database menu, select the New Database Connection option.
- In the 'Connect to a database' window, select ODBC and click Next.
- In the Database/Schema field, enter the DSN name (CData Bitbucket Source by default). It will be automatically added to the JDBC URL as well.
- Click the Test Connection button. You should receive a 'Connected' message after DBeaver has detected the DSN, along with details about the driver if the connection is successful.
Query Bitbucket Data
You can now query information from the tables exposed by the data source connection. You can expand the database structure in order to view all the tables. You can retrieve the table's data by right-clicking on a table name and selecting View data. The data will then be available in the Data tab.
![Viewing data (Salesforce is shown)](../articles/odbc-dbeaver-5.png)
Free Trial & More Information
At this point, you have connected to live Bitbucket data from DBeaver. For more information, visit the CData ODBC Driver page. Download a free, 30-day trial and start working live Bitbucket data DBeaver today.