The "sessions" collection of methods. More...

Classes
class	BatchCreateRequest
	Creates multiple new sessions. More...

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

class	CommitRequest
	Commits a transaction. The request includes the mutations to be applied to rows in the database. More...

class	CreateRequest
	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. More...

class	DeleteRequest
	Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session. More...

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

class	ExecuteSqlRequest
	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. More...

class	ExecuteStreamingSqlRequest
	Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, 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. More...

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

class	ListRequest
	Lists all sessions in a given database. More...

class	PartitionQueryRequest
	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. More...

class	PartitionReadRequest
	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. More...

class	ReadRequest
	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. More...

class	RollbackRequest
	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. More...

class	StreamingReadRequest
	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. More...

Public Member Functions
	SessionsResource (Google.Apis.Services.IClientService service)
	Constructs a new resource. More...

virtual BatchCreateRequest	BatchCreate (Google.Apis.Spanner.v1.Data.BatchCreateSessionsRequest body, string database)
	Creates multiple new sessions. More...

virtual BeginTransactionRequest	BeginTransaction (Google.Apis.Spanner.v1.Data.BeginTransactionRequest body, string session)
	Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect. More...

virtual CommitRequest	Commit (Google.Apis.Spanner.v1.Data.CommitRequest body, string session)
	Commits a transaction. The request includes the mutations to be applied to rows in the database. More...

virtual CreateRequest	Create (Google.Apis.Spanner.v1.Data.CreateSessionRequest body, string database)
	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. More...

virtual DeleteRequest	Delete (string name)
	Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session. More...

virtual ExecuteBatchDmlRequest	ExecuteBatchDml (Google.Apis.Spanner.v1.Data.ExecuteBatchDmlRequest body, string session)
	Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql. More...

virtual ExecuteSqlRequest	ExecuteSql (Google.Apis.Spanner.v1.Data.ExecuteSqlRequest body, string session)
	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. More...

virtual ExecuteStreamingSqlRequest	ExecuteStreamingSql (Google.Apis.Spanner.v1.Data.ExecuteSqlRequest body, string session)
	Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, 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. More...

virtual GetRequest	Get (string name)
	Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for determining whether a session is still alive. More...

virtual ListRequest	List (string database)
	Lists all sessions in a given database. More...

virtual PartitionQueryRequest	PartitionQuery (Google.Apis.Spanner.v1.Data.PartitionQueryRequest body, string session)
	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. More...

virtual PartitionReadRequest	PartitionRead (Google.Apis.Spanner.v1.Data.PartitionReadRequest body, string session)
	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. More...

virtual ReadRequest	Read (Google.Apis.Spanner.v1.Data.ReadRequest body, string session)
	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. More...

virtual RollbackRequest	Rollback (Google.Apis.Spanner.v1.Data.RollbackRequest body, string session)
	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. More...

virtual StreamingReadRequest	StreamingRead (Google.Apis.Spanner.v1.Data.ReadRequest body, string session)
	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. More...

Detailed Description

The "sessions" collection of methods.

Constructor & Destructor Documentation

◆ SessionsResource()

Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.SessionsResource ( Google.Apis.Services.IClientService service )

inline

Constructs a new resource.

Member Function Documentation

◆ BatchCreate()

virtual BatchCreateRequest Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.BatchCreate	(	Google.Apis.Spanner.v1.Data.BatchCreateSessionsRequest	body,
		string	database
	)

inlinevirtual

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.

Parameters

body	The body of the request.
database	Required. The database in which the new sessions are created.

◆ BeginTransaction()

virtual BeginTransactionRequest Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.BeginTransaction	(	Google.Apis.Spanner.v1.Data.BeginTransactionRequest	body,
		string	session
	)

inlinevirtual

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

Parameters

body	The body of the request.
session	Required. The session in which the transaction runs.

◆ Commit()

virtual CommitRequest Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.Commit	(	Google.Apis.Spanner.v1.Data.CommitRequest	body,
		string	session
	)

inlinevirtual

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.

Parameters

body	The body of the request.
session	Required. The session in which the transaction to be committed is running.

◆ Create()

virtual CreateRequest Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.Create	(	Google.Apis.Spanner.v1.Data.CreateSessionRequest	body,
		string	database
	)

inlinevirtual

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".

Parameters

body	The body of the request.
database	Required. The database in which the new session is created.

◆ Delete()

virtual DeleteRequest Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.Delete ( string name )

inlinevirtual

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

Parameters

name	Required. The name of the session to delete.

◆ ExecuteBatchDml()

virtual ExecuteBatchDmlRequest Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.ExecuteBatchDml	(	Google.Apis.Spanner.v1.Data.ExecuteBatchDmlRequest	body,
		string	session
	)

inlinevirtual

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

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.

Parameters

body	The body of the request.
session	Required. The session in which the DML statements should be performed.

◆ ExecuteSql()

virtual ExecuteSqlRequest Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.ExecuteSql	(	Google.Apis.Spanner.v1.Data.ExecuteSqlRequest	body,
		string	session
	)

inlinevirtual

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.

Parameters

body	The body of the request.
session	Required. The session in which the SQL query should be performed.

◆ ExecuteStreamingSql()

virtual ExecuteStreamingSqlRequest Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.ExecuteStreamingSql	(	Google.Apis.Spanner.v1.Data.ExecuteSqlRequest	body,
		string	session
	)

inlinevirtual

Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, 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.

Parameters

body	The body of the request.
session	Required. The session in which the SQL query should be performed.

◆ Get()

virtual GetRequest Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.Get ( string name )

inlinevirtual

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

Parameters

name	Required. The name of the session to retrieve.

◆ List()

virtual ListRequest Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.List ( string database )

inlinevirtual

Lists all sessions in a given database.

Parameters

database Required. The database in which to list sessions.

◆ PartitionQuery()

virtual PartitionQueryRequest Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.PartitionQuery	(	Google.Apis.Spanner.v1.Data.PartitionQueryRequest	body,
		string	session
	)

inlinevirtual

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.

Parameters

body	The body of the request.
session	Required. The session used to create the partitions.

◆ PartitionRead()

virtual PartitionReadRequest Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.PartitionRead	(	Google.Apis.Spanner.v1.Data.PartitionReadRequest	body,
		string	session
	)

inlinevirtual

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.

Parameters

body	The body of the request.
session	Required. The session used to create the partitions.

◆ Read()

virtual ReadRequest Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.Read	(	Google.Apis.Spanner.v1.Data.ReadRequest	body,
		string	session
	)

inlinevirtual

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.

Parameters

body	The body of the request.
session	Required. The session in which the read should be performed.

◆ Rollback()

virtual RollbackRequest Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.Rollback	(	Google.Apis.Spanner.v1.Data.RollbackRequest	body,
		string	session
	)

inlinevirtual

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.

Parameters

body	The body of the request.
session	Required. The session in which the transaction to roll back is running.

◆ StreamingRead()

virtual StreamingReadRequest Google.Apis.Spanner.v1.ProjectsResource.InstancesResource.DatabasesResource.SessionsResource.StreamingRead	(	Google.Apis.Spanner.v1.Data.ReadRequest	body,
		string	session
	)

inlinevirtual

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.

Parameters

body	The body of the request.
session	Required. The session in which the read should be performed.

The documentation for this class was generated from the following file:

Google.Apis.Spanner.v1.cs

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SessionsResource()

Member Function Documentation

◆ BatchCreate()

◆ BeginTransaction()

◆ Commit()

◆ Create()

◆ Delete()

◆ ExecuteBatchDml()

◆ ExecuteSql()

◆ ExecuteStreamingSql()

◆ Get()

◆ List()

◆ PartitionQuery()

◆ PartitionRead()

◆ Read()

◆ Rollback()

◆ StreamingRead()