Learn more
 

Natively Connect to CouchDB Data in PHP


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

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

  • Url: The Url of your instance. For example: http://localhost:5984
  • User The Apache CouchDB user account used to authenticate.
  • Password The Apache CouchDB password associated with the authenticating user.

Establish a Connection

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

$conn = odbc_connect("CData ODBC ApacheCouchDB 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 ApacheCouchDB 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 ApacheCouchDB 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 ApacheCouchDB Source","user","password"); $query = odbc_exec($conn, "SELECT MovieRuntime, MovieRating FROM Movies WHERE MovieRating = 'R'");

Process Results

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

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

Ready to get started?

Download a free trial of the CouchDB ODBC Driver to get started:

 Download Now

Learn more:

CouchDB Icon CouchDB ODBC Driver

The CouchDB ODBC Driver is a powerful tool that allows you to connect with live data from CouchDB, directly from any applications that support ODBC connectivity.

Access CouchDB data like you would a database - read, write, and update CouchDB. through a standard ODBC Driver interface.

In this article

Related articles