Natively Connect to Perigon Data in PHP

Drop the CData ODBC Driver for Perigon into your LAMP or WAMP stack to build Perigon-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Perigon 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 use the Perigon API, you need to obtain an API key from your Perigon account. Navigate to the Perigon dashboard and generate an API key from your account settings.

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Perigon API key.

Example connection string:

Profile=C:\profiles\Perigon.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"

Available Tables

The Perigon profile provides access to the following tables:

• Articles - News articles retrieved from the Perigon news intelligence API
• Headlines - Story clusters grouping related headline articles
• Sources - News sources tracked by the Perigon news intelligence API
• Journalists - Journalist profiles tracked by the Perigon news intelligence API

Establish a Connection

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

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Articles 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 Articles WHERE = ''");
 

Process Results

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

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