Documentation

Google_Service_Spanner_Resource_ProjectsInstancesDatabasesSessions extends Google_Service_Resource
in package

Application

The "sessions" collection of methods.

Typical usage is: $spannerService = new Google_Service_Spanner(...); $sessions = $spannerService->sessions;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
batchCreate() : Google_Service_Spanner_BatchCreateSessionsResponse: Creates multiple new sessions. This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management. (sessions.batchCreate)
beginTransaction() : Google_Service_Spanner_Transaction: Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
commit() : Google_Service_Spanner_CommitResponse: Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the beginning, re-using the same session. On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now.
create() : Google_Service_Spanner_Session: Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`. (sessions.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Spanner_SpannerEmpty: Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session. (sessions.delete)
executeBatchDml() : Google_Service_Spanner_ExecuteBatchDmlResponse: Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql.
executeSql() : Google_Service_Spanner_ResultSet: Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.
executeStreamingSql() : Google_Service_Spanner_PartialResultSet: Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set.
get() : Google_Service_Spanner_Session: Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for determining whether a session is still alive.
listProjectsInstancesDatabasesSessions() : Google_Service_Spanner_ListSessionsResponse: Lists all sessions in a given database.
partitionQuery() : Google_Service_Spanner_PartitionResponse: Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.
partitionRead() : Google_Service_Spanner_PartitionResponse: Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning. (sessions.partitionRead)
read() : Google_Service_Spanner_ResultSet: Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read- write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead. (sessions.read)
rollback() : Google_Service_Spanner_SpannerEmpty: Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`.
streamingRead() : Google_Service_Spanner_PartialResultSet: Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

batchCreate()

Creates multiple new sessions. This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management. (sessions.batchCreate)


    public
                batchCreate(string $database, Google_Service_Spanner_BatchCreateSessionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spanner_BatchCreateSessionsResponse

Parameters

$database : string: Required. The database in which the new sessions are created.
$postBody : Google_Service_Spanner_BatchCreateSessionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spanner_BatchCreateSessionsResponse —

beginTransaction()

Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.


    public
                beginTransaction(string $session, Google_Service_Spanner_BeginTransactionRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spanner_Transaction

(sessions.beginTransaction)

Parameters

$session : string: Required. The session in which the transaction runs.
$postBody : Google_Service_Spanner_BeginTransactionRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spanner_Transaction —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

commit()

Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the beginning, re-using the same session. On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now.


    public
                commit(string $session, Google_Service_Spanner_CommitRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spanner_CommitResponse

(sessions.commit)

Parameters

$session : string: Required. The session in which the transaction to be committed is running.
$postBody : Google_Service_Spanner_CommitRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spanner_CommitResponse —

create()

Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`. (sessions.create)


    public
                create(string $database, Google_Service_Spanner_CreateSessionRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spanner_Session

Parameters

$database : string: Required. The database in which the new session is created.
$postBody : Google_Service_Spanner_CreateSessionRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spanner_Session —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session. (sessions.delete)


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spanner_SpannerEmpty

Parameters

$name : string: Required. The name of the session to delete.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spanner_SpannerEmpty —

executeBatchDml()

Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql.


    public
                executeBatchDml(string $session, Google_Service_Spanner_ExecuteBatchDmlRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spanner_ExecuteBatchDmlResponse

Statements are executed in sequential order. A request can succeed even if a statement fails. The ExecuteBatchDmlResponse.status field in the response provides information about the statement that failed. Clients must inspect this field to determine whether an error occurred. Execution stops after the first failed statement; the remaining statements are not executed. (sessions.executeBatchDml)

Parameters

$session : string: Required. The session in which the DML statements should be performed.
$postBody : Google_Service_Spanner_ExecuteBatchDmlRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spanner_ExecuteBatchDmlResponse —

executeSql()

Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.


    public
                executeSql(string $session, Google_Service_Spanner_ExecuteSqlRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spanner_ResultSet

(sessions.executeSql)

Parameters

$session : string: Required. The session in which the SQL query should be performed.
$postBody : Google_Service_Spanner_ExecuteSqlRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spanner_ResultSet —

executeStreamingSql()

Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set.


    public
                executeStreamingSql(string $session, Google_Service_Spanner_ExecuteSqlRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spanner_PartialResultSet

However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB. (sessions.executeStreamingSql)

Parameters

$session : string: Required. The session in which the SQL query should be performed.
$postBody : Google_Service_Spanner_ExecuteSqlRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spanner_PartialResultSet —

get()

Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for determining whether a session is still alive.


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spanner_Session

(sessions.get)

Parameters

$name : string: Required. The name of the session to retrieve.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spanner_Session —

listProjectsInstancesDatabasesSessions()

Lists all sessions in a given database.


    public
                listProjectsInstancesDatabasesSessions(string $database[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spanner_ListSessionsResponse

(sessions.listProjectsInstancesDatabasesSessions)

Parameters

$database : string: Required. The database in which to list sessions.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spanner_ListSessionsResponse —

partitionQuery()

Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.


    public
                partitionQuery(string $session, Google_Service_Spanner_PartitionQueryRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spanner_PartitionResponse

(sessions.partitionQuery)

Parameters

$session : string: Required. The session used to create the partitions.
$postBody : Google_Service_Spanner_PartitionQueryRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spanner_PartitionResponse —

partitionRead()

Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning. (sessions.partitionRead)


    public
                partitionRead(string $session, Google_Service_Spanner_PartitionReadRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spanner_PartitionResponse

Parameters

$session : string: Required. The session used to create the partitions.
$postBody : Google_Service_Spanner_PartitionReadRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spanner_PartitionResponse —

read()

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read- write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead. (sessions.read)


    public
                read(string $session, Google_Service_Spanner_ReadRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spanner_ResultSet

Parameters

$session : string: Required. The session in which the read should be performed.
$postBody : Google_Service_Spanner_ReadRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spanner_ResultSet —

rollback()

Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`.


    public
                rollback(string $session, Google_Service_Spanner_RollbackRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spanner_SpannerEmpty

(sessions.rollback)

Parameters

$session : string: Required. The session in which the transaction to roll back is running.
$postBody : Google_Service_Spanner_RollbackRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spanner_SpannerEmpty —

streamingRead()

Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.


    public
                streamingRead(string $session, Google_Service_Spanner_ReadRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Spanner_PartialResultSet

(sessions.streamingRead)

Parameters

$session : string: Required. The session in which the read should be performed.
$postBody : Google_Service_Spanner_ReadRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Spanner_PartialResultSet —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —