Natively Connect to CircleCI Data in PHP

Drop the CData ODBC Driver for CircleCI into your LAMP or WAMP stack to build CircleCI-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to CircleCI 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.

Using API Key Authentication

CircleCI uses personal API tokens to authenticate API requests. To generate a personal API token, log in to your CircleCI account, navigate to User Settings > Personal API Tokens, and click Create New Token. Copy the token value immediately as it is only shown once.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your CircleCI personal API token.

Example connection string:

Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';

Establish a Connection

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

$conn = odbc_connect("CData ODBC API 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 API 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 Artifacts WHERE ProjectSlug = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Artifacts WHERE ProjectSlug = ?");
$success = odbc_execute($query, array('github/MyOrg/my-repo'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_exec($conn, "SELECT , FROM Artifacts WHERE ProjectSlug = 'github/MyOrg/my-repo'");
 

Process Results

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

$conn = odbc_connect("CData ODBC CircleCI data Source","user","password");
$query = odbc_exec($conn, "SELECT , FROM Artifacts WHERE ProjectSlug = 'github/MyOrg/my-repo'");
while($row = odbc_fetch_array($query)){
 echo $row[""] . "\n";
}

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

$conn = odbc_connect("CData ODBC CircleCI data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Artifacts WHERE ProjectSlug = ?");
$success = odbc_execute($query, array('github/MyOrg/my-repo'));
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 CircleCI-specific adaptations of the PHP community documentation for all ODBC functions.