Learn more
 

Ready to get started?

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

 Download Now

Learn more:

SuiteCRM Icon SuiteCRM ODBC Driver

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

Access CRM data like you would a database - read, write, and update Leads, Contacts, Opportunities, Accounts, etc. through a standard ODBC Driver interface.

In this article

Related articles

Natively Connect to SuiteCRM Data in PHP


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

Drop the CData ODBC Driver for SuiteCRM into your LAMP or WAMP stack to build SuiteCRM-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to SuiteCRM 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 User and Password properties must be set to valid SuiteCRM user credentials. Additionally, specify the URL to the SuiteCRM application, for example http://suite.crm.com.

Note that retrieving SuiteCRM metadata can be expensive. It is advised that you store the metadata locally as described in the Caching Metadata section of the data provider help documentation.

Establish a Connection

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

$conn = odbc_connect("CData ODBC SuiteCRM 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 SuiteCRM 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 Accounts WHERE Industry = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC SuiteCRM Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Accounts WHERE Industry = ?"); $success = odbc_execute($query, array('Manufacturing'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC SuiteCRM Source","user","password"); $query = odbc_exec($conn, "SELECT Name, Industry FROM Accounts");

Process Results

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

$conn = odbc_connect("CData ODBC SuiteCRM data Source","user","password"); $query = odbc_exec($conn, "SELECT Name, Industry FROM Accounts"); while($row = odbc_fetch_array($query)){ echo $row["Name"] . "\n"; }

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

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