Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →How to connect to Bitbucket Data with Squirrel SQL client
Connect to Bitbucket data and execute queries in the Squirrel SQL Client.
The CData JDBC Driver for Bitbucket enables you to execute queries to Bitbucket data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for Bitbucket data and execute queries.
Add the JDBC Driver for Bitbucket
Follow the steps below to add the driver JAR.
- In Squirrel SQL, click Windows -> View Drivers.
- Click the plus icon to open the Add Driver wizard.
- In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for Bitbucket.
- In the Example URL box, enter jdbc:bitbucket:
- In the Extra Class Path tab, click Add.
- In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
- Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.bitbucket.BitbucketDriver.
![The definition for the JDBC data source. (Salesforce is shown.)](../articles/jdbc-squirrel-sql-1.png)
Define Connection Properties
Follow the steps below to save connection properties in the driver alias.
- Click Windows -> View Aliases.
- In the pane that lists the aliases, click the plus icon.
In the Add Alias wizard that opens, the following fields are required for the JDBC driver:
- Name: Enter a name for the alias; for example, CData Bitbucket Source.
- Driver: Select the CData JDBC Driver for Bitbucket.
- URL: Enter jdbc:bitbucket:
- If you want to define any additional properties, click Properties.
- In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
- In the Specify column, select the checkboxes for 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.
Below is a typical connection string:
jdbc:bitbucket:Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH
- In the dialog that appears after you click OK, click connect to test the connection.
Discover Schemas and Query Bitbucket Data
After the metadata has loaded, a new tab for the Bitbucket data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.
To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.
![Tables can be edited on the Content tab. (Salesforce is shown.)](../articles/jdbc-squirrel-sql-4.png)
To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:
SELECT Title, ContentRaw FROM Issues WHERE Id = '1'
![A query and the results. (Salesforce is shown.)](../articles/jdbc-squirrel-sql-5.png)