VOOZH about

URL: https://www.cdata.com/kb/tech/sentry-odbc-php.rst

⇱ Natively Connect to Sentry Data in PHP


Natively Connect to Sentry Data in PHP

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
The CData ODBC driver for Sentry enables you to create PHP applications with connectivity to Sentry data. Leverage the native support for ODBC in PHP.

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

Sentry uses token-based authentication. To obtain an Auth Token:

  1. Log in to your Sentry account at https://sentry.io
  2. Navigate to Settings > Auth Tokens
  3. Click "Create New Token"
  4. Select the required scopes and click "Create Token"
  5. Copy the generated token (it will only be shown once)

After obtaining your Auth Token, set the following connection properties:

  • AuthScheme: Set this to APIKey.
Set the following in the ProfileSettings connection property:
  • APIKey: Set this to your Sentry Auth Token.
  • OrganizationId: Set this to your Sentry organization slug or ID.

Example Connection String

Profile=C:\profiles\Sentry.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_auth_token;OrganizationId=your_org_slug";

Connecting to Sentry

Once the authentication is configured, you can connect to Sentry and query data from any of the available tables such as Organizations, Projects, Issues, and Events.

Establish a Connection

Open the connection to Sentry 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 UserOrganizations WHERE = ?");

Execute Queries

Execute prepared statements with .

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

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_exec($conn, "SELECT , FROM UserOrganizations WHERE = ''");
 

Process Results

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

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