VOOZH about

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

⇱ Natively Connect to Drift Data in PHP


Natively Connect to Drift Data in PHP

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

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

Start by setting the Profile connection property to the location of the Drift Profile on disk (e.g. C:\profiles\Drift.apip). Next, set the ProfileSettings connection property to the connection string for Drift (see below).

Drift API Profile Settings

Drift uses OAuth-based authentication.

You must first register an application here: https://dev.drift.com. Your app will be assigned a client ID and a client secret. Set these in your connection string via the OAuthClientId and OAuthClientSecret properties. More information on setting up an OAuth application can be found at https://devdocs.drift.com/docs/.

After setting the following options in the ProfileSettings connection property, you are ready to connect:

  • AuthScheme: Set this to OAuth.
  • OAuthClientId: Set this to the Client Id that is specified in your app settings.
  • OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
  • CallbackURL: Set this to the Redirect URI you specified in your app settings.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.

Establish a Connection

Open the connection to Drift 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 Contacts WHERE LastName = ?");

Execute Queries

Execute prepared statements with .

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

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_exec($conn, "SELECT Id, DisplayName FROM Contacts WHERE LastName = 'Stark'");
 

Process Results

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

$conn = odbc_connect("CData ODBC Drift data Source","user","password");
$query = odbc_exec($conn, "SELECT Id, DisplayName FROM Contacts WHERE LastName = 'Stark'");
while($row = odbc_fetch_array($query)){
 echo $row["Id"] . "\n";
}

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

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