Cloud Spanner Client - Class Session (1.106.0)

Version latest

• 1.106.0 (latest)
• 1.105.1
• 1.104.1
• 1.103.0
• 1.102.0
• 1.101.0
• 1.100.0
• 1.98.0
• 1.97.0
• 1.96.0
• 1.95.0
• 1.94.0
• 1.93.1
• 1.92.1
• 1.91.0
• 1.90.0
• 1.89.0
• 1.88.0
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.1
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.2
• 1.62.1
• 1.61.0
• 1.60.0
• 1.59.0
• 1.58.4
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.2

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

Represents and manages a single Cloud Spanner session.

Namespace

Google \ Cloud \ Spanner \ Session

Methods

__construct

Parameters
Name	Description
connection	Google\Cloud\Spanner\Connection\ConnectionInterface A connection to Cloud Spanner. This object is created by SpannerClient, and should not be instantiated outside of this client.
projectId	string The project ID.
instance	string The instance name.
database	string The database name.
name	string The session name.

info

Return info on the session.

Returns
Type	Description
array	An array containing the `projectId`, `instance`, `database`, 'databaseName' and session `name` keys.

exists

Check if the session exists.

Parameter
Name	Description
options	array [optional] Configuration options.

Returns
Type	Description
bool

delete

Delete the session.

Parameter
Name	Description
options	array [optional] Configuration options.

Returns
Type	Description
void

name

Format the constituent parts of a session name into a fully qualified session name.

Returns
Type	Description
string

setExpiration

Sets the expiration.

Parameter
Name	Description
expiration	int [optional] The Unix timestamp in seconds upon which the session will expire. Defaults to now plus 60 minutes.

Returns
Type	Description
void

expiration

Gets the expiration.

Returns
Type	Description
int|null

__debugInfo

Represent the class in a more readable and digestable fashion.