Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Query Bitbucket Data in DataGrip
Create a Data Source for Bitbucket in DataGrip and use SQL to query live Bitbucket data.
DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for Bitbucket, DataGrip can work with live Bitbucket data. This article shows how to establish a connection to Bitbucket data in DataGrip and use the table editor to load Bitbucket data.
Create a New Driver Definition for Bitbucket
The steps below describe how to create a new Data Source in DataGrip for Bitbucket.
- In DataGrip, click File -> New > Project and name the project
- In the Database Explorer, click the plus icon () and select Driver.
- In the Driver tab:
- Set Name to a user-friendly name (e.g. "CData Bitbucket Driver")
- Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.bitbucket.jar).
- Set Class to cdata.jdbc.bitbucket.Bitbucket.jar
Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc - For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
- Click "Apply" then "OK" to save the Connection
Configure a Connection to Bitbucket
- Once the connection is saved, click the plus (), then "Data Source" then "CData Bitbucket Driver" to create a new Bitbucket Data Source.
- In the new window, configure the connection to Bitbucket with a JDBC URL.
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.
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.
- Set URL to the connection string, e.g.,
jdbc:bitbucket:Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH
- Click "Apply" and "OK" to save the connection string
At this point, you will see the data source in the Data Explorer.
Execute SQL Queries Against Bitbucket
To browse through the Bitbucket entities (available as tables) accessible through the JDBC Driver, expand the Data Source.
![Exploring the data (Salesforce is shown.)](../articles/jdbc-datagrip-6.png)
To execute queries, right click on any table and select "New" -> "Query Console."
![Opening a new Query Console.](../articles/jdbc-datagrip-7.png)
In the Console, write the SQL query you wish to execute. For example: SELECT Title, ContentRaw FROM Issues WHERE Id = '1'
![Querying with SQL (Salesforce is shown.)](../articles/jdbc-datagrip-8.png)
Download a free, 30-day trial of the CData JDBC Driver for Bitbucket and start working with your live Bitbucket data in DataGrip. Reach out to our Support Team if you have any questions.