Cloud Bigtable Client - Class ChunkFormatter (1.22.2)

Reference documentation and code samples for the Cloud Bigtable Client class ChunkFormatter.

Converts cell chunks into an easily digestable format. Please note this class implements the IteratorAggregate interface, and as such can be iterated over directly in order to access the formatted rows.

Example:

use Google\Cloud\Bigtable\BigtableClient;

$bigtable = new BigtableClient();
$table = $bigtable->table('my-instance', 'my-table');
$formatter = $table->readRows();

Methods

__construct

Constructs the ChunkFormatter.

Parameters
NameDescription
readRowsCall callable

A callable which executes a read rows call and returns a stream.

tableName string

The table name used for the read rows call.

options array

[optional] Configuration options for read rows call.

readAll

Formats the row's chunks into a friendly format.

Example:

$rows = $formatter->readAll();
Returns
TypeDescription
Generator

getIterator

Returns
TypeDescription
Generator

__debugInfo

Represent the class in a more readable and digestable fashion.