Natively Connect to Azure Data Lake Storage Data in PHP

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Azure Data Lake Storage ODBC Driver

The Azure Data Lake Storage ODBC Driver is a powerful tool that allows you to connect with live data from Azure Data Lake Storage, directly from any applications that support ODBC connectivity.

Access Azure Data Lake Storage data like you would a database - read, write, and update Azure Data Lake Storage ADLSData, etc. through a standard ODBC Driver interface.



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

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

Authenticating to a Gen 1 DataLakeStore Account

Gen 1 uses OAuth 2.0 in Azure AD for authentication.

For this, an Active Directory web application is required. You can create one as follows:

  1. Sign in to your Azure Account through the .
  2. Select "Azure Active Directory".
  3. Select "App registrations".
  4. Select "New application registration".
  5. Provide a name and URL for the application. Select Web app for the type of application you want to create.
  6. Select "Required permissions" and change the required permissions for this app. At a minimum, "Azure Data Lake" and "Windows Azure Service Management API" are required.
  7. Select "Key" and generate a new key. Add a description, a duration, and take note of the generated key. You won't be able to see it again.

To authenticate against a Gen 1 DataLakeStore account, the following properties are required:

  • Schema: Set this to ADLSGen1.
  • Account: Set this to the name of the account.
  • OAuthClientId: Set this to the application Id of the app you created.
  • OAuthClientSecret: Set this to the key generated for the app you created.
  • TenantId: Set this to the tenant Id. See the property for more information on how to acquire this.
  • Directory: Set this to the path which will be used to store the replicated file. If not specified, the root directory will be used.

Authenticating to a Gen 2 DataLakeStore Account

To authenticate against a Gen 2 DataLakeStore account, the following properties are required:

  • Schema: Set this to ADLSGen2.
  • Account: Set this to the name of the account.
  • FileSystem: Set this to the file system which will be used for this account.
  • AccessKey: Set this to the access key which will be used to authenticate the calls to the API. See the property for more information on how to acquire this.
  • Directory: Set this to the path which will be used to store the replicated file. If not specified, the root directory will be used.

Establish a Connection

Open the connection to Azure Data Lake Storage by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

$conn = odbc_connect("CData ODBC ADLS 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 ADLS 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 Resources WHERE Type = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC ADLS Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Resources WHERE Type = ?"); $success = odbc_execute($query, array('FILE'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC ADLS Source","user","password"); $query = odbc_exec($conn, "SELECT FullPath, Permission FROM Resources WHERE Type = 'FILE'");

Process Results

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

$conn = odbc_connect("CData ODBC Azure Data Lake Storage data Source","user","password"); $query = odbc_exec($conn, "SELECT FullPath, Permission FROM Resources WHERE Type = 'FILE'"); while($row = odbc_fetch_array($query)){ echo $row["FullPath"] . "\n"; }

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

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