Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →How to Connect DBeaver to Bitbucket via a JDBC Driver
Manage Bitbucket data with visual tools in DBeaver like the query browser.
The CData JDBC Driver for Bitbucket implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Bitbucket data with wizards in DBeaver and browse data in the DBeaver GUI.
Create a JDBC Data Source for Bitbucket Data
Follow the steps below to load the driver JAR in DBeaver.
- Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
- In the Settings tab:
- Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for Bitbucket).
- Set Class Name to the class name for the JDBC driver: cdata.jdbc.bitbucket.BitbucketDriver.
- Set URL Template to jdbc:bitbucket:.
- In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.Bitbucket.jar).
Create a Connection to Bitbucket Data
Follow the steps below to add credentials and other required connection properties.
- In the "Database" menu, click "New Database Connection."
- In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for Bitbucket) and click "Next >."
- On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:
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.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Bitbucket JDBC Driver. Either 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.
Below is a typical connection string:
jdbc:bitbucket:Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH
- Click "Test Connection ..." to ensure you have configured the connection properly.
- Click "Finish."
Query Bitbucket Data
You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.
![The results of a query in DBeaver. (Salesforce is shown.)](../articles/jdbc-dbvr-6.png)