REST Resource: projects.instances.databases.sessions

Resource: Session

A session in the Cloud Spanner API.

JSON representation
{
  "name": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "approximateLastUseTime": string,
  "creatorRole": string,
  "multiplexed": boolean
}
Fields
name

string

Output only. The name of the session. This is always system-assigned.

labels

map (key: string, value: string)

The labels for the session.

  • Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?.
  • Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?.
  • No more than 64 labels can be associated with a given session.

See https://goo.gl/xmQnxf for more information on and examples of labels.

createTime

string (Timestamp format)

Output only. The timestamp when the session is created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 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".

approximateLastUseTime

string (Timestamp format)

Output only. The approximate timestamp when the session is last used. It is typically earlier than the actual last use time.

Uses RFC 3339, where generated output will always be Z-normalized and uses 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".

creatorRole

string

The database role which created this session.

multiplexed

boolean

Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use sessions.adapter to create multiplexed sessions. Don't use sessions.batchCreate to create a multiplexed session. You can't delete or list multiplexed sessions.

Methods

batchCreate

Creates multiple new sessions.

batchWrite

Batches the supplied mutation groups in a collection of efficient transactions.

beginTransaction

Begins a new transaction.

commit

Commits a transaction.

create

Creates a new session.

delete

Ends a session, releasing server resources associated with it.

executeBatchDml

Executes a batch of SQL DML statements.

executeSql

Executes an SQL statement, returning all results in a single reply.

executeStreamingSql

Like ExecuteSql, except returns the result set as a stream.

get

Gets a session.

list

Lists all sessions in a given database.

partitionQuery

Creates a set of partition tokens that can be used to execute a query operation in parallel.

partitionRead

Creates a set of partition tokens that can be used to execute a read operation in parallel.

read

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql.

rollback

Rolls back a transaction, releasing any locks it holds.

streamingRead

Like Read, except returns the result set as a stream.