Cloud Spanner Client - Class ReadPartition (1.61.0)

Reference documentation and code samples for the Cloud Spanner Client class ReadPartition.

Represents a Read Partition.

Partitions can be shared with other servers or processes by casting the object to a string, or by calling Google\Cloud\Spanner\Batch\Google\Cloud\Spanner\Batch\ReadPartition::serialize().

Note that when reading or querying against a partition, the request MUST be made using the same Batch Snapshot with which the partition was initialized. In practice, this means that a shared partition must be accompanied by its corresponding snapshot. For more information, refer to usage notes on Google\Cloud\Spanner\Batch\Google\Cloud\Spanner\Batch\BatchClient.

Example:

use Google\Cloud\Spanner\KeySet;
use Google\Cloud\Spanner\SpannerClient;

$spanner = new SpannerClient();
$batch = $spanner->batch('instance-id', 'database-id');
$snapshot = $batch->snapshot();

$keySet = new KeySet(['all' => true]);
$columns = ['id', 'firstName', 'lastName'];
$partitions = $snapshot->partitionRead('Users', $keySet, $columns);

// Serialize a partition to share it with another worker.
$partitionString = (string) $partition;

// Calling ReadPartition::serialize() has the same effect.
$partitionString = $partition->serialize();

Return the table name.

Example:

$table = $partition->table();

Return the KeySet.

Example:

$keySet = $partition->keySet();

Return the list of columns.

Example:

$columns = $partition->columns();

Return a stringified representation of the ReadPartition object.

Example:

$partitionString = $partition->serialize();

Create a ReadPartition object from a deserialized array of partition data.