Query Bitbucket Data in ColdFusion

The CData JDBC Driver for Bitbucket seamlessly integrates connectivity to Bitbucket data with the rapid development tools in ColdFusion. This article shows how to connect to Bitbucket data in ColdFusion and query Bitbucket tables.

Create a JDBC Data Source for Bitbucket in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

   The JAR and license for the driver are located in the lib subfolder of the installation directory.

   Restart the server after this step.

2. Add the driver as a data source:

   From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

3. Populate the driver properties:

   • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:bitbucket: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

     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.

     A typical JDBC URL is below:

     jdbc:bitbucket:Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH
   • Driver Class: Enter the driver class. The driver class is cdata.jdbc.bitbucket.BitbucketDriver.
   • Driver Name: Enter a user-defined name for the driver.
   • Username: Enter the username used to authenticate.
   • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData Bitbucket data source in the Actions column. After reporting a status of OK, the Bitbucket data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Bitbucket, including INSERT, UPDATE, and DELETE.. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

Note: To use the cfquery and cfscript, create a .cfm file. Inside the .cfm file, write the code to execute the query (see below). Place the file directly in the root directory of your web server (e.g., wwwroot in Adobe ColdFusion). Restart the service after placing the file for the changes to take effect.

Below is the equivalent in CFScript:

<cfscript>
result = queryExecute(
  "SELECT * FROM Issues WHERE Id = ?", 
  [
    { value="1", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataBitbucket" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following: