Natively Connect to Rootly Data in PHP
Drop the CData ODBC Driver for Rootly into your LAMP or WAMP stack to build Rootly-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Rootly 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
To authenticate using an API key, you will need to obtain your API key from your Rootly account settings.
To get your API key:
- Log in to your Rootly account
- Navigate to Settings > API & Integrations
- Click on "API Tokens"
- Copy the generated token
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Rootly API token.
Example Connection String
Profile=Rootly.apip;Authscheme=APIKey;ProfileSettings="APIKey=your_apikey";
Establish a Connection
Open the connection to Rootly by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.
$conn = odbc_connect("CData ODBC API 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 API 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 Incidents WHERE Status = ?");
Execute Queries
Execute prepared statements with odbc_execute.
$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Incidents WHERE Status = ?");
$success = odbc_execute($query, array('started'));
Execute nonparameterized queries with odbc_exec.
$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_exec($conn, "SELECT , FROM Incidents WHERE Status = 'started'");
Process Results
Access a row in the result set as an array with the odbc_fetch_array function.
$conn = odbc_connect("CData ODBC Rootly data Source","user","password");
$query = odbc_exec($conn, "SELECT , FROM Incidents WHERE Status = 'started'");
while($row = odbc_fetch_array($query)){
echo $row[""] . "\n";
}
Display the result set in an HTML table with the odbc_result_all function.
$conn = odbc_connect("CData ODBC Rootly data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Incidents WHERE Status = ?");
$success = odbc_execute($query, array('started'));
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 Rootly-specific adaptations of the PHP community documentation for all ODBC functions.