Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →How to Query Bitbucket Data in MySQL Workbench
Execute MySQL queries against live Bitbucket data from MySQL Workbench.
You can use the SQL Gateway from the ODBC Driver for Bitbucket to query Bitbucket data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Bitbucket data in MySQL Workbench.
Connect to Bitbucket Data
If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. 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.
Configure the SQL Gateway
See the SQL Gateway Overview to set up connectivity to Bitbucket data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.
Query Bitbucket from MySQL Workbench
The steps below outline connecting to the virtual Bitbucket database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Bitbucket data.
Connect to Bitbucket through the SQL Gateway
- In MySQL Workbench, click to add a new MySQL connection.
- Name the connection (CData SQL Gateway for Bitbucket).
- Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
- Click Store in Vault to set and store the password.
- Click Test Connection to ensure the connection is configured properly and click OK.
NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.
![](../articles/odbc-mysql-workbench-1.png)
Query Bitbucket Data
- Open the connection you just created (CData SQL Gateway for Bitbucket).
- Click File -> New Query Tab.
- Write a SQL query to retrieve Bitbucket data, like SELECT * FROM `CData Bitbucket Sys`.Issues;
![](../articles/odbc-mysql-workbench-2.png)
With access to live Bitbucket data from MySQL Workbench, you can easily query and update Bitbucket, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for Bitbucket and the CData SQL Gateway.