Natively Connect to Lakebase Data in PHP

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

• DatabricksInstance: The Databricks instance or server hostname, provided in the format instance-abcdef12-3456-7890-abcd-abcdef123456.database.cloud.databricks.com.
• Server: The host name or IP address of the server hosting the Lakebase database.
• Port (optional): The port of the server hosting the Lakebase database, set to 5432 by default.
• Database (optional): The database to connect to after authenticating to the Lakebase Server, set to the authenticating user's default database by default.

OAuth Client Authentication

To authenicate using OAuth client credentials, you need to configure an OAuth client in your service principal. In short, you need to do the following:

1. Create and configure a new service principal
2. Assign permissions to the service principal
3. Create an OAuth secret for the service principal

For more information, refer to the Setting Up OAuthClient Authentication section in the Help documentation.

OAuth PKCE Authentication

To authenticate using the OAuth code type with PKCE (Proof Key for Code Exchange), set the following properties:

• AuthScheme: OAuthPKCE.
• User: The authenticating user's user ID.

For more information, refer to the Help documentation.

Establish a Connection

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

$conn = odbc_connect("CData ODBC Lakebase 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 Lakebase 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 Lakebase 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 Lakebase 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 Lakebase 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 Lakebase 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 Lakebase-specific adaptations of the PHP community documentation for all ODBC functions.