Natively Connect to SharePoint Excel Services Data in PHP

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

The URL, User, and Password properties, under the Authentication section, must be set to valid credentials for SharePoint Online, SharePoint 2010, or SharePoint 2013. Additionally, the Library property must be set to a valid SharePoint Document Library and the File property must be set to a valid .xlsx file in the indicated Library.

Establish a Connection

Open the connection to SharePoint Excel Services by calling the or methods. To close connections, use or .

$conn = odbc_connect("CData ODBC ExcelServices 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 ExcelServices 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 Account WHERE Industry = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC ExcelServices Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Account WHERE Industry = ?");
$success = odbc_execute($query, array('Floppy Disks'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC ExcelServices Source","user","password");
$query = odbc_exec($conn, "SELECT Name, AnnualRevenue FROM Account");
 

Process Results

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

$conn = odbc_connect("CData ODBC SharePoint Excel Services data Source","user","password");
$query = odbc_exec($conn, "SELECT Name, AnnualRevenue FROM Account");
while($row = odbc_fetch_array($query)){
 echo $row["Name"] . "\n";
}

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

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