Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →How to integrate Bitbucket with Apache Airflow
Access and process Bitbucket data in Apache Airflow using the CData JDBC Driver.
Apache Airflow supports the creation, scheduling, and monitoring of data engineering workflows. When paired with the CData JDBC Driver for Bitbucket, Airflow can work with live Bitbucket data. This article describes how to connect to and query Bitbucket data from an Apache Airflow instance and store the results in a CSV file.
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.
Configuring the Connection to Bitbucket
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:
- 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.
To host the JDBC driver in clustered environments or in the cloud, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.
The following are essential properties needed for our JDBC connection.
Property | Value |
---|---|
Database Connection URL | jdbc:bitbucket:RTK=5246...;Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH |
Database Driver Class Name | cdata.jdbc.bitbucket.BitbucketDriver |
Establishing a JDBC Connection within Airflow
- Log into your Apache Airflow instance.
- On the navbar of your Airflow instance, hover over Admin and then click Connections.
- Next, click the + sign on the following screen to create a new connection.
- In the Add Connection form, fill out the required connection properties:
- Connection Id: Name the connection, i.e.: bitbucket_jdbc
- Connection Type: JDBC Connection
- Connection URL: The JDBC connection URL from above, i.e.: jdbc:bitbucket:RTK=5246...;Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH)
- Driver Class: cdata.jdbc.bitbucket.BitbucketDriver
- Driver Path: PATH/TO/cdata.jdbc.bitbucket.jar
- Test your new connection by clicking the Test button at the bottom of the form.
- After saving the new connection, on a new screen, you should see a green banner saying that a new row was added to the list of connections:
Creating a DAG
A DAG in Airflow is an entity that stores the processes for a workflow and can be triggered to run this workflow. Our workflow is to simply run a SQL query against Bitbucket data and store the results in a CSV file.
- To get started, in the Home directory, there should be an "airflow" folder. Within there, we can create a new directory and title it "dags". In here, we store Python files that convert into Airflow DAGs shown on the UI.
- Next, create a new Python file and title it bitbucket_hook.py. Insert the following code inside of this new file:
import time from datetime import datetime from airflow.decorators import dag, task from airflow.providers.jdbc.hooks.jdbc import JdbcHook import pandas as pd # Declare Dag @dag(dag_id="bitbucket_hook", schedule_interval="0 10 * * *", start_date=datetime(2022,2,15), catchup=False, tags=['load_csv']) # Define Dag Function def extract_and_load(): # Define tasks @task() def jdbc_extract(): try: hook = JdbcHook(jdbc_conn_id="jdbc") sql = """ select * from Account """ df = hook.get_pandas_df(sql) df.to_csv("/{some_file_path}/{name_of_csv}.csv",header=False, index=False, quoting=1) # print(df.head()) print(df) tbl_dict = df.to_dict('dict') return tbl_dict except Exception as e: print("Data extract error: " + str(e)) jdbc_extract() sf_extract_and_load = extract_and_load()
- Save this file and refresh your Airflow instance. Within the list of DAGs, you should see a new DAG titled "bitbucket_hook".
- Click on this DAG and, on the new screen, click on the unpause switch to make it turn blue, and then click the trigger (i.e. play) button to run the DAG. This executes the SQL query in our bitbucket_hook.py file and export the results as a CSV to whichever file path we designated in our code.
- After triggering our new DAG, we check the Downloads folder (or wherever you chose within your Python script), and see that the CSV file has been created - in this case, account.csv.
- Open the CSV file to see that your Bitbucket data is now available for use in CSV format thanks to Apache Airflow.