Represents a Spanner
Inheritance
$protobuf.rpc.Service > protos.google.spanner.v1.SpannerPackage
@google-cloud/spanner!Constructors
(constructor)(rpcImpl, requestDelimited, responseDelimited)
constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
Constructs a new Spanner service.
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.
Type | Name | Description |
---|---|---|
google.spanner.v1.IBatchCreateSessionsRequest | request |
BatchCreateSessionsRequest message or plain object |
google.spanner.v1.Spanner.BatchCreateSessionsCallback | callback |
Node-style callback called with the error, if any, and BatchCreateSessionsResponse |
Type | Description |
---|---|
void |
batchCreateSessions(request)
public batchCreateSessions(request: google.spanner.v1.IBatchCreateSessionsRequest): Promise<google.spanner.v1.BatchCreateSessionsResponse>;
Calls BatchCreateSessions.
Type | Name | Description |
---|---|---|
google.spanner.v1.IBatchCreateSessionsRequest | request |
BatchCreateSessionsRequest message or plain object |
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.
Type | Name | Description |
---|---|---|
google.spanner.v1.IBeginTransactionRequest | request |
BeginTransactionRequest message or plain object |
google.spanner.v1.Spanner.BeginTransactionCallback | callback |
Node-style callback called with the error, if any, and Transaction |
Type | Description |
---|---|
void |
beginTransaction(request)
public beginTransaction(request: google.spanner.v1.IBeginTransactionRequest): Promise<google.spanner.v1.Transaction>;
Calls BeginTransaction.
Type | Name | Description |
---|---|---|
google.spanner.v1.IBeginTransactionRequest | request |
BeginTransactionRequest message or plain object |
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.
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 |
Type | Description |
---|---|
void |
commit(request)
public commit(request: google.spanner.v1.ICommitRequest): Promise<google.spanner.v1.CommitResponse>;
Calls Commit.
Type | Name | Description |
---|---|---|
ICommitRequest | request |
CommitRequest message or plain object |
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.
Type | Name | Description |
---|---|---|
$protobuf.RPCImpl | rpcImpl |
RPC implementation |
boolean | requestDelimited |
Whether requests are length-delimited |
boolean | responseDelimited |
Whether responses are length-delimited |
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.
Type | Name | Description |
---|---|---|
google.spanner.v1.ICreateSessionRequest | request |
CreateSessionRequest message or plain object |
google.spanner.v1.Spanner.CreateSessionCallback | callback |
Node-style callback called with the error, if any, and Session |
Type | Description |
---|---|
void |
createSession(request)
public createSession(request: google.spanner.v1.ICreateSessionRequest): Promise<google.spanner.v1.Session>;
Calls CreateSession.
Type | Name | Description |
---|---|---|
google.spanner.v1.ICreateSessionRequest | request |
CreateSessionRequest message or plain object |
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.
Type | Name | Description |
---|---|---|
google.spanner.v1.IDeleteSessionRequest | request |
DeleteSessionRequest message or plain object |
google.spanner.v1.Spanner.DeleteSessionCallback | callback |
Node-style callback called with the error, if any, and Empty |
Type | Description |
---|---|
void |
deleteSession(request)
public deleteSession(request: google.spanner.v1.IDeleteSessionRequest): Promise<google.protobuf.Empty>;
Calls DeleteSession.
Type | Name | Description |
---|---|---|
google.spanner.v1.IDeleteSessionRequest | request |
DeleteSessionRequest message or plain object |
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.
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 |
Type | Description |
---|---|
void |
executeBatchDml(request)
public executeBatchDml(request: google.spanner.v1.IExecuteBatchDmlRequest): Promise<google.spanner.v1.ExecuteBatchDmlResponse>;
Calls ExecuteBatchDml.
Type | Name | Description |
---|---|---|
IExecuteBatchDmlRequest | request |
ExecuteBatchDmlRequest message or plain object |
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.
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 |
Type | Description |
---|---|
void |
executeSql(request)
public executeSql(request: google.spanner.v1.IExecuteSqlRequest): Promise<google.spanner.v1.ResultSet>;
Calls ExecuteSql.
Type | Name | Description |
---|---|---|
IExecuteSqlRequest | request |
ExecuteSqlRequest message or plain object |
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.
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 |
Type | Description |
---|---|
void |
executeStreamingSql(request)
public executeStreamingSql(request: google.spanner.v1.IExecuteSqlRequest): Promise<google.spanner.v1.PartialResultSet>;
Calls ExecuteStreamingSql.
Type | Name | Description |
---|---|---|
IExecuteSqlRequest | request |
ExecuteSqlRequest message or plain object |
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.
Type | Name | Description |
---|---|---|
google.spanner.v1.IGetSessionRequest | request |
GetSessionRequest message or plain object |
google.spanner.v1.Spanner.GetSessionCallback | callback |
Node-style callback called with the error, if any, and Session |
Type | Description |
---|---|
void |
getSession(request)
public getSession(request: google.spanner.v1.IGetSessionRequest): Promise<google.spanner.v1.Session>;
Calls GetSession.
Type | Name | Description |
---|---|---|
google.spanner.v1.IGetSessionRequest | request |
GetSessionRequest message or plain object |
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.
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 |
Type | Description |
---|---|
void |
listSessions(request)
public listSessions(request: google.spanner.v1.IListSessionsRequest): Promise<google.spanner.v1.ListSessionsResponse>;
Calls ListSessions.
Type | Name | Description |
---|---|---|
IListSessionsRequest | request |
ListSessionsRequest message or plain object |
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.
Type | Name | Description |
---|---|---|
google.spanner.v1.IPartitionQueryRequest | request |
PartitionQueryRequest message or plain object |
google.spanner.v1.Spanner.PartitionQueryCallback | callback |
Node-style callback called with the error, if any, and PartitionResponse |
Type | Description |
---|---|
void |
partitionQuery(request)
public partitionQuery(request: google.spanner.v1.IPartitionQueryRequest): Promise<google.spanner.v1.PartitionResponse>;
Calls PartitionQuery.
Type | Name | Description |
---|---|---|
google.spanner.v1.IPartitionQueryRequest | request |
PartitionQueryRequest message or plain object |
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.
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 |
Type | Description |
---|---|
void |
partitionRead(request)
public partitionRead(request: google.spanner.v1.IPartitionReadRequest): Promise<google.spanner.v1.PartitionResponse>;
Calls PartitionRead.
Type | Name | Description |
---|---|---|
IPartitionReadRequest | request |
PartitionReadRequest message or plain object |
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.
Type | Name | Description |
---|---|---|
google.spanner.v1.IReadRequest | request |
ReadRequest message or plain object |
google.spanner.v1.Spanner.ReadCallback | callback |
Node-style callback called with the error, if any, and ResultSet |
Type | Description |
---|---|
void |
read(request)
public read(request: google.spanner.v1.IReadRequest): Promise<google.spanner.v1.ResultSet>;
Calls Read.
Type | Name | Description |
---|---|---|
google.spanner.v1.IReadRequest | request |
ReadRequest message or plain object |
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.
Type | Name | Description |
---|---|---|
IRollbackRequest | request |
RollbackRequest message or plain object |
google.spanner.v1.Spanner.RollbackCallback | callback |
Node-style callback called with the error, if any, and Empty |
Type | Description |
---|---|
void |
rollback(request)
public rollback(request: google.spanner.v1.IRollbackRequest): Promise<google.protobuf.Empty>;
Calls Rollback.
Type | Name | Description |
---|---|---|
IRollbackRequest | request |
RollbackRequest message or plain object |
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.
Type | Name | Description |
---|---|---|
google.spanner.v1.IReadRequest | request |
ReadRequest message or plain object |
google.spanner.v1.Spanner.StreamingReadCallback | callback |
Node-style callback called with the error, if any, and PartialResultSet |
Type | Description |
---|---|
void |
streamingRead(request)
public streamingRead(request: google.spanner.v1.IReadRequest): Promise<google.spanner.v1.PartialResultSet>;
Calls StreamingRead.
Type | Name | Description |
---|---|---|
google.spanner.v1.IReadRequest | request |
ReadRequest message or plain object |
Type | Description |
---|---|
Promise<google.spanner.v1.PartialResultSet> | Promise |