Natively Connect to Databricks Data in PHP

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

To connect to a Databricks cluster, set the properties as described below.

Note: The needed values can be found in your Databricks instance by navigating to Clusters, and selecting the desired cluster, and selecting the JDBC/ODBC tab under Advanced Options.

• Server: Set to the Server Hostname of your Databricks cluster.
• HTTPPath: Set to the HTTP Path of your Databricks cluster.
• Token: Set to your personal access token (this value can be obtained by navigating to the User Settings page of your Databricks instance and selecting the Access Tokens tab).

Establish a Connection

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

$conn = odbc_connect("CData ODBC Databricks 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 Databricks 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 Customers WHERE Country = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC Databricks Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Customers WHERE Country = ?");
$success = odbc_execute($query, array('US'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC Databricks Source","user","password");
$query = odbc_exec($conn, "SELECT City, CompanyName FROM Customers WHERE Country = 'US'");
 

Process Results

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

$conn = odbc_connect("CData ODBC Databricks data Source","user","password");
$query = odbc_exec($conn, "SELECT City, CompanyName FROM Customers WHERE Country = 'US'");
while($row = odbc_fetch_array($query)){
 echo $row["City"] . "\n";
}

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

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