Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Access Bitbucket Data from MySQL in Amazon QuickSight
Connect to Bitbucket and build visualizations of Bitbucket data using a MySQL Connection in Amazon QuickSight.
Amazon QuickSight gives you a way to quickly build visualizations, perform analytics, and get insights from AWS data sources, uploaded files, and other databases in the cloud. When paired with the CData SQL Gateway, you get the same functionality with access to 200+ Big Data, NoSQL, and SaaS sources, both on-premises and in the cloud. In this article, we use the SQL Gateway with the CData ODBC Driver for Bitbucket to access Bitbucket data through a MySQL connection in Amazon QuickSight, either in real time using direct queries, or by importing the data into SPICE.
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.
When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.
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.
![Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown) Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)](../articles/odbc-mysql-apps-script-1.png)
To connect to the SQL Gateway from QuickSight, you will need to run the SQL Gateway on a web-facing machine. After configuring the SQL Gateway, make note of the following information:
- The IP address or domain name of the machine hosting the SQL Gateway
- The data source name (likely CData Bitbucket Sys) of the MySQL service
- The port number of the MySQL service
- The credentials of a SQL Gateway user with access to the service
Configure Remote Access
If your ODBC Driver and the remoting service are installed on-premise (and not accessible from Amazon QuickSight), you can use the reverse SSH tunneling feature to enable remote access. For detailed instructions, read our Knowledge Base article: SQL Gateway SSH Tunneling Capabilities.
Connect to Bitbucket in QuickSight
Once you have a MySQL Service configured for the Bitbucket ODBC Driver, you are ready to connect to the data in QuickSight. Start by logging in to your QuickSight console. From there, click Manage Data, then click New Data Set and choose MySQL as the data source.
![Create a new MySQL data source.](../articles/odbc-mysql-aws-quicksight-1.png)
Configure the data set using the values for the MySQL service for Bitbucket you configured in SQL Gateway (be sure to use the DSN for the database name). Validate your connection and click Create Data Source.
![Configure the connection to SQL Gateway (Salesforce is shown).](../articles/odbc-mysql-aws-quicksight-2.png)
Visualize Bitbucket Data in QuickSight
For this article, we will use a custom SQL query for our data visualization. To do so, click Edit/Preview Data and in the resulting Data Prep screen follow the steps below:
- Name your data set (for example, Issues).
- If you wish to import your data into QuickSight SPICE, click the SPICE option, otherwise QuickSight will query the data directly.
- Under the Tables menu, click Switch to Custom SQL Tool.
- Give your SQL query a name.
- Enter your custom SQL query. For example:
SELECT Title, ContentRaw FROM Issues - Click Finish.
- Click Save & Visualize.
![Create a custom SQL query (Salesforce is shown).](../articles/odbc-mysql-aws-quicksight-3.png)
After you have saved the data set, you can configure the visualization. Select the columns you wish to visualize and choose a visual type. Your visualization can be customized, from its name to the way that data is aggregated.
![Visualize data in QuickSight (Salesforce is shown).](../articles/odbc-mysql-aws-quicksight-4.png)
With the CData ODBC Driver for Bitbucket and SQL Gateway, you are able to easily build data visualizations and perform analytics on Bitbucket data in Amazon QuickSight. If you have any questions, such as needing to access your on-premises data from AWS QuickSight, let our Support Team know.