Load Bitbucket Data to a Database Using Embulk

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for Bitbucket, Embulk easily loads data from Bitbucket to any supported destination. In this article, we explain how to use the CData JDBC Driver for Bitbucket in Embulk to load Bitbucket data to a MySQL dtabase.

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).

Configure a JDBC Connection to Bitbucket Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Bitbucket\lib).

Embulk supports JDBC connectivity, so you can easily connect to Bitbucket and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with Bitbucket.

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.)

Below is a typical JDBC connection string for Bitbucket:

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

Load Bitbucket Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

1. Install the JDBC Input Plugin in Embulk.
   https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

embulk gem install embulk-input-jdbc

2. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
   https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql

   embulk gem install embulk-output-mysql
   

With the input and output plugins installed, we are ready to load Bitbucket data into MySQL using Embulk.

Create a Job to Load Bitbucket Data

Start by creating a config file in Embulk, using a name like bitbucket-mysql.yml.

1. For the input plugin options, use the CData JDBC Driver for Bitbucket, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.bitbucket.BitbucketDriver), and the JDBC URL from above
2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (bitbucket-mysql.yml)

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.bitbucket.jar
	driver_class: cdata.jdbc.bitbucket.BitbucketDriver
	url: jdbc:bitbucket:Workspace=myworkspaceslug;Schema=Information;InitiateOAuth=GETANDREFRESH;
	table: "Issues"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Issues"
	mode: insert

After creating the file, run the Embulk job.

embulk run bitbucket-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered Bitbucket Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.bitbucket.jar
	driver_class: cdata.jdbc.bitbucket.BitbucketDriver
	url: jdbc:bitbucket:Workspace=myworkspaceslug;Schema=Information;InitiateOAuth=GETANDREFRESH;
	query: "SELECT Title, ContentRaw FROM Issues WHERE [RecordId] = 1"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Issues"
	mode: insert

More Information & Free Trial

By using CData JDBC Driver for Bitbucket as a connector, Embulk can integrate Bitbucket data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.