Natively Connect to CockroachDB Data in PHP

Ready to get started?

Download for a free trial:

Download Now

Learn more:

CockroachDB ODBC Driver

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

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



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

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

  • Server: The host name or IP address of the server.
  • Port: The port number of the CockroachDB server. If not specified, the default port is 26257.
  • Database: The name of the Cockroach database. If not specified, you connect to the user's default database.
  • User: The Cockroach DB user account used to authenticate.
  • Password: The password used to authenticate the user.

Establish a Connection

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

$conn = odbc_connect("CData ODBC CockroachDB 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 CockroachDB 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 Orders WHERE ShipCountry = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC CockroachDB Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Orders WHERE ShipCountry = ?"); $success = odbc_execute($query, array('USA'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC CockroachDB Source","user","password"); $query = odbc_exec($conn, "SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'");

Process Results

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

$conn = odbc_connect("CData ODBC CockroachDB data Source","user","password"); $query = odbc_exec($conn, "SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'"); while($row = odbc_fetch_array($query)){ echo $row["ShipName"] . "\n"; }

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

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