Cloud Spanner V1 Client - Class Session (1.80.0)

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

A session in the Cloud Spanner API.

Generated from protobuf message google.spanner.v1.Session

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ labels array|Google\Protobuf\Internal\MapField

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.

↳ create_time Google\Protobuf\Timestamp

Output only. The timestamp when the session is created.

↳ approximate_last_use_time Google\Protobuf\Timestamp

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

↳ creator_role string

The database role which created this session.

↳ multiplexed bool

Optional. If true, specifies a multiplexed session. A multiplexed session may be used for multiple, concurrent read-only operations but can not be used for read-write transactions, partitioned reads, or partitioned queries. Multiplexed sessions can be created via CreateSession but not via BatchCreateSessions. Multiplexed sessions may not be deleted nor listed.

getName

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

Returns
Type Description
string

setName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

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.
Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

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.
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getCreateTime

Output only. The timestamp when the session is created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when the session is created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getApproximateLastUseTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasApproximateLastUseTime

clearApproximateLastUseTime

setApproximateLastUseTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCreatorRole

The database role which created this session.

Returns
Type Description
string

setCreatorRole

The database role which created this session.

Parameter
Name Description
var string
Returns
Type Description
$this

getMultiplexed

Optional. If true, specifies a multiplexed session. A multiplexed session may be used for multiple, concurrent read-only operations but can not be used for read-write transactions, partitioned reads, or partitioned queries. Multiplexed sessions can be created via CreateSession but not via BatchCreateSessions.

Multiplexed sessions may not be deleted nor listed.

Returns
Type Description
bool

setMultiplexed

Optional. If true, specifies a multiplexed session. A multiplexed session may be used for multiple, concurrent read-only operations but can not be used for read-write transactions, partitioned reads, or partitioned queries. Multiplexed sessions can be created via CreateSession but not via BatchCreateSessions.

Multiplexed sessions may not be deleted nor listed.

Parameter
Name Description
var bool
Returns
Type Description
$this