ZendService\WindowsAzure\Storage\Table

The Table service offers structured storage in the form of tables.

Table Storage is offered by Windows Azure as a REST API which is wrapped by the ZendService\WindowsAzure\Storage\Table class in order to provide a native PHP interface to the storage account.

This topic lists some examples of using the ZendService\WindowsAzure\Storage\Table class. Other features are available in the download package, as well as a detailed API documentation of those features.

Note that development table storage (in the Windows Azure SDK) does not support all features provided by the API. Therefore, the examples listed on this page are to be used on Windows Azure production table storage.

Operations on tables

This topic lists some samples of operations that can be executed on tables.

Creating a table

Using the following code, a table can be created on Windows Azure production table storage.

Creating a table

$storageClient = new ZendService\WindowsAzure\Storage\Table(
    'table.core.windows.net', 'myaccount', 'myauthkey'
);
$result = $storageClient->createTable('testtable');

echo 'New table name is: ' . $result->Name;

Listing all tables

Using the following code, a list of all tables in Windows Azure production table storage can be queried.

Listing all tables

$storageClient = new ZendService\WindowsAzure\Storage\Table(
    'table.core.windows.net', 'myaccount', 'myauthkey'
);
$result = $storageClient->listTables();
foreach ($result as $table) {
    echo 'Table name is: ' . $table->Name . "\r\n";
}

Operations on entities

Tables store data as collections of entities. Entities are similar to rows. An entity has a primary key and a set of properties. A property is a named, typed-value pair, similar to a column.

The Table service does not enforce any schema for tables, so two entities in the same table may have different sets of properties. Developers may choose to enforce a schema on the client side. A table may contain any number of entities.

ZendService\WindowsAzure\Storage\Table provides 2 ways of working with entities:

• Enforced schema
• No enforced schema

All examples will make use of the following enforced schema class.

Enforced schema used in samples

class SampleEntity extends ZendService\WindowsAzure\Storage\TableEntity
{
    /**
    * @azure Name
    */
    public $Name;

    /**
    * @azure Age Edm.Int64
    */
    public $Age;

    /**
    * @azure Visible Edm.Boolean
    */
    public $Visible = false;
}

Note that if no schema class is passed into table storage methods, ZendService\WindowsAzure\Storage\Table automatically works with ZendService\WindowsAzure\Storage\DynamicTableEntity.

Enforced schema entities

To enforce a schema on the client side using the ZendService\WindowsAzure\Storage\Table class, you can create a class which inherits ZendService\WindowsAzure\Storage\TableEntity. This class provides some basic functionality for the ZendService\WindowsAzure\Storage\Table class to work with a client-side schema.

Base properties provided by ZendService\WindowsAzure\Storage\TableEntity are:

• PartitionKey (exposed through getPartitionKey() and setPartitionKey())
• RowKey (exposed through getRowKey() and setRowKey())
• Timestamp (exposed through getTimestamp() and setTimestamp())
• Etag value (exposed through getEtag() and setEtag())

Here’s a sample class inheriting ZendService\WindowsAzure\Storage\TableEntity:

Sample enforced schema class

class SampleEntity extends ZendService\WindowsAzure\Storage\TableEntity
{
    /**
     * @azure Name
     */
    public $Name;

    /**
     * @azure Age Edm.Int64
     */
    public $Age;

    /**
     * @azure Visible Edm.Boolean
     */
    public $Visible = false;
}

The ZendService\WindowsAzure\Storage\Table class will map any class inherited from ZendService\WindowsAzure\Storage\TableEntity to Windows Azure table storage entities with the correct data type and property name. All there is to storing a property in Windows Azure is adding a docblock comment to a public property or public getter/setter, in the following format:

Enforced property

/**
 * @azure <property name in Windows Azure> <optional property type>
 */
public $<property name in PHP>;

Let’s see how to define a property “Age” as an integer on Windows Azure table storage:

Sample enforced property

/**
 * @azure Age Edm.Int64
 */
public $Age;

Note that a property does not necessarily have to be named the same on Windows Azure table storage. The Windows Azure table storage property name can be defined as well as the type.

The following data types are supported:

• Edm.Binary- An array of bytes up to 64 KB in size.
• Edm.Boolean- A boolean value.
• Edm.DateTime- A 64-bit value expressed as Coordinated Universal Time (UTC). The supported DateTime range begins from 12:00 midnight, January 1, 1601 A.D. (C.E.), Coordinated Universal Time (UTC). The range ends at December 31st, 9999.
• Edm.Double- A 64-bit floating point value.
• Edm.Guid- A 128-bit globally unique identifier.
• Edm.Int32- A 32-bit integer.
• Edm.Int64- A 64-bit integer.
• Edm.String- A UTF-16-encoded value. String values may be up to 64 KB in size.

No enforced schema entities (a.k.a. DynamicEntity)

To use the ZendService\WindowsAzure\Storage\Table class without defining a schema, you can make use of the ZendService\WindowsAzure\Storage\DynamicTableEntity class. This class inherits ZendService\WindowsAzure\Storage\TableEntity like an enforced schema class does, but contains additional logic to make it dynamic and not bound to a schema.

Base properties provided by ZendService\WindowsAzure\Storage\DynamicTableEntity are:

• PartitionKey (exposed through getPartitionKey() and setPartitionKey())
• RowKey (exposed through getRowKey() and setRowKey())
• Timestamp (exposed through getTimestamp() and setTimestamp())
• Etag value (exposed through getEtag() and setEtag())

Other properties can be added on the fly. Their Windows Azure table storage type will be determined on-the-fly:

Dynamically adding properties ZendServiceWindowsAzureStorageDynamicTableEntity

$target = new ZendService\WindowsAzure\Storage\DynamicTableEntity(
    'partition1', '000001'
);
$target->Name = 'Name'; // Will add property "Name" of type "Edm.String"
$target->Age  = 25;     // Will add property "Age" of type "Edm.Int32"

Optionally, a property type can be enforced:

Forcing property types on ZendServiceWindowsAzureStorageDynamicTableEntity

$target = new ZendService\WindowsAzure\Storage\DynamicTableEntity(
    'partition1', '000001'
);
$target->Name = 'Name'; // Will add property "Name" of type "Edm.String"
$target->Age  = 25;     // Will add property "Age" of type "Edm.Int32"

// Change type of property "Age" to "Edm.Int32":
$target->setAzurePropertyType('Age', 'Edm.Int64');

The ZendService\WindowsAzure\Storage\Table class automatically works with ZendService\WindowsAzure\Storage\TableEntity if no specific class is passed into Table Storage methods.

Entities API examples

Inserting an entity

Using the following code, an entity can be inserted into a table named “testtable”. Note that the table has already been created before.

Inserting an entity

$entity = new SampleEntity ('partition1', 'row1');
$entity->FullName = "Maarten";
$entity->Age = 25;
$entity->Visible = true;

$storageClient = new ZendService\WindowsAzure\Storage\Table(
    'table.core.windows.net', 'myaccount', 'myauthkey'
);
$result = $storageClient->insertEntity('testtable', $entity);

// Check the timestamp and etag of the newly inserted entity
echo 'Timestamp: ' . $result->getTimestamp() . "\n";
echo 'Etag: ' . $result->getEtag() . "\n";

Retrieving an entity by partition key and row key

Using the following code, an entity can be retrieved by partition key and row key. Note that the table and entity have already been created before.

Retrieving an entity by partition key and row key

$storageClient = new ZendService\WindowsAzure\Storage\Table(
    'table.core.windows.net', 'myaccount', 'myauthkey'
);
$entity= $storageClient->retrieveEntityById(
    'testtable', 'partition1', 'row1', 'SampleEntity'
);

Updating an entity

Using the following code, an entity can be updated. Note that the table and entity have already been created before.

Updating an entity

$storageClient = new ZendService\WindowsAzure\Storage\Table(
    'table.core.windows.net', 'myaccount', 'myauthkey'
);
$entity = $storageClient->retrieveEntityById(
    'testtable', 'partition1', 'row1', 'SampleEntity'
);

$entity->Name = 'New name';
$result = $storageClient->updateEntity('testtable', $entity);

If you want to make sure the entity has not been updated before, you can make sure the Etag of the entity is checked. If the entity already has had an update, the update will fail to make sure you do not overwrite any newer data.

Updating an entity (with Etag check)

$storageClient = new ZendService\WindowsAzure\Storage\Table(
    'table.core.windows.net', 'myaccount', 'myauthkey'
);
$entity = $storageClient->retrieveEntityById(
    'testtable', 'partition1', 'row1', 'SampleEntity'
);

$entity->Name = 'New name';

// last parameter instructs the Etag check:
$result = $storageClient->updateEntity('testtable', $entity, true);

Deleting an entity

Using the following code, an entity can be deleted. Note that the table and entity have already been created before.

Deleting an entity

$storageClient = new ZendService\WindowsAzure\Storage\Table(
    'table.core.windows.net', 'myaccount', 'myauthkey'
);
$entity = $storageClient->retrieveEntityById(
    'testtable', 'partition1', 'row1', 'SampleEntity'
);
$result = $storageClient->deleteEntity('testtable', $entity);

Performing queries

Queries in ZendService\WindowsAzure\Storage\Table table storage can be performed in two ways:

• By manually creating a filter condition (involving learning a new query language)
• By using the fluent interface provided by the ZendService\WindowsAzure\Storage\Table

Using the following code, a table can be queried using a filter condition. Note that the table and entities have already been created before.

Performing queries using a filter condition

$storageClient = new ZendService\WindowsAzure\Storage\Table(
    'table.core.windows.net', 'myaccount', 'myauthkey'
);
$entities = $storageClient->storageClient->retrieveEntities(
    'testtable',
    'Name eq \'Maarten\' and PartitionKey eq \'partition1\'',
    'SampleEntity'
);

foreach ($entities as $entity) {
    echo 'Name: ' . $entity->Name . "\n";
}

Using the following code, a table can be queried using a fluent interface. Note that the table and entities have already been created before.

Performing queries using a fluent interface

$storageClient = new ZendService\WindowsAzure\Storage\Table(
    'table.core.windows.net', 'myaccount', 'myauthkey'
);
$entities = $storageClient->storageClient->retrieveEntities(
    'testtable',
    $storageClient->select()
                  ->from($tableName)
                  ->where('Name eq ?', 'Maarten')
                  ->andWhere('PartitionKey eq ?', 'partition1'),
    'SampleEntity'
);

foreach ($entities as $entity) {
    echo 'Name: ' . $entity->Name . "\n";
}

Batch operations

This topic demonstrates how to use the table entity group transaction features provided by Windows Azure table storage. Windows Azure table storage supports batch transactions on entities that are in the same table and belong to the same partition group. A transaction can include at most 100 entities.

The following example uses a batch operation (transaction) to insert a set of entities into the “testtable” table. Note that the table has already been created before.

Executing a batch operation

$storageClient = new ZendService\WindowsAzure\Storage\Table(
    'table.core.windows.net', 'myaccount', 'myauthkey'
);

// Start batch
$batch = $storageClient->startBatch();

// Insert entities in batch
$entities = generateEntities();
foreach ($entities as $entity) {
    $storageClient->insertEntity($tableName, $entity);
}

// Commit
$batch->commit();

Table storage session handler

When running a PHP application on the Windows Azure platform in a load-balanced mode (running 2 Web Role instances or more), it is important that PHP session data can be shared between multiple Web Role instances. The Windows Azure SDK for PHP provides the ZendService\WindowsAzure\SessionHandler class, which uses Windows Azure Table Storage as a session handler for PHP applications.

To use the ZendService\WindowsAzure\SessionHandler session handler, it should be registered as the default session handler for your PHP application:

Registering table storage session handler

$storageClient = new ZendService\WindowsAzure\Storage\Table(
    'table.core.windows.net', 'myaccount', 'myauthkey'
);

$sessionHandler = new ZendService\WindowsAzure\SessionHandler(
    $storageClient , 'sessionstable'
);
$sessionHandler->register();

The above classname registers the ZendService\WindowsAzure\SessionHandler session handler and will store sessions in a table called “sessionstable”.

After registration of the ZendService\WindowsAzure\SessionHandler session handler, sessions can be started and used in the same way as a normal PHP session:

Using table storage session handler

$storageClient = new ZendService\WindowsAzure\Storage\Table(
    'table.core.windows.net', 'myaccount', 'myauthkey'
);

$sessionHandler = new ZendService\WindowsAzure\SessionHandler(
    $storageClient , 'sessionstable'
);
$sessionHandler->register();

session_start();

if (!isset($_SESSION['firstVisit'])) {
    $_SESSION['firstVisit'] = time();
}

// ...

Warning

The ZendService\WindowsAzure\SessionHandler session handler should be registered before a call to session_start() is made!