Cloud Spanner V1 Client - Class QueryMode (1.91.0)

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

Mode in which the statement must be processed.

Protobuf type google.spanner.v1.ExecuteSqlRequest.QueryMode

Namespace

Google \ Cloud \ Spanner \ V1 \ ExecuteSqlRequest

Methods

static::name

Parameter
Name	Description
`value`	`mixed`

static::value

Parameter
Name	Description
`name`	`mixed`

Constants

NORMAL

Value: 0

The default mode. Only the statement results are returned.

Generated from protobuf enum NORMAL = 0;

PLAN

Value: 1

This mode returns only the query plan, without any results or execution statistics information.

Generated from protobuf enum PLAN = 1;

PROFILE

Value: 2

This mode returns the query plan, overall execution statistics, operator level execution statistics along with the results. This has a performance overhead compared to the other modes. It is not recommended to use this mode for production traffic.

Generated from protobuf enum PROFILE = 2;

WITH_STATS

Value: 3

This mode returns the overall (but not operator-level) execution statistics along with the results.

Generated from protobuf enum WITH_STATS = 3;

WITH_PLAN_AND_STATS

Value: 4

This mode returns the query plan, overall (but not operator-level) execution statistics along with the results.

Generated from protobuf enum WITH_PLAN_AND_STATS = 4;