Query Cosmos DB Data Using the OData SDK for PHP

The CData API Server, when paired with the ADO.NET Provider for Cosmos DB, exposes Cosmos DB data (or data from any of 200+ other ADO.NET Providers) as Web services. You can follow the procedure below to work with Cosmos DB data as PHP objects.

Set Up the API Server

Follow the steps below to begin producing secure Cosmos DB OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Cosmos DB

After you deploy the API Server and the ADO.NET Provider for Cosmos DB, provide authentication values and other connection properties needed to connect to Cosmos DB by clicking Settings -> Connections and adding a new connection in the API Server administration console.

To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

• AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
• AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.

You can then choose the Cosmos DB entities you want to allow the API Server access to by clicking Settings -> Resources.

Additionally, configure the API Server for compatibility with the OData SDK for PHP: Click Server -> Settings and in the OData section set Default Version to 2.0.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. You can authenticate as well as encrypt connections with SSL. Access can also be restricted based on IP address; by default, only connections from the local machine are allowed.

For simplicity, we will authenticate to the API Server by setting the authtoken in the URL. This is not enabled by default; you will need to add the following lines to the API Server configuration file, settings.cfg.

The settings.cfg file is located in the data directory. In the .NET edition, the data directory is the app_data folder under the www folder. In the Java edition, the data directory's location depends on the operation system:

• Windows: C:\ProgramData\CData\CosmosDB\
• Unix or Mac OS X: ~/cdata/CosmosDB/

Work with Cosmos DB Entities as PHP Objects

Follow the steps below to use the ODataPHP SDK to create a proxy class that will connect to the Web services exposed by the API Server.

1. Pass the URL to a command like the one below:

   php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-authtoken/ /out=C:\PHPLib\ODataphp\CosmosDBEntities.php

   The preceding command defines classes from the metadata returned in the response from the OData endpoint, then outputs the class definitions to the specified folder.

   Both the API Server and the OData SDK for PHP support forms and Windows authentication. The API Server uses authtokens to authenticate users authorized to access the OData endpoint. You can supply authtokens in HTTP Basic authentication or append them to the OData URL.

   You can configure authorized users in the Settings -> Users section of the API Server administration console.

2. You can now start accessing Cosmos DB data using an object-oriented interface in PHP. The code below creates a record of the Customers table and then retrieves the live data, showing the newly created record.

   require_once 'CosmosDBEntities.php'; try{ $svc = new CData(); $customers = new Customers(); $customers->Name = 'Morris Park Bake Shop'; $svc->AddToCustomers($customers); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->customers()->Execute(); foreach($response->Result as $customers) echo $customers->City."
"; } catch (Exception $e) { //catch errors from the API Server echo $e->getError(), "\n"; }