Model Context Protocol (MCP) finally gives AI models a way to access the business data needed to make them really useful at work. CData MCP Servers have the depth and performance to make sure AI has access to all of the answers.
Try them now for free →
Natively Connect to Bitbucket Data in PHP
Create PHP applications on Linux/UNIX machines with connectivity to Bitbucket data. Leverage the native support for ODBC in PHP.
Drop the CData ODBC Driver for Bitbucket into your LAMP or WAMP stack to build Bitbucket-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Bitbucket data, execute queries, and output the results.
Using the CData ODBC Drivers on a UNIX/Linux Machine
The CData ODBC Drivers are supported in various Red Hat-based and Debian-based systems, including Ubuntu, Debian, RHEL, CentOS, and Fedora. There are also several libraries and packages that are required, many of which may be installed by default, depending on your system. For more information on the supported versions of Linux operating systems and the required libraries, please refer to the "Getting Started" section in the help documentation (installed and found online).
Installing the Driver Manager
Before installing the driver, check that your system has a driver manager. For this article, you will use unixODBC, a free and open source ODBC Driver manager that is widely supported.
For Debian-based systems like Ubuntu, you can install unixODBC with the APT package manager:
$ sudo apt-get install unixodbc unixodbc-dev
For systems based on Red Hat Linux, you can install unixODBC with yum or dnf:
$ sudo yum install unixODBC unixODBC-devel
The unixODBC driver manager reads information about drivers from an odbcinst.ini file and about data sources from an odbc.ini file. You can determine the location of the configuration files on your system by entering the following command into a terminal:
$ odbcinst -j
The output of the command will display the locations of the configuration files for ODBC data sources and registered ODBC drivers. User data sources can only be accessed by the user account whose home folder the odbc.ini is located in. System data sources can be accessed by all users. Below is an example of the output of this command:
DRIVERS............: /etc/odbcinst.ini
SYSTEM DATA SOURCES: /etc/odbc.ini
FILE DATA SOURCES..: /etc/ODBCDataSources
USER DATA SOURCES..: /home/myuser/.odbc.ini
SQLULEN Size.......: 8
SQLLEN Size........: 8
SQLSETPOSIROW Size.: 8
Installing the Driver
You can download the driver in standard package formats: the Debian .deb package format or the .rpm file format. Once you have downloaded the file, you can install the driver from the terminal.
The driver installer registers the driver with unixODBC and creates a system DSN, which can be used later in any tools or applications that support ODBC connectivity.
For Debian-based systems like Ubuntu, run the following command with sudo or as root:
$ dpkg -i /path/to/package.deb
For Red Hat systems or other systems that support .rpms, run the following command with sudo or as root:
$ rpm -i /path/to/package.rpm
Once the driver is installed, you can list the registered drivers and defined data sources using the unixODBC driver manager:
List the Registered Driver(s)
$ odbcinst -q -d
CData ODBC Driver for Bitbucket
...
List the Defined Data Source(s)
$ odbcinst -q -s
CData Bitbucket Source
...
To use the CData ODBC Driver for Bitbucket with unixODBC, ensure that the driver is configured to use UTF-16. To do so, edit the INI file for the driver (cdata.odbc.bitbucket.ini), which can be found in the lib folder in the installation location (typically /opt/cdata/cdata-odbc-driver-for-bitbucket), as follows:
cdata.odbc.bitbucket.ini
...
[Driver]
DriverManagerEncoding = UTF-16
Modifying the DSN
The driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties. Additionally, you can create user-specific DSNs that will not require root access to modify in $HOME/.odbc.ini.
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.
/etc/odbc.ini or $HOME/.odbc.ini
[CData Bitbucket Source]
Driver = CData ODBC Driver for Bitbucket
Description = My Description
Workspace = myworkspaceslug
Schema = Information
For specific information on using these configuration files, please refer to the help documentation (installed and found online).
Establish a Connection
Open the connection to Bitbucket by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.
$conn = odbc_connect("CData ODBC Bitbucket Source","user","password");
Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources and queries execute faster.
$conn = odbc_pconnect("CData ODBC Bitbucket Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly
Create Prepared Statements
Create prepared statements and parameterized queries with the odbc_prepare function.
$query = odbc_prepare($conn, "SELECT * FROM Issues WHERE Id = ?");
Execute Queries
Execute prepared statements with odbc_execute.
$conn = odbc_connect("CData ODBC Bitbucket Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Issues WHERE Id = ?");
$success = odbc_execute($query, array('1'));
Execute nonparameterized queries with odbc_exec.
$conn = odbc_connect("CData ODBC Bitbucket Source","user","password");
$query = odbc_exec($conn, "SELECT Title, ContentRaw FROM Issues WHERE Id = '1'");
Process Results
Access a row in the result set as an array with the odbc_fetch_array function.
$conn = odbc_connect("CData ODBC Bitbucket data Source","user","password");
$query = odbc_exec($conn, "SELECT Title, ContentRaw FROM Issues WHERE Id = '1'");
while($row = odbc_fetch_array($query)){
echo $row["Title"] . "\n";
}
Display the result set in an HTML table with the odbc_result_all function.
$conn = odbc_connect("CData ODBC Bitbucket data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Issues WHERE Id = ?");
$success = odbc_execute($query, array('1'));
if($success)
odbc_result_all($query);
More Example Queries
You will find complete information on the SQL queries supported by the driver in the help documentation. The code examples above are Bitbucket-specific adaptations of the PHP community documentation for all ODBC functions.
Ready to get started?
Download a free trial of the Bitbucket ODBC Driver to get started:
Download NowLearn more:
Bitbucket ODBC Driver
The Bitbucket ODBC Driver is a powerful tool that allows you to connect with live data from Bitbucket, directly from any applications that support ODBC connectivity.
Access Bitbucket data like you would a database - read, write, and update Bitbucket 0, etc. through a standard ODBC Driver interface.
