Natively Connect to Azure Synapse Data in PHP

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

Connecting to Azure Synapse

In addition to providing authentication (see below), set the following properties to connect to a Azure Synapse database:

• Server: The server running Azure. You can find this by logging into the Azure portal and navigating to Azure Synapse Analytics -> Select your database -> Overview -> Server name.
• Database: The name of the database, as seen in the Azure portal on the Azure Synapse Analytics page.

Authenticating to Azure Synapse

Connect to Azure Synapse using the following properties:

• User: The username provided for authentication with Azure.
• Password: The password associated with the authenticating user.

Establish a Connection

Open the connection to Azure Synapse by calling the or methods. To close connections, use or .

$conn = odbc_connect("CData ODBC AzureSynapse 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 AzureSynapse 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 Products WHERE ProductName = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC AzureSynapse Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Products WHERE ProductName = ?");
$success = odbc_execute($query, array('Konbu'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC AzureSynapse Source","user","password");
$query = odbc_exec($conn, "SELECT Id, ProductName FROM Products WHERE ProductName = 'Konbu'");
 

Process Results

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

$conn = odbc_connect("CData ODBC Azure Synapse data Source","user","password");
$query = odbc_exec($conn, "SELECT Id, ProductName FROM Products WHERE ProductName = 'Konbu'");
while($row = odbc_fetch_array($query)){
 echo $row["Id"] . "\n";
}

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

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