Natively Connect to Microsoft Dataverse Data in PHP

Drop the CData ODBC Driver for Microsoft Dataverse into your LAMP or WAMP stack to build Microsoft Dataverse-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Microsoft Dataverse data, execute queries, and output the results.

Getting Started

---

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.

You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OrganizationUrl: Set this to the organization URL you are connecting to, such as https://myorganization.crm.dynamics.com.
• Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

When you connect the Common Data Service OAuth endpoint opens in your default browser. Log in and grant permissions. The OAuth process completes automatically.

Establish a Connection

Open the connection to Microsoft Dataverse by calling the or methods. To close connections, use or .

$conn = odbc_connect("CData ODBC CDS Source","user","password");

Connections opened with are closed when the script ends. Connections opened with the 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 CDS Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the function.

$query = odbc_prepare($conn, "SELECT * FROM Accounts WHERE Name = ?");

Execute Queries

Execute prepared statements with .

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

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC CDS Source","user","password");
$query = odbc_exec($conn, "SELECT AccountId, Name FROM Accounts WHERE Name = 'MyAccount'");
 

Process Results

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

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

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

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