string

Required. The session in which the SQL query is executed. Format:projects/{project}/instances/{instance}/databases/{database}/sessions/{session}

string

Required. The SQL query to execute.

string (int64 format)

Optional. Sequence number of the request within a transaction. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction can be aborted.

boolean

Use a single use transaction for query execution.

boolean

Begin a new read-only transaction.

boolean

Begin a new read-write transaction.

string (bytes format)

Use an existing transaction.

A base64-encoded string.

object (ResultSetMetadata)

Metadata about the result set, such as row type information.

array (ListValue format)

Each element inrows is a row whose format is defined by [metadata.row_type][ResultSetMetadata.row_type]. The ith element in each row matches the ith field in [metadata.row_type][ResultSetMetadata.row_type]. Elements are encoded based on type as describedhere.

object (MultiplexedSessionPrecommitToken)

Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt to theCommit request for this transaction.

object (StructType)

Indicates the field names and types for the rows in the result set. For example, a SQL query like"SELECT UserId, UserName FROM Users" could return arow_type value like:

"fields": [  { "name": "UserId", "type": { "code": "INT64" } },  { "name": "UserName", "type": { "code": "STRING" } },]

object (Transaction)

If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.

object (StructType)

A SQL query can be parameterized. In PLAN mode, these parameters can be undeclared. This indicates the field names and types for those undeclared parameters in the SQL query. For example, a SQL query like"SELECT * FROM Users where UserId = @userId and UserName = @userName " could return aundeclared_parameters value like:

"fields": [  { "name": "UserId", "type": { "code": "INT64" } },  { "name": "UserName", "type": { "code": "STRING" } },]

object (Field)

The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in theStructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in theSELECT clause of a query.

string

The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g.,"Word" in the query"SELECT 'hello' AS Word"), or the column name (e.g.,"ColName" in the query"SELECT ColName FROM Table"). Some columns might have an empty name (e.g.,"SELECT UPPER(ColName)"). Note that a query result can contain multiple fields with the same name.

object (Type)

The type of the field.

enum (TypeCode)

Required. TheTypeCode for this type.

object (Type)

Ifcode ==ARRAY, thenarray_element_type is the type of the array elements.

object (StructType)

Ifcode ==STRUCT, thenstruct_type provides type information for the struct's fields.

enum (TypeAnnotationCode)

TheTypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a singleTypeCode can be mapped to different SQL types depending on the SQL dialect.type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.

string

Ifcode ==PROTO orcode ==ENUM, thenproto_type_fqn is the fully qualified name of the proto type representing the proto/enum definition.

string (bytes format)

id may be used to identify the transaction in subsequentRead,ExecuteSql,Commit, orRollback calls.

Single-use read-only transactions do not have IDs, because single-use transactions do not support multiple requests.

A base64-encoded string.

string (Timestamp format)

For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: seeTransactionOptions.ReadOnly.return_read_timestamp.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example:"2014-10-02T15:01:23.045123456Z".

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

object (MultiplexedSessionPrecommitToken)

A precommit token is included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in theBeginTransaction. The precommit token with the highest sequence number from this transaction attempt should be passed to theCommit request for this transaction.

string (int64 format)

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be between -62135596800 and 253402300799 inclusive (which corresponds to 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z).

integer

Non-negative fractions of a second at nanosecond resolution. This field is the nanosecond portion of the duration, not an alternative to seconds. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be between 0 and 999,999,999 inclusive.

string (bytes format)

Opaque precommit token.

A base64-encoded string.

integer

An incrementing seq number is generated on every precommit token that is returned. Clients should remember the precommit token with the highest sequence number from the current transaction attempt.

value (Value format)

Repeated field of dynamically typed values.

null

Represents a null value.

number

Represents a double value.

string

Represents a string value.

boolean

Represents a boolean value.

object (Struct format)

Represents a structured value.

array (ListValue format)

Represents a repeatedValue.

map (key: string, value: value (Value format))

Unordered map of dynamically typed values.

An object containing a list of"key": value pairs. Example:{ "name": "wrench", "mass": "1.3kg", "count": "3" }.

string

value (Value format)