Natively Connect to Confluence Data in PHP

Drop the CData ODBC Driver for Confluence into your LAMP or WAMP stack to build Confluence-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Confluence data, execute queries, and output the results.

Configure a DSN

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Obtaining an API Token

An API token is necessary for account authentication. To generate one, login to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

Connect Using a Confluence Cloud Account

To connect to a Cloud account, provide the following (Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.):

• User: The user which will be used to authenticate with the Confluence server.
• APIToken: The API Token associated with the currently authenticated user.
• Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

Connect Using a Confluence Server Instance

To connect to a Server instance, provide the following:

• User: The user which will be used to authenticate with the Confluence instance.
• Password: The password which will be used to authenticate with the Confluence server.
• Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

Establish a Connection

Open the connection to Confluence by calling the or methods. To close connections, use or .

$conn = odbc_connect("CData ODBC Confluence Source","user","password");

Connections opened with are closed when the script ends. Connections opened with the 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 Confluence Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the function.

$query = odbc_prepare($conn, "SELECT * FROM Pages WHERE Id = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC Confluence Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Pages WHERE Id = ?");
$success = odbc_execute($query, array('10000'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC Confluence Source","user","password");
$query = odbc_exec($conn, "SELECT Key, Name FROM Pages WHERE Id = '10000'");
 

Process Results

Access a row in the result set as an array with the function.

$conn = odbc_connect("CData ODBC Confluence data Source","user","password");
$query = odbc_exec($conn, "SELECT Key, Name FROM Pages WHERE Id = '10000'");
while($row = odbc_fetch_array($query)){
 echo $row["Key"] . "\n";
}

Display the result set in an HTML table with the function.

$conn = odbc_connect("CData ODBC Confluence data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Pages WHERE Id = ?");
$success = odbc_execute($query, array('10000'));
if($success)
 odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are Confluence-specific adaptations of the PHP community documentation for all ODBC functions.