Bridge Bitbucket Connectivity with Apache NiFi

Apache NiFi supports powerful and scalable directed graphs of data routing, transformation, and system mediation logic. When paired with the CData JDBC Driver for Bitbucket, NiFi can work with live Bitbucket data. This article describes how to connect to and query Bitbucket data from an Apache NiFi Flow.

With built-in optimized data processing, the CData JDBC driver offers unmatched performance for interacting with live Bitbucket data. When you issue complex SQL queries to Bitbucket, the driver pushes supported SQL operations, like filters and aggregations, directly to Bitbucket and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Bitbucket data using native data types.

Connecting to Bitbucket Data in Apache NiFi

1. Download the CData JDBC Driver for Bitbucket installer, unzip the package, run the .exe file to install the driver.

2. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.bitbucket.jar (and cdata.jdbc.bitbucket.lic), to the Apache NiFi lib subfolder, for example, C:\nifi-1.3.0-bin\nifi-1.3.0\lib.

   On Windows, the default location for the CData JDBC Driver is C:\Program Files\CData\CData JDBC Driver for Bitbucket.

3. Start Apache NiFi by running the run-nifi.bat file in bin subfolder, for example, C:\nifi-1.3.0-bin\nifi-1.3.0\bin.

   (OR)

   Use the command prompt to navigate to the particular directory and run the run-nifi.bat file for example:

   cd C:\nifi-1.3.0-bin\nifi-1.3.0\bin
   .\run-nifi.bat
   

4. Navigate to the Apache NiFi UI in your web browser: It should be https://localhost:8443/nifi.

   Note: If users are utilizing an older version of Apache NiFi, they should access it via http://localhost:8080/nifi. In earlier versions, HTTP was the protocol employed. However, in the most recent version, HTTPS is the standard. By default, HTTP operates on port 8080, while HTTPS uses port 8443.

5. When accessing Apache NiFi via a URL, it prompts you to enter a username and password for login.

   To retrieve login credentials, users should consult the 'App.log' file located within the log directory of their NiFi installation. This file typically contains the necessary details for accessing the NiFi interface.

6. Click the (Configuration) button from the Operate sidebar under the "NiFi Flow" process group.
7. In the NiFi Flow Configuration page, navigate to the "Controller Services" tab.
8. Click the button to create a new controller service.
9. In the Add Controller Service page, select "DBCPConnectionPool", and then click Add.
10. In the Configure Controller Service page, navigate to the "Properties" tab.
11. Click the gear button to configure the new DBCPConnection Pool.

12. Fill in the properties:

    Property	Value
    Database Connection URL	jdbc:bitbucket:Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH
    Database Driver Class Name	cdata.jdbc.bitbucket.BitbucketDriver
    Database Driver Location(s)	Path to your Apache NiFi's lib folder where the JAR files are present.

    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:

    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.
13. To establish a connection and execute a select query, simply drag and drop the processor (indicated by the yellow highlight) into the workspace.
14. Select the 'ExecuteSQL' processor and click the 'Add' button to make it visible in the workspace.
15. Click on the added processor (ExecuteSQL)to open the connection page.
16. Click on the Verify Properties button and verify to test the connection.
17. Ensure that all the verification results are successful, and then click on APPLY.
18. Activate the connection by clicking the small button at the right corner of the screen.

Your Bitbucket data is now available for use in Apache NiFi. For example, you can use the DBCPConnection Pool as the source for a QueryDatabaseTable processor (shown below).

Download a free, 30-day trial of the CData JDBC Driver for Bitbucket and start working with your live Bitbucket data in Apache NiFi. Reach out to our Support Team if you have any questions.