Access Cosmos DB Data in PHP through Connect Cloud

Ready to get started?

Learn more or sign up for a free trial:

CData Connect



Connect to Cosmos DB through the standard MySQL libraries in PHP.

You can use CData Connect Cloud to access Cosmos DB data from MySQL clients, without needing to perform an ETL or cache data. Follow the steps below to create a virtual MySQL database for Cosmos DB and connect to Cosmos DB data in real time through PHP's standard MySQL interfaces, mysqli and PDO_MySQL.

CData Connect Cloud provides a pure MySQL, cloud-to-cloud interface for Cosmos DB, allowing you to easily query live Cosmos DB data in PHP — without replicating the data to a natively supported database. As you query data in PHP, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc) directly to Cosmos DB, leveraging server-side processing to quickly return Cosmos DB data.

Create a Virtual MySQL Database for Cosmos DB Data

CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Login to Connect Cloud and click Databases.
  2. Select "Cosmos DB" from Available Data Sources.
  3. Enter the necessary authentication properties to connect to Cosmos DB.

    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.
  4. Click Test Database.
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to Cosmos DB data from any MySQL client.

Connect in PHP

The following examples show how to use object-oriented interfaces to connect and execute queries. Initialize the connection object with the following parameters to connect to the virtual MySQL database:

  • Host: Specify the remote host location where the service is running. In this case "myinstance.cdatacloud.net" is used for the remote host setting since the service is running on the local machine.
  • Username: Specify the username for a user you authorized in Connect Cloud.
  • Password: Specify the password for the authorized user account.
  • Database Name: Specify the name of the virtual database you created for Cosmos DB.
  • Port: Specify the port the service is running on, port 3306 in this example.

mysqli

<?php
$mysqli = mysqli_init();

$mysqli->ssl_set("C:/certs/cloudclient.key",
                 "C:/certs/cloudclient.pem",
                 "C:/certs/myCA.pem",
                 NULL,NULL);

$mysqli->real_connect("mysintance.cdatacloud.net", "admin", "mypassword", "cosmosdbdb",3306,NULL,MYSQLI_CLIENT_SSL_DONT_VERIFY_SERVER_CERT);
?>

PDO

<?php
$pdo = new PDO('mysql:host=myinstance.cdatacloud.net;dbname=cosmosdbdb;port=3306;','admin', 'mypassword', array(
    PDO::MYSQL_ATTR_SSL_KEY                => 'C:/certs/cloudclient.key',
    PDO::MYSQL_ATTR_SSL_CERT               => 'C:/certs/cloudclient.pem',
    PDO::MYSQL_ATTR_SSL_CA                 => 'C:/certs/myCA.pem',
    PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => false
    )
);
?>

Query in PHP

With the connection established, you can then access tables. The following steps walk through the example:

  1. Query the table; for example, Customers. The results will be stored as an associative array in the $result object.
  2. Iterate over each row and column, printing the values to display in the PHP page.
  3. Close the connection.

mysqli

$result = $mysqli->query("SELECT City, CompanyName FROM Customers");
while($row = $result->fetch_assoc()) {
  foreach ($row as $k=>$v) {
    echo "$k : $v";
    echo "<br />"; 
  }
}
$mysqli->close();

PDO

$result = $pdo->query("SELECT City, CompanyName FROM Customers");
while($row = $result->fetch(PDO::FETCH_ASSOC)) {
  foreach ($row as $k=>$v) {
    echo "$k : $v";
    echo "<br />"; 
  }
}
$result = null;
$pdo = null;