Connect to Bitbucket Data in CloverDX (formerly CloverETL)

The CData JDBC Driver for Bitbucket enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Bitbucket as sources and destinations. In this article, you will use the JDBC Driver for Bitbucket to set up a simple transfer into a flat file. The CData JDBC Driver for Bitbucket enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Bitbucket as sources and destinations. In this article, you will use the JDBC Driver for Bitbucket to set up a simple transfer into a flat file.

Connect to Bitbucket as a JDBC Data Source

1. Create the connection to Bitbucket data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.bitbucket.jar file.
3. Enter the JDBC URL.

   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.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   A typical JDBC URL is below:

   jdbc:bitbucket:Workspace=myworkspaceslug;Schema=Information;InitiateOAuth=GETANDREFRESH;

Query Bitbucket Data with the DBInputTable Component

1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
2. In the DB connection property, select the Bitbucket JDBC data source from the drop-down menu.
3. Enter the SQL query. For example:

   SELECT Title, ContentRaw FROM Issues WHERE Id = '1'

Write the Output of the Query to a UniversalDataWriter

1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
3. Right-click the DBInputTable and then click Extract Metadata.
4. Connect the output port of the DBInputTable to the UniversalDataWriter.
5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Issues table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
6. Click Run to write to the file.