Reference documentation and code samples for the Cloud Spanner Client class Session.
Represents and manages a single Cloud Spanner session.
Namespace
Google \ Cloud \ Spanner \ SessionMethods
__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.