Connect to Bitbucket Data in RapidMiner

This article shows how you can easily integrate the CData JDBC driver for Bitbucket into your processes in RapidMiner. This article uses the CData JDBC Driver for Bitbucket to transfer Bitbucket data to a process in RapidMiner.

Connect to Bitbucket in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to Bitbucket:

1. Add a new database driver for Bitbucket: Click Connections -> Manage Database Drivers.
2. In the resulting wizard, click the Add button and enter a name for the connection.
3. Enter the prefix for the JDBC URL: jdbc:bitbucket:
4. Enter the path to the cdata.jdbc.bitbucket.jar file, located in the lib subfolder of the installation directory.
5. Enter the driver class: cdata.jdbc.bitbucket.BitbucketDriver
6. Create a new Bitbucket connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the Bitbucket driver you configured previously.
9. Enter your connection string in the Host box.

   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:

   1. Go to Settings (the gear icon) and select Workspace Settings.
   2. In the Apps and Features section, select OAuth Consumers.
   3. Click Add Consumer.
   4. Enter a name and description for your custom application.
   5. 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.
   6. 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.
   7. Select which permissions to give your OAuth application. These determine what data you can read and write with it.
   8. To save the new custom application, click Save.
   9. 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.

   A typical connection string is below:

   Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH
10. Enter your username and password if necessary.

You can now use your Bitbucket connection with the various RapidMiner operators in your process. To retrieve Bitbucket data, drag the Retrieve operator from the Operators view. With the Retrieve operator selected, you can then define which table to retrieve in the Parameters view by clicking the folder icon next to the "repository entry." In the resulting Repository Browser, you can expand your connection node to select the desired example set.

Finally, wire the output to the Retrieve process to a result, and run the process to see the Bitbucket data.