Ready to get started?

Learn more about the CData ODBC Driver for IBM Cloudant or download a free trial:

Download Now

Natively Connect to Cloudant Data in PHP

The CData ODBC driver for Cloudant enables you to create PHP applications with connectivity to Cloudant data. Leverage the native support for ODBC in PHP.

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

Set the following connection properties to connect to Cloudant:

  • User: Set this to your username.
  • Password: Set this to your password.

Establish a Connection

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

$conn = odbc_connect("CData ODBC Cloudant 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 Cloudant 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 Movies WHERE MovieRating = ?");

Execute Queries

Execute prepared statements with odbc_execute.

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

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC Cloudant Source","user","password"); $query = odbc_exec($conn, "SELECT MovieRuntime, MovieRating FROM Movies");

Process Results

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

$conn = odbc_connect("CData ODBC Cloudant data Source","user","password"); $query = odbc_exec($conn, "SELECT MovieRuntime, MovieRating FROM Movies"); while($row = odbc_fetch_array($query)){ echo $row["MovieRuntime"] . "\n"; }

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

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