Cloud Bigtable Client - Class Table (2.6.0)

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

A table instance can be used to read rows and to perform insert, update, and delete operations.

Example:

use Google\Cloud\Bigtable\BigtableClient;

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

Create a table instance.

Mutates rows in a table.

Example:

use Google\Cloud\Bigtable\Mutations;

$mutations = (new Mutations)
    ->upsert('cf1', 'cq1', 'value1', 1534183334215000);

$table->mutateRows(['r1' => $mutations]);

Mutates a row atomically. Cells already present in the row are left unchanged unless explicitly changed by mutations.

Example:

use Google\Cloud\Bigtable\Mutations;

$mutations = (new Mutations)
    ->upsert('cf1', 'cq1', 'value1', 1534183334215000);

$table->mutateRow('r1', $mutations);

Insert/update rows in a table.

Example:

$table->upsert([
    'r1' => [
        'cf1' => [
            'cq1' => [
                'value'=>'value1',
                'timeStamp' => 1534183334215000
             ]
        ]
    ]
]);

Read rows from the table.

Example:

$rows = $table->readRows();

foreach ($rows as $key => $row) {
    echo $key . ': ' . print_r($row, true) . PHP_EOL;
}

// Specify a set of row ranges.
$rows = $table->readRows([
    'rowRanges' => [
        [
            'startKeyOpen' => 'jefferson',
            'endKeyOpen' => 'lincoln'
        ]
    ]
]);

foreach ($rows as $key => $row) {
    echo $key . ': ' . print_r($row, true) . PHP_EOL;
}

Read a single row from the table.

Example:

$row = $table->readRow('jefferson');

print_r($row);

Modifies a row atomically on the server. The method reads the latest existing timestamp and value from the specified columns and writes a new entry based on pre-defined read/modify/write rules. The new value for the timestamp is the greater of the existing timestamp or the current server time. The method returns the new contents of all modified cells.

Example:

use Google\Cloud\Bigtable\ReadModifyWriteRowRules;

$rules = (new ReadModifyWriteRowRules)
    ->append('cf1', 'cq1', 'value12');
$row = $table->readModifyWriteRow('rk1', $rules);

print_r($row);

// Increments value
use Google\Cloud\Bigtable\DataUtil;
use Google\Cloud\Bigtable\ReadModifyWriteRowRules;
use Google\Cloud\Bigtable\Mutations;

$mutations = (new Mutations)
    ->upsert('cf1', 'cq1', DataUtil::intToByteString(2));

$table->mutateRows(['rk1' => $mutations]);

$rules = (new ReadModifyWriteRowRules)
    ->increment('cf1', 'cq1', 3);
$row = $table->readModifyWriteRow('rk1', $rules);

print_r($row);

Returns a sample of row keys in the table. The returned row keys will delimit contiguous sections of the table of approximately equal size, which can be used to break up the data for distributed tasks like mapreduces.

Example:

$rowKeyStream = $table->sampleRowKeys();
foreach ($rowKeyStream as $rowKey) {
    print_r($rowKey) . PHP_EOL;
}

Mutates the specified row atomically based on output of the filter.

Example:

use Google\Cloud\Bigtable\Mutations;

$mutations = (new Mutations)->upsert('family', 'qualifier', 'value');
$result = $table->checkAndMutateRow('rk1', ['trueMutations' => $mutations]);

// With predicate filter
use Google\Cloud\Bigtable\Filter;
use Google\Cloud\Bigtable\Mutations;

$mutations = (new Mutations)->upsert('family', 'qualifier', 'value');
$predicateFilter = Filter::qualifier()->exactMatch('cq');
$options = ['predicateFilter' => $predicateFilter, 'trueMutations' => $mutations];
$result = $table->checkAndMutateRow('rk1', $options);