Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Perform Batch Operations with Bitbucket Data in Apache NiFi
Connect to Bitbucket data and perform batch operations in Apache NiFi using the CData JDBC Driver.
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 shows how to read data from a CSV file and perform batch operations (INSERT/UPDATE/DELETE) using the CData JDBC Driver for Bitbucket data in Apache NiFi (version 1.9.0 or later).
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.
Generate a JDBC URL
We need a JDBC URL to connect to Bitbucket data from Apachi NiFi.
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.
![Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)](../articles/jdbc-url-builder-0.png)
Batch Operations (INSERT/UPDATE/DELETE) in Apache NiFi
The sample flow presented below is based on the following NiFi Processors:
- ListFile - Retrieves a listing of files from the local filesystem and creates a FlowFile for each retrieved file.
- FetchFile - Reads the content of the FlowFile received from the ListFile processor.
- PutDatabaseRecord - Uses a specified RecordReader to input records from a flow file coming from the FetchFile processor. These records are translated to SQL statements and executed as a single transaction.
- LogAttribute - Emits attributes of the FlowFile at the specified log level.
This is what our finished product looks like:
![NiFi GUI](../articles/jdbc-apache-nifi-batch-operations-1.png)
Disclaimers
1. The column names of the CSV file must match the column names of the data source table records to be inserted/updated/deleted.
2. Apache NiFi versions earlier than 1.9.0 do not support the Maximum Batch Size property in the PutDatabaseRecord processor.
Configurations
In order to perform batch INSERT, UPDATE or DELETE, the NiFi Processors should be configured similar to the following:
- Configure the ListFile processor: Set the Input Directory property to the local folder path from where to pull the CSV files. Set the File Filter property to a regular expression to pick up only the files whose names match the expression. i.e., if the CSV file's full path is C:\Users\Public\Documents\InsertNiFi.csv, the properties should be configured like in the following image:
- Configure the FetchFile processor Leave the FetchFile processor's property configurations to their default values:
- Configure the PutDatabaseRecord processor
- Set the Record Reader property to a CSV Reader Controller Service. Configure the CSV Reader Controller Service to match the format of your CSV file.
- Set the Statement Type property to INSERT.
-
Set the Database Connection Pooling Service to the DBCPConnection Pool that
holds the driver configuration. Please note that the driver should be configured
to use Bulk API.
Property Value Database Connection URL jdbc:bitbucket:Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH Database Driver Class Name cdata.jdbc.bitbucket.BitbucketDriver - Set the Catalog Name property to the name of the catalog that your table is part of.
- Set the Schema Name property to the name of the schema that your table is part of.
- Set the Table Name property to the name of the table that you want to INSERT into.
-
Set the Maximum Batch Size property to the maximum number of records that you want to be included in a single batch.
-
Set the Record Reader property to a CSV Reader Controller Service. Configure the CSV Reader Controller Service to match the format of your CSV file.
- Set the Statement Type property to UPDATE.
- Set the Database Connection Pooling Service to the DBCPConnection Pool that holds the driver configuration. Please note that the driver should be configured to use Bulk API. Use the same Database Connection URL format as seen above.
- Set the Catalog Name property to the name of the catalog that your table is part of.
- Set the Schema Name property to the name of the schema that your table is part of.
- Set the Table Name property to the name of the table that you want to UPDATE.
- Set the Update Keys property to the name of the columns that are required for an UPDATE.
-
Set the Maximum Batch Size property to the maximum number of records that you want to be included in a single batch.
-
Set the Record Reader property to a CSV Reader Controller Service. Configure the CSV Reader Controller Service to match the format of your CSV file.
- Set the Statement Type property to DELETE.
- Set the Database Connection Pooling Service to the DBCPConnection Pool that holds the driver configuration. Please note that the driver should be configured to use Bulk API. Use the same Database Connection URL format as seen above.
- Set the Catalog Name property to the name of the catalog that your table is part of.
- Set the Schema Name property to the name of the schema that your table is part of.
- Set the Table Name property to the name of the table that you want to UPDATE.
- In comparison to INSERT and UPDATE statement types, the DELETE operation does not expose a Maximum Batch Size property. However, the operations are still processed in batches. If not changed, the maximum number of records per batch is 2000, adhering to the default value. In order to change the value of the Maximum Batch Size used for DELETE operations, change the statement type to INSERT or UPDATE, then change the value of the Maximum Batch Size property, and click Apply Changes. Finally, reopen the processor's configuration, change the Statement Type back to DELETE, and click Apply Changes.
-
Configure the LogAttribute processor
Finally, configure the LogAttribute processor by specifying the Attributes that you would like to log or ignore, as well as the log level, based on your use case.
![config for ListFile](../articles/jdbc-apache-nifi-batch-operations-2.png)
![config for FetchFile](../articles/jdbc-apache-nifi-batch-operations-3.png)
INSERT operation
Configure the PutDatabaseRecord processor similar to the following in order to perform Batch INSERT Operations:
![config for PutDatabaseRecord-INSERT](../articles/jdbc-apache-nifi-batch-operations-7.png)
![config for PutDatabaseRecord-INSERT](../articles/jdbc-apache-nifi-batch-operations-8.png)
UPDATE Operation
Configure the PutDatabaseRecord processor similar to the following in order to perform Batch UPDATE Operations:
DELETE Operation
Configure the PutDatabaseRecord processor similar to the following in order to perform Batch DELETE Operations:
![config for PutDatabaseRecord-DELETE](../articles/jdbc-apache-nifi-batch-operations-6.png)
Free Trial & More Information
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.