User defined types

PHP Driver supports Cassandra UDTs

Background

Given

a running Cassandra cluster

Using Cassandra user defined types from schema metadata

Given

the following schema:

CREATE KEYSPACE simplex WITH replication = {
  'class': 'SimpleStrategy',
  'replication_factor': 1
};
USE simplex;
CREATE TYPE address (street text, city text, zip int);
CREATE TYPE addresses (home frozen<address>, work frozen<address>);
CREATE TABLE users (
  id uuid PRIMARY KEY,
  name text,
  addresses frozen<addresses>
);

And

the following example:

<?php
$cluster   = Cassandra::cluster()->build();
$session   = $cluster->connect("simplex");
$keyspace = $session->schema()->keyspace("simplex");

$addressType = $keyspace->userType("address");
$addressesType = $keyspace->userType("addresses");

$users = array(
    array(
        new Cassandra\Uuid('56357d2b-4586-433c-ad24-afa9918bc415'),
        'Charles Wallace',
        $addressesType->create(
            'home', $addressType->create(
                'city', 'Phoenix',
                'street', '9042 Cassandra Lane',
                'zip', 85023))
    ),
    array(
        new Cassandra\Uuid('ce359590-8528-4682-a9f3-add53fc9aa09'),
        'Kevin Malone',
        $addressesType->create(
            'home', $addressType->create(
                'city', 'New York',
                'street', '1000 Database Road',
                'zip', 10025),
            'work', $addressType->create(
                'city', 'New York',
                'street', '60 SSTable Drive',
                'zip', 10024)
        )
    ),
);

foreach ($users as $user) {
    $options = array('arguments' => $user);
    $session->execute("INSERT INTO users (id, name, addresses) VALUES (?, ?, ?)", $options);
}

$result    = $session->execute("SELECT * FROM users");

foreach ($result as $row) {
    echo "ID: {$row['id']}" . PHP_EOL;
    echo "Name: {$row['name']}" . PHP_EOL;
    echo "Address:" . PHP_EOL;
    foreach ($row['addresses'] as $type => $address) {
        echo "  {$type}:" . PHP_EOL;
        if (is_null($address)) {
            echo "    NULL" . PHP_EOL;
        } else {
            foreach ($address as $key => $value) {
                echo "    {$key} => {$value}" . PHP_EOL;
            }
        }
    }
}

When

it is executed

Then

its output should contain:

ID: 56357d2b-4586-433c-ad24-afa9918bc415
Name: Charles Wallace
Address:
  home:
    street => 9042 Cassandra Lane
    city => Phoenix
    zip => 85023
  work:
    NULL
ID: ce359590-8528-4682-a9f3-add53fc9aa09
Name: Kevin Malone
Address:
  home:
    street => 1000 Database Road
    city => New York
    zip => 10025
  work:
    street => 60 SSTable Drive
    city => New York
    zip => 10024

Using Cassandra manually create user defined types

Given

the following schema:

CREATE KEYSPACE simplex WITH replication = {
  'class': 'SimpleStrategy',
  'replication_factor': 1
};
USE simplex;
CREATE TYPE address (street text, city text, zip int);
CREATE TYPE addresses (home frozen<address>, work frozen<address>);
CREATE TABLE users (
  id uuid PRIMARY KEY,
  name text,
  addresses frozen<addresses>
);

And

the following example:

<?php
$cluster   = Cassandra::cluster()->build();
$session   = $cluster->connect("simplex");

$addressType = Cassandra\Type::userType(
    'street', Cassandra\Type::text(),
    'city',   Cassandra\Type::text(),
    'zip',    Cassandra\Type::int()
);

$addressesType = Cassandra\Type::userType(
    'home', $addressType,
    'work', $addressType
 );

$users = array(
    array(
        new Cassandra\Uuid('56357d2b-4586-433c-ad24-afa9918bc415'),
        'Charles Wallace',
        $addressesType->create(
            'home', $addressType->create(
                'city', 'Phoenix',
                'street', '9042 Cassandra Lane',
                'zip', 85023))
    ),
    array(
        new Cassandra\Uuid('ce359590-8528-4682-a9f3-add53fc9aa09'),
        'Kevin Malone',
        $addressesType->create(
            'home', $addressType->create(
                'city', 'New York',
                'street', '1000 Database Road',
                'zip', 10025),
            'work', $addressType->create(
                'city', 'New York',
                'street', '60 SSTable Drive',
                'zip', 10024)
        )
    ),
);

foreach ($users as $user) {
    $options = array('arguments' => $user);
    $session->execute("INSERT INTO users (id, name, addresses) VALUES (?, ?, ?)", $options);
}

$result    = $session->execute("SELECT * FROM users");

foreach ($result as $row) {
    echo "ID: {$row['id']}" . PHP_EOL;
    echo "Name: {$row['name']}" . PHP_EOL;
    echo "Address:" . PHP_EOL;
    foreach ($row['addresses'] as $type => $address) {
        echo "  {$type}:" . PHP_EOL;
        if (is_null($address)) {
            echo "    NULL" . PHP_EOL;
        } else {
            foreach ($address as $key => $value) {
                echo "    {$key} => {$value}" . PHP_EOL;
            }
        }
    }
}

When

it is executed

Then

its output should contain:

ID: 56357d2b-4586-433c-ad24-afa9918bc415
Name: Charles Wallace
Address:
  home:
    street => 9042 Cassandra Lane
    city => Phoenix
    zip => 85023
  work:
    NULL
ID: ce359590-8528-4682-a9f3-add53fc9aa09
Name: Kevin Malone
Address:
  home:
    street => 1000 Database Road
    city => New York
    zip => 10025
  work:
    street => 60 SSTable Drive
    city => New York
    zip => 10024