Natively Connect to Suadeo Data in PHP

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

The driver uses the OAuth 2.0 Resource Owner Password Credentials (ROPC) grant to authenticate to Suadeo. Authentication occurs directly using your credentials; there is no browser-based authorization flow or refresh token.

Set the following connection properties:

• URL: The base URL of your Suadeo instance.
• User: Your Suadeo username.
• Password: Your Suadeo password.
• AuthenticationName: The name identifier for the authentication configuration in your Suadeo instance. Different authentication names can be configured for different environments or use cases.

When you connect, the driver sends your credentials to the Suadeo OAuth token endpoint, receives an access token, and uses it for all subsequent requests. A new access token is obtained automatically when needed during the session.

Establish a Connection

Open the connection to Suadeo by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

$conn = odbc_connect("CData ODBC Suadeo 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 Suadeo 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 Customers WHERE Status = ?");

Execute Queries

Execute prepared statements with odbc_execute.

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

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC Suadeo Source","user","password");
$query = odbc_exec($conn, "SELECT Id, Name FROM Customers WHERE Status = 'Active'");
  

Process Results

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

$conn = odbc_connect("CData ODBC Suadeo data Source","user","password");
$query = odbc_exec($conn, "SELECT Id, Name FROM Customers WHERE Status = 'Active'");
while($row = odbc_fetch_array($query)){
 echo $row["Id"] . "\n";
}

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

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