Access Bitbucket Data from MySQL in PHP

You can use the CData SQL Gateway and ODBC Driver for Bitbucket to access Bitbucket data from MySQL clients, without needing to perform an ETL or cache data. Follow the steps below to connect to Bitbucket data in real time through PHP's standard MySQL interfaces, mysqli and PDO_MySQL.

Connect to Bitbucket Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Bitbucket data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

👁 Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Connect in PHP

The following examples show how to use object-oriented interfaces to connect and execute queries. Initialize the connection object with the following parameters to connect to the virtual MySQL database:

• Host: Specify the remote host location where the service is running. In this case "localhost" is used for the remote host setting since the service is running on the local machine.
• Username: Specify the username for a user you authorized on the SQL Gateway's Users tab.
• Password: Specify the password for the authorized user account.
• Database Name: Specify the system DSN as the database name.
• Port: Specify the port the service is running on; port 3306 in this example.

mysqli

<?php
$mysqli = new mysqli("localhost", "user", "password", "CData Bitbucket Sys","3306");
?>

PDO

<?php
$pdo = new PDO('mysql:host=localhost;dbname=CData Bitbucket Sys;port=3306', 'user', 'password');
?>

Query in PHP

With the connection established, you can then access tables. The following steps walk through the example:

1. Query the table; for example, Issues. The results will be stored as an associative array in the $result object.
2. Iterate over each row and column, printing the values to display in the PHP page.
3. Close the connection.

mysqli

$result = $mysqli->query("SELECT Title, ContentRaw FROM Issues WHERE Id = '1'");
while($row = $result->fetch_assoc()) {
 foreach ($row as $k=>$v) {
 echo "$k : $v";
 echo "<br>"; 
 }
}
$mysqli->close();

PDO

$result = $pdo->query("SELECT Title, ContentRaw FROM Issues WHERE Id = '1'");
while($row = $result->fetch(PDO::FETCH_ASSOC)) {
 foreach ($row as $k=>$v) {
 echo "$k : $v";
 echo "<br>"; 
 }
}
$result = null;
$pdo = null;