Class protos.google.spanner.v1.Spanner

Represents a Spanner

Inheritance

$protobuf.rpc.Service > protos.google.spanner.v1.Spanner

Package

@google-cloud/spanner!

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Spanner service.

Parameters

Type	Name	Description
$protobuf.RPCImpl	rpcImpl	RPC implementation
boolean	requestDelimited	Whether requests are length-delimited
boolean	responseDelimited	Whether responses are length-delimited

Methods

batchCreateSessions(request, callback)

public batchCreateSessions(request: google.spanner.v1.IBatchCreateSessionsRequest, callback: google.spanner.v1.Spanner.BatchCreateSessionsCallback): void;

Calls BatchCreateSessions.

Parameters

Type	Name	Description
IBatchCreateSessionsRequest	request	BatchCreateSessionsRequest message or plain object
google.spanner.v1.Spanner.BatchCreateSessionsCallback	callback	Node-style callback called with the error, if any, and BatchCreateSessionsResponse

Returns

Type	Description
void

batchCreateSessions(request)

public batchCreateSessions(request: google.spanner.v1.IBatchCreateSessionsRequest): Promise<google.spanner.v1.BatchCreateSessionsResponse>;

Calls BatchCreateSessions.

Parameter

Type	Name	Description
IBatchCreateSessionsRequest	request	BatchCreateSessionsRequest message or plain object

Returns

Type	Description
Promise<google.spanner.v1.BatchCreateSessionsResponse>	Promise

beginTransaction(request, callback)

public beginTransaction(request: google.spanner.v1.IBeginTransactionRequest, callback: google.spanner.v1.Spanner.BeginTransactionCallback): void;

Calls BeginTransaction.

Parameters

Type	Name	Description
IBeginTransactionRequest	request	BeginTransactionRequest message or plain object
google.spanner.v1.Spanner.BeginTransactionCallback	callback	Node-style callback called with the error, if any, and Transaction

Returns

Type	Description
void

beginTransaction(request)

public beginTransaction(request: google.spanner.v1.IBeginTransactionRequest): Promise<google.spanner.v1.Transaction>;

Calls BeginTransaction.

Parameter

Type	Name	Description
IBeginTransactionRequest	request	BeginTransactionRequest message or plain object

Returns

Type	Description
Promise<google.spanner.v1.Transaction>	Promise

commit(request, callback)

public commit(request: google.spanner.v1.ICommitRequest, callback: google.spanner.v1.Spanner.CommitCallback): void;

Calls Commit.

Parameters

Type	Name	Description
ICommitRequest	request	CommitRequest message or plain object
google.spanner.v1.Spanner.CommitCallback	callback	Node-style callback called with the error, if any, and CommitResponse

Returns

Type	Description
void

commit(request)

public commit(request: google.spanner.v1.ICommitRequest): Promise<google.spanner.v1.CommitResponse>;

Calls Commit.

Parameter

Type	Name	Description
ICommitRequest	request	CommitRequest message or plain object

Returns

Type	Description
Promise<google.spanner.v1.CommitResponse>	Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Spanner;

Creates new Spanner service using the specified rpc implementation.

Parameters

Type	Name	Description
$protobuf.RPCImpl	rpcImpl	RPC implementation
boolean	requestDelimited	Whether requests are length-delimited
boolean	responseDelimited	Whether responses are length-delimited

Returns

Type	Description
Spanner	RPC service. Useful where requests and/or responses are streamed.

createSession(request, callback)

public createSession(request: google.spanner.v1.ICreateSessionRequest, callback: google.spanner.v1.Spanner.CreateSessionCallback): void;

Calls CreateSession.

Parameters

Type	Name	Description
ICreateSessionRequest	request	CreateSessionRequest message or plain object
google.spanner.v1.Spanner.CreateSessionCallback	callback	Node-style callback called with the error, if any, and Session

Returns

Type	Description
void

createSession(request)

public createSession(request: google.spanner.v1.ICreateSessionRequest): Promise<google.spanner.v1.Session>;

Calls CreateSession.

Parameter

Type	Name	Description
ICreateSessionRequest	request	CreateSessionRequest message or plain object

Returns

Type	Description
Promise<google.spanner.v1.Session>	Promise

deleteSession(request, callback)

public deleteSession(request: google.spanner.v1.IDeleteSessionRequest, callback: google.spanner.v1.Spanner.DeleteSessionCallback): void;

Calls DeleteSession.

Parameters

Type	Name	Description
IDeleteSessionRequest	request	DeleteSessionRequest message or plain object
google.spanner.v1.Spanner.DeleteSessionCallback	callback	Node-style callback called with the error, if any, and Empty

Returns

Type	Description
void

deleteSession(request)

public deleteSession(request: google.spanner.v1.IDeleteSessionRequest): Promise<google.protobuf.Empty>;

Calls DeleteSession.

Parameter

Type	Name	Description
IDeleteSessionRequest	request	DeleteSessionRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

executeBatchDml(request, callback)

public executeBatchDml(request: google.spanner.v1.IExecuteBatchDmlRequest, callback: google.spanner.v1.Spanner.ExecuteBatchDmlCallback): void;

Calls ExecuteBatchDml.

Parameters

Type	Name	Description
IExecuteBatchDmlRequest	request	ExecuteBatchDmlRequest message or plain object
google.spanner.v1.Spanner.ExecuteBatchDmlCallback	callback	Node-style callback called with the error, if any, and ExecuteBatchDmlResponse

Returns

Type	Description
void

executeBatchDml(request)

public executeBatchDml(request: google.spanner.v1.IExecuteBatchDmlRequest): Promise<google.spanner.v1.ExecuteBatchDmlResponse>;

Calls ExecuteBatchDml.

Parameter

Type	Name	Description
IExecuteBatchDmlRequest	request	ExecuteBatchDmlRequest message or plain object

Returns

Type	Description
Promise<google.spanner.v1.ExecuteBatchDmlResponse>	Promise

executeSql(request, callback)

public executeSql(request: google.spanner.v1.IExecuteSqlRequest, callback: google.spanner.v1.Spanner.ExecuteSqlCallback): void;

Calls ExecuteSql.

Parameters

Type	Name	Description
IExecuteSqlRequest	request	ExecuteSqlRequest message or plain object
google.spanner.v1.Spanner.ExecuteSqlCallback	callback	Node-style callback called with the error, if any, and ResultSet

Returns

Type	Description
void

executeSql(request)

public executeSql(request: google.spanner.v1.IExecuteSqlRequest): Promise<google.spanner.v1.ResultSet>;

Calls ExecuteSql.

Parameter

Type	Name	Description
IExecuteSqlRequest	request	ExecuteSqlRequest message or plain object

Returns

Type	Description
Promise<google.spanner.v1.ResultSet>	Promise

executeStreamingSql(request, callback)

public executeStreamingSql(request: google.spanner.v1.IExecuteSqlRequest, callback: google.spanner.v1.Spanner.ExecuteStreamingSqlCallback): void;

Calls ExecuteStreamingSql.

Parameters

Type	Name	Description
IExecuteSqlRequest	request	ExecuteSqlRequest message or plain object
google.spanner.v1.Spanner.ExecuteStreamingSqlCallback	callback	Node-style callback called with the error, if any, and PartialResultSet

Returns

Type	Description
void

executeStreamingSql(request)

public executeStreamingSql(request: google.spanner.v1.IExecuteSqlRequest): Promise<google.spanner.v1.PartialResultSet>;

Calls ExecuteStreamingSql.

Parameter

Type	Name	Description
IExecuteSqlRequest	request	ExecuteSqlRequest message or plain object

Returns

Type	Description
Promise<google.spanner.v1.PartialResultSet>	Promise

getSession(request, callback)

public getSession(request: google.spanner.v1.IGetSessionRequest, callback: google.spanner.v1.Spanner.GetSessionCallback): void;

Calls GetSession.

Parameters

Type	Name	Description
IGetSessionRequest	request	GetSessionRequest message or plain object
google.spanner.v1.Spanner.GetSessionCallback	callback	Node-style callback called with the error, if any, and Session

Returns

Type	Description
void

getSession(request)

public getSession(request: google.spanner.v1.IGetSessionRequest): Promise<google.spanner.v1.Session>;

Calls GetSession.

Parameter

Type	Name	Description
IGetSessionRequest	request	GetSessionRequest message or plain object

Returns

Type	Description
Promise<google.spanner.v1.Session>	Promise

listSessions(request, callback)

public listSessions(request: google.spanner.v1.IListSessionsRequest, callback: google.spanner.v1.Spanner.ListSessionsCallback): void;

Calls ListSessions.

Parameters

Type	Name	Description
IListSessionsRequest	request	ListSessionsRequest message or plain object
google.spanner.v1.Spanner.ListSessionsCallback	callback	Node-style callback called with the error, if any, and ListSessionsResponse

Returns

Type	Description
void

listSessions(request)

public listSessions(request: google.spanner.v1.IListSessionsRequest): Promise<google.spanner.v1.ListSessionsResponse>;

Calls ListSessions.

Parameter

Type	Name	Description
IListSessionsRequest	request	ListSessionsRequest message or plain object

Returns

Type	Description
Promise<google.spanner.v1.ListSessionsResponse>	Promise

partitionQuery(request, callback)

public partitionQuery(request: google.spanner.v1.IPartitionQueryRequest, callback: google.spanner.v1.Spanner.PartitionQueryCallback): void;

Calls PartitionQuery.

Parameters

Type	Name	Description
IPartitionQueryRequest	request	PartitionQueryRequest message or plain object
google.spanner.v1.Spanner.PartitionQueryCallback	callback	Node-style callback called with the error, if any, and PartitionResponse

Returns

Type	Description
void

partitionQuery(request)

public partitionQuery(request: google.spanner.v1.IPartitionQueryRequest): Promise<google.spanner.v1.PartitionResponse>;

Calls PartitionQuery.

Parameter

Type	Name	Description
IPartitionQueryRequest	request	PartitionQueryRequest message or plain object

Returns

Type	Description
Promise<google.spanner.v1.PartitionResponse>	Promise

partitionRead(request, callback)

public partitionRead(request: google.spanner.v1.IPartitionReadRequest, callback: google.spanner.v1.Spanner.PartitionReadCallback): void;

Calls PartitionRead.

Parameters

Type	Name	Description
IPartitionReadRequest	request	PartitionReadRequest message or plain object
google.spanner.v1.Spanner.PartitionReadCallback	callback	Node-style callback called with the error, if any, and PartitionResponse

Returns

Type	Description
void

partitionRead(request)

public partitionRead(request: google.spanner.v1.IPartitionReadRequest): Promise<google.spanner.v1.PartitionResponse>;

Calls PartitionRead.

Parameter

Type	Name	Description
IPartitionReadRequest	request	PartitionReadRequest message or plain object

Returns

Type	Description
Promise<google.spanner.v1.PartitionResponse>	Promise

read(request, callback)

public read(request: google.spanner.v1.IReadRequest, callback: google.spanner.v1.Spanner.ReadCallback): void;

Calls Read.

Parameters

Type	Name	Description
IReadRequest	request	ReadRequest message or plain object
google.spanner.v1.Spanner.ReadCallback	callback	Node-style callback called with the error, if any, and ResultSet

Returns

Type	Description
void

read(request)

public read(request: google.spanner.v1.IReadRequest): Promise<google.spanner.v1.ResultSet>;

Calls Read.

Parameter

Type	Name	Description
IReadRequest	request	ReadRequest message or plain object

Returns

Type	Description
Promise<google.spanner.v1.ResultSet>	Promise

rollback(request, callback)

public rollback(request: google.spanner.v1.IRollbackRequest, callback: google.spanner.v1.Spanner.RollbackCallback): void;

Calls Rollback.

Parameters

Type	Name	Description
IRollbackRequest	request	RollbackRequest message or plain object
spannerClient.spanner.v1.Spanner.RollbackCallback	callback	Node-style callback called with the error, if any, and Empty

Returns

Type	Description
void

rollback(request)

public rollback(request: google.spanner.v1.IRollbackRequest): Promise<google.protobuf.Empty>;

Calls Rollback.

Parameter

Type	Name	Description
IRollbackRequest	request	RollbackRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

streamingRead(request, callback)

public streamingRead(request: google.spanner.v1.IReadRequest, callback: google.spanner.v1.Spanner.StreamingReadCallback): void;

Calls StreamingRead.

Parameters

Type	Name	Description
IReadRequest	request	ReadRequest message or plain object
google.spanner.v1.Spanner.StreamingReadCallback	callback	Node-style callback called with the error, if any, and PartialResultSet

Returns

Type	Description
void

streamingRead(request)

public streamingRead(request: google.spanner.v1.IReadRequest): Promise<google.spanner.v1.PartialResultSet>;

Calls StreamingRead.

Parameter

Type	Name	Description
IReadRequest	request	ReadRequest message or plain object

Returns

Type	Description
Promise<google.spanner.v1.PartialResultSet>	Promise