Cloud Spanner Client - Class Result (1.61.0)

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

Represent a Cloud Spanner lookup result (either read or executeSql).

Example:

use Google\Cloud\Spanner\SpannerClient;

$spanner = new SpannerClient();

$database = $spanner->connect('my-instance', 'my-database');
$result = $database->execute('SELECT * FROM Posts');

Return the formatted and decoded rows. If the stream is interrupted and a resume token is available, attempts will be made on your behalf to resume.

Example:

$rows = $result->rows();

Return column names.

Will be populated once the result set is iterated upon.

Example:

$columns = $result->columns();

Return result metadata.

Will be populated once the result set is iterated upon.

Example:

$metadata = $result->metadata();

Return the session associated with the result stream.

Example:

$session = $result->session();

Get the query plan and execution statistics for the query that produced this result set.

By default, statistics are returned by default only when executing a DML statement. To receive statistics for a SELECT statement, set $options.queryMode to Result::MODE_PROFILE, as demonstrated below.

Setting $options.queryMode to Result::MODE_PLAN will return the query plan without any results or execution statistics information.

Example:

$stats = $result->stats();

// Executing a query with stats returned.
use Google\Cloud\Spanner\Result;

$res = $database->execute('SELECT * FROM Posts', [
    'queryMode' => Result::MODE_PROFILE
]);

Returns a snapshot which was begun in the read or execute, if one exists.

Will be populated once the result set is iterated upon.

Example:

$snapshot = $result->snapshot();

Returns a transaction which was begun in the read or execute, if one exists.

Will be populated once the result set is iterated upon.

Example:

$transaction = $result->transaction();