| // Copyright 2026 Google LLC |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // https://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| |
| // Code generated by protoc-gen-go_gapic. DO NOT EDIT. |
| |
| package spanner |
| |
| import ( |
| "bytes" |
| "context" |
| "errors" |
| "fmt" |
| "log/slog" |
| "math" |
| "net/http" |
| "net/url" |
| "time" |
| |
| spannerpb "cloud.google.com/go/spanner/apiv1/spannerpb" |
| gax "github.com/googleapis/gax-go/v2" |
| "github.com/googleapis/gax-go/v2/callctx" |
| "google.golang.org/api/iterator" |
| "google.golang.org/api/option" |
| "google.golang.org/api/option/internaloption" |
| gtransport "google.golang.org/api/transport/grpc" |
| httptransport "google.golang.org/api/transport/http" |
| "google.golang.org/grpc" |
| "google.golang.org/grpc/codes" |
| "google.golang.org/grpc/metadata" |
| "google.golang.org/protobuf/encoding/protojson" |
| "google.golang.org/protobuf/proto" |
| ) |
| |
| var newClientHook clientHook |
| |
| // CallOptions contains the retry settings for each method of Client. |
| type CallOptions struct { |
| CreateSession []gax.CallOption |
| BatchCreateSessions []gax.CallOption |
| GetSession []gax.CallOption |
| ListSessions []gax.CallOption |
| DeleteSession []gax.CallOption |
| ExecuteSql []gax.CallOption |
| ExecuteStreamingSql []gax.CallOption |
| ExecuteBatchDml []gax.CallOption |
| Read []gax.CallOption |
| StreamingRead []gax.CallOption |
| BeginTransaction []gax.CallOption |
| Commit []gax.CallOption |
| Rollback []gax.CallOption |
| PartitionQuery []gax.CallOption |
| PartitionRead []gax.CallOption |
| BatchWrite []gax.CallOption |
| FetchCacheUpdate []gax.CallOption |
| } |
| |
| func defaultGRPCClientOptions() []option.ClientOption { |
| return []option.ClientOption{ |
| internaloption.WithDefaultEndpoint("spanner.googleapis.com:443"), |
| internaloption.WithDefaultEndpointTemplate("spanner.UNIVERSE_DOMAIN:443"), |
| internaloption.WithDefaultMTLSEndpoint("spanner.mtls.googleapis.com:443"), |
| internaloption.WithDefaultUniverseDomain("googleapis.com"), |
| internaloption.WithDefaultAudience("https://spanner.googleapis.com/"), |
| internaloption.WithDefaultScopes(DefaultAuthScopes()...), |
| internaloption.EnableJwtWithScope(), |
| internaloption.EnableNewAuthLibrary(), |
| option.WithGRPCDialOption(grpc.WithDefaultCallOptions( |
| grpc.MaxCallRecvMsgSize(math.MaxInt32))), |
| } |
| } |
| |
| func defaultCallOptions() *CallOptions { |
| return &CallOptions{ |
| CreateSession: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnCodes([]codes.Code{ |
| codes.Unavailable, |
| codes.ResourceExhausted, |
| }, gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }) |
| }), |
| }, |
| BatchCreateSessions: []gax.CallOption{ |
| gax.WithTimeout(60000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnCodes([]codes.Code{ |
| codes.Unavailable, |
| codes.ResourceExhausted, |
| }, gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }) |
| }), |
| }, |
| GetSession: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnCodes([]codes.Code{ |
| codes.Unavailable, |
| codes.ResourceExhausted, |
| }, gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }) |
| }), |
| }, |
| ListSessions: []gax.CallOption{ |
| gax.WithTimeout(3600000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnCodes([]codes.Code{ |
| codes.Unavailable, |
| codes.ResourceExhausted, |
| }, gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }) |
| }), |
| }, |
| DeleteSession: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnCodes([]codes.Code{ |
| codes.Unavailable, |
| codes.ResourceExhausted, |
| }, gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }) |
| }), |
| }, |
| ExecuteSql: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnCodes([]codes.Code{ |
| codes.Unavailable, |
| codes.ResourceExhausted, |
| }, gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }) |
| }), |
| }, |
| ExecuteStreamingSql: []gax.CallOption{}, |
| ExecuteBatchDml: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnCodes([]codes.Code{ |
| codes.Unavailable, |
| codes.ResourceExhausted, |
| }, gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }) |
| }), |
| }, |
| Read: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnCodes([]codes.Code{ |
| codes.Unavailable, |
| codes.ResourceExhausted, |
| }, gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }) |
| }), |
| }, |
| StreamingRead: []gax.CallOption{}, |
| BeginTransaction: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnCodes([]codes.Code{ |
| codes.Unavailable, |
| codes.ResourceExhausted, |
| }, gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }) |
| }), |
| }, |
| Commit: []gax.CallOption{ |
| gax.WithTimeout(3600000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnCodes([]codes.Code{ |
| codes.Unavailable, |
| codes.ResourceExhausted, |
| }, gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }) |
| }), |
| }, |
| Rollback: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnCodes([]codes.Code{ |
| codes.Unavailable, |
| codes.ResourceExhausted, |
| }, gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }) |
| }), |
| }, |
| PartitionQuery: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnCodes([]codes.Code{ |
| codes.Unavailable, |
| codes.ResourceExhausted, |
| }, gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }) |
| }), |
| }, |
| PartitionRead: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnCodes([]codes.Code{ |
| codes.Unavailable, |
| codes.ResourceExhausted, |
| }, gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }) |
| }), |
| }, |
| BatchWrite: []gax.CallOption{}, |
| FetchCacheUpdate: []gax.CallOption{}, |
| } |
| } |
| |
| func defaultRESTCallOptions() *CallOptions { |
| return &CallOptions{ |
| CreateSession: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnHTTPCodes(gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }, |
| http.StatusServiceUnavailable, |
| http.StatusTooManyRequests) |
| }), |
| }, |
| BatchCreateSessions: []gax.CallOption{ |
| gax.WithTimeout(60000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnHTTPCodes(gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }, |
| http.StatusServiceUnavailable, |
| http.StatusTooManyRequests) |
| }), |
| }, |
| GetSession: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnHTTPCodes(gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }, |
| http.StatusServiceUnavailable, |
| http.StatusTooManyRequests) |
| }), |
| }, |
| ListSessions: []gax.CallOption{ |
| gax.WithTimeout(3600000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnHTTPCodes(gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }, |
| http.StatusServiceUnavailable, |
| http.StatusTooManyRequests) |
| }), |
| }, |
| DeleteSession: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnHTTPCodes(gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }, |
| http.StatusServiceUnavailable, |
| http.StatusTooManyRequests) |
| }), |
| }, |
| ExecuteSql: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnHTTPCodes(gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }, |
| http.StatusServiceUnavailable, |
| http.StatusTooManyRequests) |
| }), |
| }, |
| ExecuteStreamingSql: []gax.CallOption{ |
| gax.WithTimeout(3600000 * time.Millisecond), |
| }, |
| ExecuteBatchDml: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnHTTPCodes(gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }, |
| http.StatusServiceUnavailable, |
| http.StatusTooManyRequests) |
| }), |
| }, |
| Read: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnHTTPCodes(gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }, |
| http.StatusServiceUnavailable, |
| http.StatusTooManyRequests) |
| }), |
| }, |
| StreamingRead: []gax.CallOption{ |
| gax.WithTimeout(3600000 * time.Millisecond), |
| }, |
| BeginTransaction: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnHTTPCodes(gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }, |
| http.StatusServiceUnavailable, |
| http.StatusTooManyRequests) |
| }), |
| }, |
| Commit: []gax.CallOption{ |
| gax.WithTimeout(3600000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnHTTPCodes(gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }, |
| http.StatusServiceUnavailable, |
| http.StatusTooManyRequests) |
| }), |
| }, |
| Rollback: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnHTTPCodes(gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }, |
| http.StatusServiceUnavailable, |
| http.StatusTooManyRequests) |
| }), |
| }, |
| PartitionQuery: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnHTTPCodes(gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }, |
| http.StatusServiceUnavailable, |
| http.StatusTooManyRequests) |
| }), |
| }, |
| PartitionRead: []gax.CallOption{ |
| gax.WithTimeout(30000 * time.Millisecond), |
| gax.WithRetry(func() gax.Retryer { |
| return gax.OnHTTPCodes(gax.Backoff{ |
| Initial: 250 * time.Millisecond, |
| Max: 32000 * time.Millisecond, |
| Multiplier: 1.30, |
| }, |
| http.StatusServiceUnavailable, |
| http.StatusTooManyRequests) |
| }), |
| }, |
| BatchWrite: []gax.CallOption{ |
| gax.WithTimeout(3600000 * time.Millisecond), |
| }, |
| FetchCacheUpdate: []gax.CallOption{}, |
| } |
| } |
| |
| // internalClient is an interface that defines the methods available from Cloud Spanner API. |
| type internalClient interface { |
| Close() error |
| setGoogleClientInfo(...string) |
| Connection() *grpc.ClientConn |
| CreateSession(context.Context, *spannerpb.CreateSessionRequest, ...gax.CallOption) (*spannerpb.Session, error) |
| BatchCreateSessions(context.Context, *spannerpb.BatchCreateSessionsRequest, ...gax.CallOption) (*spannerpb.BatchCreateSessionsResponse, error) |
| GetSession(context.Context, *spannerpb.GetSessionRequest, ...gax.CallOption) (*spannerpb.Session, error) |
| ListSessions(context.Context, *spannerpb.ListSessionsRequest, ...gax.CallOption) *SessionIterator |
| DeleteSession(context.Context, *spannerpb.DeleteSessionRequest, ...gax.CallOption) error |
| ExecuteSql(context.Context, *spannerpb.ExecuteSqlRequest, ...gax.CallOption) (*spannerpb.ResultSet, error) |
| ExecuteStreamingSql(context.Context, *spannerpb.ExecuteSqlRequest, ...gax.CallOption) (spannerpb.Spanner_ExecuteStreamingSqlClient, error) |
| ExecuteBatchDml(context.Context, *spannerpb.ExecuteBatchDmlRequest, ...gax.CallOption) (*spannerpb.ExecuteBatchDmlResponse, error) |
| Read(context.Context, *spannerpb.ReadRequest, ...gax.CallOption) (*spannerpb.ResultSet, error) |
| StreamingRead(context.Context, *spannerpb.ReadRequest, ...gax.CallOption) (spannerpb.Spanner_StreamingReadClient, error) |
| BeginTransaction(context.Context, *spannerpb.BeginTransactionRequest, ...gax.CallOption) (*spannerpb.Transaction, error) |
| Commit(context.Context, *spannerpb.CommitRequest, ...gax.CallOption) (*spannerpb.CommitResponse, error) |
| Rollback(context.Context, *spannerpb.RollbackRequest, ...gax.CallOption) error |
| PartitionQuery(context.Context, *spannerpb.PartitionQueryRequest, ...gax.CallOption) (*spannerpb.PartitionResponse, error) |
| PartitionRead(context.Context, *spannerpb.PartitionReadRequest, ...gax.CallOption) (*spannerpb.PartitionResponse, error) |
| BatchWrite(context.Context, *spannerpb.BatchWriteRequest, ...gax.CallOption) (spannerpb.Spanner_BatchWriteClient, error) |
| FetchCacheUpdate(context.Context, *spannerpb.FetchCacheUpdateRequest, ...gax.CallOption) (spannerpb.Spanner_FetchCacheUpdateClient, error) |
| } |
| |
| // Client is a client for interacting with Cloud Spanner API. |
| // Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls. |
| // |
| // # Cloud Spanner API |
| // |
| // The Cloud Spanner API can be used to manage sessions and execute |
| // transactions on data stored in Cloud Spanner databases. |
| type Client struct { |
| // The internal transport-dependent client. |
| internalClient internalClient |
| |
| // The call options for this service. |
| CallOptions *CallOptions |
| } |
| |
| // Wrapper methods routed to the internal client. |
| |
| // Close closes the connection to the API service. **Always** call Close() when |
| // the client is no longer required. |
| func (c *Client) Close() error { |
| return c.internalClient.Close() |
| } |
| |
| // setGoogleClientInfo sets the name and version of the application in |
| // the `x-goog-api-client` header passed on each request. Intended for |
| // use by Google-written clients. |
| func (c *Client) setGoogleClientInfo(keyval ...string) { |
| c.internalClient.setGoogleClientInfo(keyval...) |
| } |
| |
| // SetGoogleClientInfo sets the name and version of the application in |
| // the `x-goog-api-client` header passed on each request. Intended for |
| // use by Google-written clients. |
| // |
| // SetGoogleClientInfo is not concurrency-safe and should only be invoked |
| // sequentially before concurrent operations begin. |
| func (c *Client) SetGoogleClientInfo(keyval ...string) { |
| c.setGoogleClientInfo(keyval...) |
| } |
| |
| // Connection returns a connection to the API service. |
| // |
| // Deprecated: Connections are now pooled so this method does not always |
| // return the same resource. |
| func (c *Client) Connection() *grpc.ClientConn { |
| return c.internalClient.Connection() |
| } |
| |
| // CreateSession 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’s a good idea to |
| // delete idle and unneeded sessions. |
| // Aside from explicit deletes, Cloud Spanner can delete sessions when 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, for example, "SELECT 1". |
| func (c *Client) CreateSession(ctx context.Context, req *spannerpb.CreateSessionRequest, opts ...gax.CallOption) (*spannerpb.Session, error) { |
| return c.internalClient.CreateSession(ctx, req, opts...) |
| } |
| |
| // BatchCreateSessions creates multiple new sessions. |
| // |
| // This API can be used to initialize a session cache on the clients. |
| // See https://goo.gl/TgSFN2 (at https://goo.gl/TgSFN2) for best practices on session cache management. |
| func (c *Client) BatchCreateSessions(ctx context.Context, req *spannerpb.BatchCreateSessionsRequest, opts ...gax.CallOption) (*spannerpb.BatchCreateSessionsResponse, error) { |
| return c.internalClient.BatchCreateSessions(ctx, req, opts...) |
| } |
| |
| // GetSession gets a session. Returns NOT_FOUND if the session doesn’t exist. |
| // This is mainly useful for determining whether a session is still |
| // alive. |
| func (c *Client) GetSession(ctx context.Context, req *spannerpb.GetSessionRequest, opts ...gax.CallOption) (*spannerpb.Session, error) { |
| return c.internalClient.GetSession(ctx, req, opts...) |
| } |
| |
| // ListSessions lists all sessions in a given database. |
| func (c *Client) ListSessions(ctx context.Context, req *spannerpb.ListSessionsRequest, opts ...gax.CallOption) *SessionIterator { |
| return c.internalClient.ListSessions(ctx, req, opts...) |
| } |
| |
| // DeleteSession ends a session, releasing server resources associated with it. This |
| // asynchronously triggers the cancellation of any operations that are running |
| // with this session. |
| func (c *Client) DeleteSession(ctx context.Context, req *spannerpb.DeleteSessionRequest, opts ...gax.CallOption) error { |
| return c.internalClient.DeleteSession(ctx, req, opts...) |
| } |
| |
| // ExecuteSql executes an SQL statement, returning all results in a single reply. This |
| // method can’t 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. |
| // |
| // The query string can be SQL or Graph Query Language |
| // (GQL) (at https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro). |
| func (c *Client) ExecuteSql(ctx context.Context, req *spannerpb.ExecuteSqlRequest, opts ...gax.CallOption) (*spannerpb.ResultSet, error) { |
| return c.internalClient.ExecuteSql(ctx, req, opts...) |
| } |
| |
| // 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. However, no individual row in the |
| // result set can exceed 100 MiB, and no column value can exceed 10 MiB. |
| // |
| // The query string can be SQL or Graph Query Language |
| // (GQL) (at https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro). |
| func (c *Client) ExecuteStreamingSql(ctx context.Context, req *spannerpb.ExecuteSqlRequest, opts ...gax.CallOption) (spannerpb.Spanner_ExecuteStreamingSqlClient, error) { |
| return c.internalClient.ExecuteStreamingSql(ctx, req, opts...) |
| } |
| |
| // 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. |
| // |
| // 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. |
| func (c *Client) ExecuteBatchDml(ctx context.Context, req *spannerpb.ExecuteBatchDmlRequest, opts ...gax.CallOption) (*spannerpb.ExecuteBatchDmlResponse, error) { |
| return c.internalClient.ExecuteBatchDml(ctx, req, opts...) |
| } |
| |
| // Read reads rows from the database using key lookups and scans, as a |
| // simple key/value style alternative to |
| // ExecuteSql. This method can’t 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. |
| func (c *Client) Read(ctx context.Context, req *spannerpb.ReadRequest, opts ...gax.CallOption) (*spannerpb.ResultSet, error) { |
| return c.internalClient.Read(ctx, req, opts...) |
| } |
| |
| // 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. |
| func (c *Client) StreamingRead(ctx context.Context, req *spannerpb.ReadRequest, opts ...gax.CallOption) (spannerpb.Spanner_StreamingReadClient, error) { |
| return c.internalClient.StreamingRead(ctx, req, opts...) |
| } |
| |
| // BeginTransaction begins a new transaction. This step can often be skipped: |
| // Read, |
| // ExecuteSql and |
| // Commit can begin a new transaction as a |
| // side-effect. |
| func (c *Client) BeginTransaction(ctx context.Context, req *spannerpb.BeginTransactionRequest, opts ...gax.CallOption) (*spannerpb.Transaction, error) { |
| return c.internalClient.BeginTransaction(ctx, req, opts...) |
| } |
| |
| // 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 retry |
| // the transaction from the beginning, reusing 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. |
| func (c *Client) Commit(ctx context.Context, req *spannerpb.CommitRequest, opts ...gax.CallOption) (*spannerpb.CommitResponse, error) { |
| return c.internalClient.Commit(ctx, req, opts...) |
| } |
| |
| // Rollback rolls back a transaction, releasing any locks it holds. It’s 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 isn’t |
| // found. Rollback never returns ABORTED. |
| func (c *Client) Rollback(ctx context.Context, req *spannerpb.RollbackRequest, opts ...gax.CallOption) error { |
| return c.internalClient.Rollback(ctx, req, opts...) |
| } |
| |
| // 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 isn’t possible to resume the query, and |
| // the whole operation must be restarted from the beginning. |
| func (c *Client) PartitionQuery(ctx context.Context, req *spannerpb.PartitionQueryRequest, opts ...gax.CallOption) (*spannerpb.PartitionResponse, error) { |
| return c.internalClient.PartitionQuery(ctx, req, opts...) |
| } |
| |
| // 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 isn’t possible to resume the read, and |
| // the whole operation must be restarted from the beginning. |
| func (c *Client) PartitionRead(ctx context.Context, req *spannerpb.PartitionReadRequest, opts ...gax.CallOption) (*spannerpb.PartitionResponse, error) { |
| return c.internalClient.PartitionRead(ctx, req, opts...) |
| } |
| |
| // BatchWrite batches the supplied mutation groups in a collection of efficient |
| // transactions. All mutations in a group are committed atomically. However, |
| // mutations across groups can be committed non-atomically in an unspecified |
| // order and thus, they must be independent of each other. Partial failure is |
| // possible, that is, some groups might have been committed successfully, |
| // while some might have failed. The results of individual batches are |
| // streamed into the response as the batches are applied. |
| // |
| // BatchWrite requests are not replay protected, meaning that each mutation |
| // group can be applied more than once. Replays of non-idempotent mutations |
| // can have undesirable effects. For example, replays of an insert mutation |
| // can produce an already exists error or if you use generated or commit |
| // timestamp-based keys, it can result in additional rows being added to the |
| // mutation’s table. We recommend structuring your mutation groups to be |
| // idempotent to avoid this issue. |
| func (c *Client) BatchWrite(ctx context.Context, req *spannerpb.BatchWriteRequest, opts ...gax.CallOption) (spannerpb.Spanner_BatchWriteClient, error) { |
| return c.internalClient.BatchWrite(ctx, req, opts...) |
| } |
| |
| // FetchCacheUpdate retrieves a cache update for a given database. |
| // |
| // This RPC can be used to warm up the client cache by fetching key recipes |
| // and server information for a given database. It is recommended to call |
| // this RPC at the beginning of the client’s lifecycle, prior to any other |
| // data plane operations. |
| // |
| // The cache update is returned as a stream because the response can be too |
| // large to fit into a single CacheUpdate message. |
| func (c *Client) FetchCacheUpdate(ctx context.Context, req *spannerpb.FetchCacheUpdateRequest, opts ...gax.CallOption) (spannerpb.Spanner_FetchCacheUpdateClient, error) { |
| return c.internalClient.FetchCacheUpdate(ctx, req, opts...) |
| } |
| |
| // gRPCClient is a client for interacting with Cloud Spanner API over gRPC transport. |
| // |
| // Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls. |
| type gRPCClient struct { |
| // Connection pool of gRPC connections to the service. |
| connPool gtransport.ConnPool |
| |
| // Points back to the CallOptions field of the containing Client |
| CallOptions **CallOptions |
| |
| // The gRPC API client. |
| client spannerpb.SpannerClient |
| |
| // The x-goog-* metadata to be sent with each request. |
| xGoogHeaders []string |
| |
| logger *slog.Logger |
| } |
| |
| // NewClient creates a new spanner client based on gRPC. |
| // The returned client must be Closed when it is done being used to clean up its underlying connections. |
| // |
| // # Cloud Spanner API |
| // |
| // The Cloud Spanner API can be used to manage sessions and execute |
| // transactions on data stored in Cloud Spanner databases. |
| func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error) { |
| clientOpts := defaultGRPCClientOptions() |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| clientOpts = append(clientOpts, internaloption.WithTelemetryAttributes(map[string]string{ |
| "gcp.client.service": "spanner", |
| "gcp.client.version": getVersionClient(), |
| "gcp.client.repo": "googleapis/google-cloud-go", |
| "gcp.client.artifact": "cloud.google.com/go/spanner/apiv1", |
| "gcp.client.language": "go", |
| "url.domain": "spanner.googleapis.com", |
| })) |
| } |
| if newClientHook != nil { |
| hookOpts, err := newClientHook(ctx, clientHookParams{}) |
| if err != nil { |
| return nil, err |
| } |
| clientOpts = append(clientOpts, hookOpts...) |
| } |
| |
| connPool, err := gtransport.DialPool(ctx, append(clientOpts, opts...)...) |
| if err != nil { |
| return nil, err |
| } |
| client := Client{CallOptions: defaultCallOptions()} |
| |
| c := &gRPCClient{ |
| connPool: connPool, |
| client: spannerpb.NewSpannerClient(connPool), |
| CallOptions: &client.CallOptions, |
| logger: internaloption.GetLogger(opts), |
| } |
| c.setGoogleClientInfo() |
| if gax.IsFeatureEnabled("METRICS") { |
| metrics := gax.NewClientMetrics( |
| gax.WithTelemetryLogger(c.logger), |
| gax.WithTelemetryAttributes(map[string]string{ |
| gax.ClientService: "spanner", |
| gax.ClientVersion: getVersionClient(), |
| gax.ClientArtifact: "cloud.google.com/go/spanner/apiv1", |
| gax.RPCSystem: "grpc", |
| gax.URLDomain: "spanner.googleapis.com", |
| }), |
| ) |
| |
| client.CallOptions.CreateSession = append(client.CallOptions.CreateSession, gax.WithClientMetrics(metrics)) |
| client.CallOptions.BatchCreateSessions = append(client.CallOptions.BatchCreateSessions, gax.WithClientMetrics(metrics)) |
| client.CallOptions.GetSession = append(client.CallOptions.GetSession, gax.WithClientMetrics(metrics)) |
| client.CallOptions.ListSessions = append(client.CallOptions.ListSessions, gax.WithClientMetrics(metrics)) |
| client.CallOptions.DeleteSession = append(client.CallOptions.DeleteSession, gax.WithClientMetrics(metrics)) |
| client.CallOptions.ExecuteSql = append(client.CallOptions.ExecuteSql, gax.WithClientMetrics(metrics)) |
| client.CallOptions.ExecuteStreamingSql = append(client.CallOptions.ExecuteStreamingSql, gax.WithClientMetrics(metrics)) |
| client.CallOptions.ExecuteBatchDml = append(client.CallOptions.ExecuteBatchDml, gax.WithClientMetrics(metrics)) |
| client.CallOptions.Read = append(client.CallOptions.Read, gax.WithClientMetrics(metrics)) |
| client.CallOptions.StreamingRead = append(client.CallOptions.StreamingRead, gax.WithClientMetrics(metrics)) |
| client.CallOptions.BeginTransaction = append(client.CallOptions.BeginTransaction, gax.WithClientMetrics(metrics)) |
| client.CallOptions.Commit = append(client.CallOptions.Commit, gax.WithClientMetrics(metrics)) |
| client.CallOptions.Rollback = append(client.CallOptions.Rollback, gax.WithClientMetrics(metrics)) |
| client.CallOptions.PartitionQuery = append(client.CallOptions.PartitionQuery, gax.WithClientMetrics(metrics)) |
| client.CallOptions.PartitionRead = append(client.CallOptions.PartitionRead, gax.WithClientMetrics(metrics)) |
| client.CallOptions.BatchWrite = append(client.CallOptions.BatchWrite, gax.WithClientMetrics(metrics)) |
| client.CallOptions.FetchCacheUpdate = append(client.CallOptions.FetchCacheUpdate, gax.WithClientMetrics(metrics)) |
| } |
| |
| client.internalClient = c |
| |
| return &client, nil |
| } |
| |
| // Connection returns a connection to the API service. |
| // |
| // Deprecated: Connections are now pooled so this method does not always |
| // return the same resource. |
| func (c *gRPCClient) Connection() *grpc.ClientConn { |
| return c.connPool.Conn() |
| } |
| |
| // setGoogleClientInfo sets the name and version of the application in |
| // the `x-goog-api-client` header passed on each request. Intended for |
| // use by Google-written clients. |
| func (c *gRPCClient) setGoogleClientInfo(keyval ...string) { |
| kv := append([]string{"gl-go", gax.GoVersion}, keyval...) |
| kv = append(kv, "gapic", getVersionClient(), "gax", gax.Version, "grpc", grpc.Version, "pb", protoVersion) |
| c.xGoogHeaders = []string{ |
| "x-goog-api-client", gax.XGoogHeader(kv...), |
| } |
| } |
| |
| // Close closes the connection to the API service. **Always** call Close() when |
| // the client is no longer required. |
| func (c *gRPCClient) Close() error { |
| return c.connPool.Close() |
| } |
| |
| // Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls. |
| type restClient struct { |
| // The http endpoint to connect to. |
| endpoint string |
| |
| // The http client. |
| httpClient *http.Client |
| |
| // The x-goog-* headers to be sent with each request. |
| xGoogHeaders []string |
| |
| // Points back to the CallOptions field of the containing Client |
| CallOptions **CallOptions |
| |
| logger *slog.Logger |
| } |
| |
| // NewRESTClient creates a new spanner rest client. |
| // |
| // # Cloud Spanner API |
| // |
| // The Cloud Spanner API can be used to manage sessions and execute |
| // transactions on data stored in Cloud Spanner databases. |
| func NewRESTClient(ctx context.Context, opts ...option.ClientOption) (*Client, error) { |
| clientOpts := append(defaultRESTClientOptions(), opts...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| clientOpts = append(clientOpts, internaloption.WithTelemetryAttributes(map[string]string{ |
| "gcp.client.service": "spanner", |
| "gcp.client.version": getVersionClient(), |
| "gcp.client.repo": "googleapis/google-cloud-go", |
| "gcp.client.artifact": "cloud.google.com/go/spanner/apiv1", |
| "gcp.client.language": "go", |
| "url.domain": "spanner.googleapis.com", |
| })) |
| } |
| httpClient, endpoint, err := httptransport.NewClient(ctx, clientOpts...) |
| if err != nil { |
| return nil, err |
| } |
| |
| callOpts := defaultRESTCallOptions() |
| c := &restClient{ |
| endpoint: endpoint, |
| httpClient: httpClient, |
| CallOptions: &callOpts, |
| logger: internaloption.GetLogger(opts), |
| } |
| c.setGoogleClientInfo() |
| |
| if gax.IsFeatureEnabled("METRICS") { |
| metrics := gax.NewClientMetrics( |
| gax.WithTelemetryLogger(c.logger), |
| gax.WithTelemetryAttributes(map[string]string{ |
| gax.ClientService: "spanner", |
| gax.ClientVersion: getVersionClient(), |
| gax.ClientArtifact: "cloud.google.com/go/spanner/apiv1", |
| gax.RPCSystem: "http", |
| gax.URLDomain: "spanner.googleapis.com", |
| }), |
| ) |
| |
| callOpts.CreateSession = append(callOpts.CreateSession, gax.WithClientMetrics(metrics)) |
| callOpts.BatchCreateSessions = append(callOpts.BatchCreateSessions, gax.WithClientMetrics(metrics)) |
| callOpts.GetSession = append(callOpts.GetSession, gax.WithClientMetrics(metrics)) |
| callOpts.ListSessions = append(callOpts.ListSessions, gax.WithClientMetrics(metrics)) |
| callOpts.DeleteSession = append(callOpts.DeleteSession, gax.WithClientMetrics(metrics)) |
| callOpts.ExecuteSql = append(callOpts.ExecuteSql, gax.WithClientMetrics(metrics)) |
| callOpts.ExecuteStreamingSql = append(callOpts.ExecuteStreamingSql, gax.WithClientMetrics(metrics)) |
| callOpts.ExecuteBatchDml = append(callOpts.ExecuteBatchDml, gax.WithClientMetrics(metrics)) |
| callOpts.Read = append(callOpts.Read, gax.WithClientMetrics(metrics)) |
| callOpts.StreamingRead = append(callOpts.StreamingRead, gax.WithClientMetrics(metrics)) |
| callOpts.BeginTransaction = append(callOpts.BeginTransaction, gax.WithClientMetrics(metrics)) |
| callOpts.Commit = append(callOpts.Commit, gax.WithClientMetrics(metrics)) |
| callOpts.Rollback = append(callOpts.Rollback, gax.WithClientMetrics(metrics)) |
| callOpts.PartitionQuery = append(callOpts.PartitionQuery, gax.WithClientMetrics(metrics)) |
| callOpts.PartitionRead = append(callOpts.PartitionRead, gax.WithClientMetrics(metrics)) |
| callOpts.BatchWrite = append(callOpts.BatchWrite, gax.WithClientMetrics(metrics)) |
| callOpts.FetchCacheUpdate = append(callOpts.FetchCacheUpdate, gax.WithClientMetrics(metrics)) |
| } |
| |
| return &Client{internalClient: c, CallOptions: callOpts}, nil |
| } |
| |
| func defaultRESTClientOptions() []option.ClientOption { |
| return []option.ClientOption{ |
| internaloption.WithDefaultEndpoint("https://spanner.googleapis.com"), |
| internaloption.WithDefaultEndpointTemplate("https://spanner.UNIVERSE_DOMAIN"), |
| internaloption.WithDefaultMTLSEndpoint("https://spanner.mtls.googleapis.com"), |
| internaloption.WithDefaultUniverseDomain("googleapis.com"), |
| internaloption.WithDefaultAudience("https://spanner.googleapis.com/"), |
| internaloption.WithDefaultScopes(DefaultAuthScopes()...), |
| internaloption.EnableNewAuthLibrary(), |
| } |
| } |
| |
| // setGoogleClientInfo sets the name and version of the application in |
| // the `x-goog-api-client` header passed on each request. Intended for |
| // use by Google-written clients. |
| func (c *restClient) setGoogleClientInfo(keyval ...string) { |
| kv := append([]string{"gl-go", gax.GoVersion}, keyval...) |
| kv = append(kv, "gapic", getVersionClient(), "gax", gax.Version, "rest", "UNKNOWN", "pb", protoVersion) |
| c.xGoogHeaders = []string{ |
| "x-goog-api-client", gax.XGoogHeader(kv...), |
| } |
| } |
| |
| // Close closes the connection to the API service. **Always** call Close() when |
| // the client is no longer required. |
| func (c *restClient) Close() error { |
| // Replace httpClient with nil to force cleanup. |
| c.httpClient = nil |
| return nil |
| } |
| |
| // Connection returns a connection to the API service. |
| // |
| // Deprecated: This method always returns nil. |
| func (c *restClient) Connection() *grpc.ClientConn { |
| return nil |
| } |
| func (c *gRPCClient) CreateSession(ctx context.Context, req *spannerpb.CreateSessionRequest, opts ...gax.CallOption) (*spannerpb.Session, error) { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "database", url.QueryEscape(req.GetDatabase()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetDatabase())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/CreateSession") |
| } |
| opts = append((*c.CallOptions).CreateSession[0:len((*c.CallOptions).CreateSession):len((*c.CallOptions).CreateSession)], opts...) |
| var resp *spannerpb.Session |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| resp, err = executeRPC(ctx, c.client.CreateSession, req, settings.GRPC, c.logger, "CreateSession") |
| return err |
| }, opts...) |
| if err != nil { |
| return nil, err |
| } |
| return resp, nil |
| } |
| |
| func (c *gRPCClient) BatchCreateSessions(ctx context.Context, req *spannerpb.BatchCreateSessionsRequest, opts ...gax.CallOption) (*spannerpb.BatchCreateSessionsResponse, error) { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "database", url.QueryEscape(req.GetDatabase()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetDatabase())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/BatchCreateSessions") |
| } |
| opts = append((*c.CallOptions).BatchCreateSessions[0:len((*c.CallOptions).BatchCreateSessions):len((*c.CallOptions).BatchCreateSessions)], opts...) |
| var resp *spannerpb.BatchCreateSessionsResponse |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| resp, err = executeRPC(ctx, c.client.BatchCreateSessions, req, settings.GRPC, c.logger, "BatchCreateSessions") |
| return err |
| }, opts...) |
| if err != nil { |
| return nil, err |
| } |
| return resp, nil |
| } |
| |
| func (c *gRPCClient) GetSession(ctx context.Context, req *spannerpb.GetSessionRequest, opts ...gax.CallOption) (*spannerpb.Session, error) { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetName())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/GetSession") |
| } |
| opts = append((*c.CallOptions).GetSession[0:len((*c.CallOptions).GetSession):len((*c.CallOptions).GetSession)], opts...) |
| var resp *spannerpb.Session |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| resp, err = executeRPC(ctx, c.client.GetSession, req, settings.GRPC, c.logger, "GetSession") |
| return err |
| }, opts...) |
| if err != nil { |
| return nil, err |
| } |
| return resp, nil |
| } |
| |
| func (c *gRPCClient) ListSessions(ctx context.Context, req *spannerpb.ListSessionsRequest, opts ...gax.CallOption) *SessionIterator { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "database", url.QueryEscape(req.GetDatabase()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetDatabase())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/ListSessions") |
| } |
| opts = append((*c.CallOptions).ListSessions[0:len((*c.CallOptions).ListSessions):len((*c.CallOptions).ListSessions)], opts...) |
| it := &SessionIterator{} |
| req = proto.CloneOf(req) |
| it.InternalFetch = func(pageSize int, pageToken string) ([]*spannerpb.Session, string, error) { |
| resp := &spannerpb.ListSessionsResponse{} |
| if pageToken != "" { |
| req.PageToken = pageToken |
| } |
| if pageSize > math.MaxInt32 { |
| req.PageSize = math.MaxInt32 |
| } else if pageSize != 0 { |
| req.PageSize = int32(pageSize) |
| } |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| resp, err = executeRPC(ctx, c.client.ListSessions, req, settings.GRPC, c.logger, "ListSessions") |
| return err |
| }, opts...) |
| if err != nil { |
| return nil, "", err |
| } |
| |
| it.Response = resp |
| return resp.GetSessions(), resp.GetNextPageToken(), nil |
| } |
| fetch := func(pageSize int, pageToken string) (string, error) { |
| items, nextPageToken, err := it.InternalFetch(pageSize, pageToken) |
| if err != nil { |
| return "", err |
| } |
| it.items = append(it.items, items...) |
| return nextPageToken, nil |
| } |
| |
| it.pageInfo, it.nextFunc = iterator.NewPageInfo(fetch, it.bufLen, it.takeBuf) |
| it.pageInfo.MaxSize = int(req.GetPageSize()) |
| it.pageInfo.Token = req.GetPageToken() |
| |
| return it |
| } |
| |
| func (c *gRPCClient) DeleteSession(ctx context.Context, req *spannerpb.DeleteSessionRequest, opts ...gax.CallOption) error { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetName())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/DeleteSession") |
| } |
| opts = append((*c.CallOptions).DeleteSession[0:len((*c.CallOptions).DeleteSession):len((*c.CallOptions).DeleteSession)], opts...) |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| _, err = executeRPC(ctx, c.client.DeleteSession, req, settings.GRPC, c.logger, "DeleteSession") |
| return err |
| }, opts...) |
| return err |
| } |
| |
| func (c *gRPCClient) ExecuteSql(ctx context.Context, req *spannerpb.ExecuteSqlRequest, opts ...gax.CallOption) (*spannerpb.ResultSet, error) { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/ExecuteSql") |
| } |
| opts = append((*c.CallOptions).ExecuteSql[0:len((*c.CallOptions).ExecuteSql):len((*c.CallOptions).ExecuteSql)], opts...) |
| var resp *spannerpb.ResultSet |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| resp, err = executeRPC(ctx, c.client.ExecuteSql, req, settings.GRPC, c.logger, "ExecuteSql") |
| return err |
| }, opts...) |
| if err != nil { |
| return nil, err |
| } |
| return resp, nil |
| } |
| |
| func (c *gRPCClient) ExecuteStreamingSql(ctx context.Context, req *spannerpb.ExecuteSqlRequest, opts ...gax.CallOption) (spannerpb.Spanner_ExecuteStreamingSqlClient, error) { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/ExecuteStreamingSql") |
| } |
| opts = append((*c.CallOptions).ExecuteStreamingSql[0:len((*c.CallOptions).ExecuteStreamingSql):len((*c.CallOptions).ExecuteStreamingSql)], opts...) |
| var resp spannerpb.Spanner_ExecuteStreamingSqlClient |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| c.logger.DebugContext(ctx, "api streaming client request", "serviceName", serviceName, "rpcName", "ExecuteStreamingSql") |
| resp, err = c.client.ExecuteStreamingSql(ctx, req, settings.GRPC...) |
| c.logger.DebugContext(ctx, "api streaming client response", "serviceName", serviceName, "rpcName", "ExecuteStreamingSql") |
| return err |
| }, opts...) |
| if err != nil { |
| return nil, err |
| } |
| return resp, nil |
| } |
| |
| func (c *gRPCClient) ExecuteBatchDml(ctx context.Context, req *spannerpb.ExecuteBatchDmlRequest, opts ...gax.CallOption) (*spannerpb.ExecuteBatchDmlResponse, error) { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/ExecuteBatchDml") |
| } |
| opts = append((*c.CallOptions).ExecuteBatchDml[0:len((*c.CallOptions).ExecuteBatchDml):len((*c.CallOptions).ExecuteBatchDml)], opts...) |
| var resp *spannerpb.ExecuteBatchDmlResponse |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| resp, err = executeRPC(ctx, c.client.ExecuteBatchDml, req, settings.GRPC, c.logger, "ExecuteBatchDml") |
| return err |
| }, opts...) |
| if err != nil { |
| return nil, err |
| } |
| return resp, nil |
| } |
| |
| func (c *gRPCClient) Read(ctx context.Context, req *spannerpb.ReadRequest, opts ...gax.CallOption) (*spannerpb.ResultSet, error) { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/Read") |
| } |
| opts = append((*c.CallOptions).Read[0:len((*c.CallOptions).Read):len((*c.CallOptions).Read)], opts...) |
| var resp *spannerpb.ResultSet |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| resp, err = executeRPC(ctx, c.client.Read, req, settings.GRPC, c.logger, "Read") |
| return err |
| }, opts...) |
| if err != nil { |
| return nil, err |
| } |
| return resp, nil |
| } |
| |
| func (c *gRPCClient) StreamingRead(ctx context.Context, req *spannerpb.ReadRequest, opts ...gax.CallOption) (spannerpb.Spanner_StreamingReadClient, error) { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/StreamingRead") |
| } |
| opts = append((*c.CallOptions).StreamingRead[0:len((*c.CallOptions).StreamingRead):len((*c.CallOptions).StreamingRead)], opts...) |
| var resp spannerpb.Spanner_StreamingReadClient |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| c.logger.DebugContext(ctx, "api streaming client request", "serviceName", serviceName, "rpcName", "StreamingRead") |
| resp, err = c.client.StreamingRead(ctx, req, settings.GRPC...) |
| c.logger.DebugContext(ctx, "api streaming client response", "serviceName", serviceName, "rpcName", "StreamingRead") |
| return err |
| }, opts...) |
| if err != nil { |
| return nil, err |
| } |
| return resp, nil |
| } |
| |
| func (c *gRPCClient) BeginTransaction(ctx context.Context, req *spannerpb.BeginTransactionRequest, opts ...gax.CallOption) (*spannerpb.Transaction, error) { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/BeginTransaction") |
| } |
| opts = append((*c.CallOptions).BeginTransaction[0:len((*c.CallOptions).BeginTransaction):len((*c.CallOptions).BeginTransaction)], opts...) |
| var resp *spannerpb.Transaction |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| resp, err = executeRPC(ctx, c.client.BeginTransaction, req, settings.GRPC, c.logger, "BeginTransaction") |
| return err |
| }, opts...) |
| if err != nil { |
| return nil, err |
| } |
| return resp, nil |
| } |
| |
| func (c *gRPCClient) Commit(ctx context.Context, req *spannerpb.CommitRequest, opts ...gax.CallOption) (*spannerpb.CommitResponse, error) { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/Commit") |
| } |
| opts = append((*c.CallOptions).Commit[0:len((*c.CallOptions).Commit):len((*c.CallOptions).Commit)], opts...) |
| var resp *spannerpb.CommitResponse |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| resp, err = executeRPC(ctx, c.client.Commit, req, settings.GRPC, c.logger, "Commit") |
| return err |
| }, opts...) |
| if err != nil { |
| return nil, err |
| } |
| return resp, nil |
| } |
| |
| func (c *gRPCClient) Rollback(ctx context.Context, req *spannerpb.RollbackRequest, opts ...gax.CallOption) error { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/Rollback") |
| } |
| opts = append((*c.CallOptions).Rollback[0:len((*c.CallOptions).Rollback):len((*c.CallOptions).Rollback)], opts...) |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| _, err = executeRPC(ctx, c.client.Rollback, req, settings.GRPC, c.logger, "Rollback") |
| return err |
| }, opts...) |
| return err |
| } |
| |
| func (c *gRPCClient) PartitionQuery(ctx context.Context, req *spannerpb.PartitionQueryRequest, opts ...gax.CallOption) (*spannerpb.PartitionResponse, error) { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/PartitionQuery") |
| } |
| opts = append((*c.CallOptions).PartitionQuery[0:len((*c.CallOptions).PartitionQuery):len((*c.CallOptions).PartitionQuery)], opts...) |
| var resp *spannerpb.PartitionResponse |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| resp, err = executeRPC(ctx, c.client.PartitionQuery, req, settings.GRPC, c.logger, "PartitionQuery") |
| return err |
| }, opts...) |
| if err != nil { |
| return nil, err |
| } |
| return resp, nil |
| } |
| |
| func (c *gRPCClient) PartitionRead(ctx context.Context, req *spannerpb.PartitionReadRequest, opts ...gax.CallOption) (*spannerpb.PartitionResponse, error) { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/PartitionRead") |
| } |
| opts = append((*c.CallOptions).PartitionRead[0:len((*c.CallOptions).PartitionRead):len((*c.CallOptions).PartitionRead)], opts...) |
| var resp *spannerpb.PartitionResponse |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| resp, err = executeRPC(ctx, c.client.PartitionRead, req, settings.GRPC, c.logger, "PartitionRead") |
| return err |
| }, opts...) |
| if err != nil { |
| return nil, err |
| } |
| return resp, nil |
| } |
| |
| func (c *gRPCClient) BatchWrite(ctx context.Context, req *spannerpb.BatchWriteRequest, opts ...gax.CallOption) (spannerpb.Spanner_BatchWriteClient, error) { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/BatchWrite") |
| } |
| opts = append((*c.CallOptions).BatchWrite[0:len((*c.CallOptions).BatchWrite):len((*c.CallOptions).BatchWrite)], opts...) |
| var resp spannerpb.Spanner_BatchWriteClient |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| c.logger.DebugContext(ctx, "api streaming client request", "serviceName", serviceName, "rpcName", "BatchWrite") |
| resp, err = c.client.BatchWrite(ctx, req, settings.GRPC...) |
| c.logger.DebugContext(ctx, "api streaming client response", "serviceName", serviceName, "rpcName", "BatchWrite") |
| return err |
| }, opts...) |
| if err != nil { |
| return nil, err |
| } |
| return resp, nil |
| } |
| |
| func (c *gRPCClient) FetchCacheUpdate(ctx context.Context, req *spannerpb.FetchCacheUpdateRequest, opts ...gax.CallOption) (spannerpb.Spanner_FetchCacheUpdateClient, error) { |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "database", url.QueryEscape(req.GetDatabase()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| ctx = gax.InsertMetadataIntoOutgoingContext(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetDatabase())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/FetchCacheUpdate") |
| } |
| opts = append((*c.CallOptions).FetchCacheUpdate[0:len((*c.CallOptions).FetchCacheUpdate):len((*c.CallOptions).FetchCacheUpdate)], opts...) |
| var resp spannerpb.Spanner_FetchCacheUpdateClient |
| err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| var err error |
| c.logger.DebugContext(ctx, "api streaming client request", "serviceName", serviceName, "rpcName", "FetchCacheUpdate") |
| resp, err = c.client.FetchCacheUpdate(ctx, req, settings.GRPC...) |
| c.logger.DebugContext(ctx, "api streaming client response", "serviceName", serviceName, "rpcName", "FetchCacheUpdate") |
| return err |
| }, opts...) |
| if err != nil { |
| return nil, err |
| } |
| return resp, nil |
| } |
| |
| // CreateSession 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’s a good idea to |
| // delete idle and unneeded sessions. |
| // Aside from explicit deletes, Cloud Spanner can delete sessions when 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, for example, "SELECT 1". |
| func (c *restClient) CreateSession(ctx context.Context, req *spannerpb.CreateSessionRequest, opts ...gax.CallOption) (*spannerpb.Session, error) { |
| m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true} |
| jsonReq, err := m.Marshal(req) |
| if err != nil { |
| return nil, err |
| } |
| |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return nil, err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v/sessions", req.GetDatabase()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "database", url.QueryEscape(req.GetDatabase()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetDatabase())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/CreateSession") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{database=projects/*/instances/*/databases/*}/sessions") |
| } |
| opts = append((*c.CallOptions).CreateSession[0:len((*c.CallOptions).CreateSession):len((*c.CallOptions).CreateSession)], opts...) |
| unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true} |
| resp := &spannerpb.Session{} |
| e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq)) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "CreateSession") |
| if err != nil { |
| return err |
| } |
| |
| if err := unm.Unmarshal(buf, resp); err != nil { |
| return err |
| } |
| |
| return nil |
| }, opts...) |
| if e != nil { |
| return nil, e |
| } |
| return resp, nil |
| } |
| |
| // BatchCreateSessions creates multiple new sessions. |
| // |
| // This API can be used to initialize a session cache on the clients. |
| // See https://goo.gl/TgSFN2 (at https://goo.gl/TgSFN2) for best practices on session cache management. |
| func (c *restClient) BatchCreateSessions(ctx context.Context, req *spannerpb.BatchCreateSessionsRequest, opts ...gax.CallOption) (*spannerpb.BatchCreateSessionsResponse, error) { |
| m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true} |
| jsonReq, err := m.Marshal(req) |
| if err != nil { |
| return nil, err |
| } |
| |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return nil, err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v/sessions:batchCreate", req.GetDatabase()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "database", url.QueryEscape(req.GetDatabase()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetDatabase())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/BatchCreateSessions") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{database=projects/*/instances/*/databases/*}/sessions:batchCreate") |
| } |
| opts = append((*c.CallOptions).BatchCreateSessions[0:len((*c.CallOptions).BatchCreateSessions):len((*c.CallOptions).BatchCreateSessions)], opts...) |
| unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true} |
| resp := &spannerpb.BatchCreateSessionsResponse{} |
| e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq)) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "BatchCreateSessions") |
| if err != nil { |
| return err |
| } |
| |
| if err := unm.Unmarshal(buf, resp); err != nil { |
| return err |
| } |
| |
| return nil |
| }, opts...) |
| if e != nil { |
| return nil, e |
| } |
| return resp, nil |
| } |
| |
| // GetSession gets a session. Returns NOT_FOUND if the session doesn’t exist. |
| // This is mainly useful for determining whether a session is still |
| // alive. |
| func (c *restClient) GetSession(ctx context.Context, req *spannerpb.GetSessionRequest, opts ...gax.CallOption) (*spannerpb.Session, error) { |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return nil, err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v", req.GetName()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetName())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/GetSession") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{name=projects/*/instances/*/databases/*/sessions/*}") |
| } |
| opts = append((*c.CallOptions).GetSession[0:len((*c.CallOptions).GetSession):len((*c.CallOptions).GetSession)], opts...) |
| unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true} |
| resp := &spannerpb.Session{} |
| e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("GET", baseUrl.String(), nil) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, nil, "GetSession") |
| if err != nil { |
| return err |
| } |
| |
| if err := unm.Unmarshal(buf, resp); err != nil { |
| return err |
| } |
| |
| return nil |
| }, opts...) |
| if e != nil { |
| return nil, e |
| } |
| return resp, nil |
| } |
| |
| // ListSessions lists all sessions in a given database. |
| func (c *restClient) ListSessions(ctx context.Context, req *spannerpb.ListSessionsRequest, opts ...gax.CallOption) *SessionIterator { |
| it := &SessionIterator{} |
| req = proto.CloneOf(req) |
| unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true} |
| it.InternalFetch = func(pageSize int, pageToken string) ([]*spannerpb.Session, string, error) { |
| resp := &spannerpb.ListSessionsResponse{} |
| if pageToken != "" { |
| req.PageToken = pageToken |
| } |
| if pageSize > math.MaxInt32 { |
| req.PageSize = math.MaxInt32 |
| } else if pageSize != 0 { |
| req.PageSize = int32(pageSize) |
| } |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return nil, "", err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v/sessions", req.GetDatabase()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| if req.GetFilter() != "" { |
| params.Add("filter", fmt.Sprintf("%v", req.GetFilter())) |
| } |
| if req.GetPageSize() != 0 { |
| params.Add("pageSize", fmt.Sprintf("%v", req.GetPageSize())) |
| } |
| if req.GetPageToken() != "" { |
| params.Add("pageToken", fmt.Sprintf("%v", req.GetPageToken())) |
| } |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := append(c.xGoogHeaders, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("GET", baseUrl.String(), nil) |
| if err != nil { |
| return err |
| } |
| httpReq.Header = headers |
| |
| buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, nil, "ListSessions") |
| if err != nil { |
| return err |
| } |
| if err := unm.Unmarshal(buf, resp); err != nil { |
| return err |
| } |
| |
| return nil |
| }, opts...) |
| if e != nil { |
| return nil, "", e |
| } |
| it.Response = resp |
| return resp.GetSessions(), resp.GetNextPageToken(), nil |
| } |
| |
| fetch := func(pageSize int, pageToken string) (string, error) { |
| items, nextPageToken, err := it.InternalFetch(pageSize, pageToken) |
| if err != nil { |
| return "", err |
| } |
| it.items = append(it.items, items...) |
| return nextPageToken, nil |
| } |
| |
| it.pageInfo, it.nextFunc = iterator.NewPageInfo(fetch, it.bufLen, it.takeBuf) |
| it.pageInfo.MaxSize = int(req.GetPageSize()) |
| it.pageInfo.Token = req.GetPageToken() |
| |
| return it |
| } |
| |
| // DeleteSession ends a session, releasing server resources associated with it. This |
| // asynchronously triggers the cancellation of any operations that are running |
| // with this session. |
| func (c *restClient) DeleteSession(ctx context.Context, req *spannerpb.DeleteSessionRequest, opts ...gax.CallOption) error { |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v", req.GetName()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetName())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/DeleteSession") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{name=projects/*/instances/*/databases/*/sessions/*}") |
| } |
| return gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("DELETE", baseUrl.String(), nil) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| _, err = executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, nil, "DeleteSession") |
| return err |
| }, opts...) |
| } |
| |
| // ExecuteSql executes an SQL statement, returning all results in a single reply. This |
| // method can’t 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. |
| // |
| // The query string can be SQL or Graph Query Language |
| // (GQL) (at https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro). |
| func (c *restClient) ExecuteSql(ctx context.Context, req *spannerpb.ExecuteSqlRequest, opts ...gax.CallOption) (*spannerpb.ResultSet, error) { |
| m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true} |
| jsonReq, err := m.Marshal(req) |
| if err != nil { |
| return nil, err |
| } |
| |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return nil, err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v:executeSql", req.GetSession()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/ExecuteSql") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{session=projects/*/instances/*/databases/*/sessions/*}:executeSql") |
| } |
| opts = append((*c.CallOptions).ExecuteSql[0:len((*c.CallOptions).ExecuteSql):len((*c.CallOptions).ExecuteSql)], opts...) |
| unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true} |
| resp := &spannerpb.ResultSet{} |
| e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq)) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "ExecuteSql") |
| if err != nil { |
| return err |
| } |
| |
| if err := unm.Unmarshal(buf, resp); err != nil { |
| return err |
| } |
| |
| return nil |
| }, opts...) |
| if e != nil { |
| return nil, e |
| } |
| return resp, nil |
| } |
| |
| // 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. However, no individual row in the |
| // result set can exceed 100 MiB, and no column value can exceed 10 MiB. |
| // |
| // The query string can be SQL or Graph Query Language |
| // (GQL) (at https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro). |
| func (c *restClient) ExecuteStreamingSql(ctx context.Context, req *spannerpb.ExecuteSqlRequest, opts ...gax.CallOption) (spannerpb.Spanner_ExecuteStreamingSqlClient, error) { |
| m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true} |
| jsonReq, err := m.Marshal(req) |
| if err != nil { |
| return nil, err |
| } |
| |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return nil, err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v:executeStreamingSql", req.GetSession()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/ExecuteStreamingSql") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{session=projects/*/instances/*/databases/*/sessions/*}:executeStreamingSql") |
| } |
| var streamClient *executeStreamingSqlRESTStreamClient |
| e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq)) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| httpRsp, err := executeStreamingHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "ExecuteStreamingSql") |
| if err != nil { |
| return err |
| } |
| |
| streamClient = &executeStreamingSqlRESTStreamClient{ |
| ctx: ctx, |
| md: metadata.MD(httpRsp.Header), |
| stream: gax.NewProtoJSONStreamReader(httpRsp.Body, (&spannerpb.PartialResultSet{}).ProtoReflect().Type()), |
| } |
| return nil |
| }, opts...) |
| |
| return streamClient, e |
| } |
| |
| // executeStreamingSqlRESTStreamClient is the stream client used to consume the server stream created by |
| // the REST implementation of ExecuteStreamingSql. |
| type executeStreamingSqlRESTStreamClient struct { |
| ctx context.Context |
| md metadata.MD |
| stream *gax.ProtoJSONStream |
| } |
| |
| func (c *executeStreamingSqlRESTStreamClient) Recv() (*spannerpb.PartialResultSet, error) { |
| if err := c.ctx.Err(); err != nil { |
| defer c.stream.Close() |
| return nil, err |
| } |
| msg, err := c.stream.Recv() |
| if err != nil { |
| defer c.stream.Close() |
| return nil, err |
| } |
| res := msg.(*spannerpb.PartialResultSet) |
| return res, nil |
| } |
| |
| func (c *executeStreamingSqlRESTStreamClient) Header() (metadata.MD, error) { |
| return c.md, nil |
| } |
| |
| func (c *executeStreamingSqlRESTStreamClient) Trailer() metadata.MD { |
| return c.md |
| } |
| |
| func (c *executeStreamingSqlRESTStreamClient) CloseSend() error { |
| // This is a no-op to fulfill the interface. |
| return errors.New("this method is not implemented for a server-stream") |
| } |
| |
| func (c *executeStreamingSqlRESTStreamClient) Context() context.Context { |
| return c.ctx |
| } |
| |
| func (c *executeStreamingSqlRESTStreamClient) SendMsg(m interface{}) error { |
| // This is a no-op to fulfill the interface. |
| return errors.New("this method is not implemented for a server-stream") |
| } |
| |
| func (c *executeStreamingSqlRESTStreamClient) RecvMsg(m interface{}) error { |
| // This is a no-op to fulfill the interface. |
| return errors.New("this method is not implemented, use Recv") |
| } |
| |
| // 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. |
| // |
| // 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. |
| func (c *restClient) ExecuteBatchDml(ctx context.Context, req *spannerpb.ExecuteBatchDmlRequest, opts ...gax.CallOption) (*spannerpb.ExecuteBatchDmlResponse, error) { |
| m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true} |
| jsonReq, err := m.Marshal(req) |
| if err != nil { |
| return nil, err |
| } |
| |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return nil, err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v:executeBatchDml", req.GetSession()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/ExecuteBatchDml") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{session=projects/*/instances/*/databases/*/sessions/*}:executeBatchDml") |
| } |
| opts = append((*c.CallOptions).ExecuteBatchDml[0:len((*c.CallOptions).ExecuteBatchDml):len((*c.CallOptions).ExecuteBatchDml)], opts...) |
| unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true} |
| resp := &spannerpb.ExecuteBatchDmlResponse{} |
| e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq)) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "ExecuteBatchDml") |
| if err != nil { |
| return err |
| } |
| |
| if err := unm.Unmarshal(buf, resp); err != nil { |
| return err |
| } |
| |
| return nil |
| }, opts...) |
| if e != nil { |
| return nil, e |
| } |
| return resp, nil |
| } |
| |
| // Read reads rows from the database using key lookups and scans, as a |
| // simple key/value style alternative to |
| // ExecuteSql. This method can’t 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. |
| func (c *restClient) Read(ctx context.Context, req *spannerpb.ReadRequest, opts ...gax.CallOption) (*spannerpb.ResultSet, error) { |
| m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true} |
| jsonReq, err := m.Marshal(req) |
| if err != nil { |
| return nil, err |
| } |
| |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return nil, err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v:read", req.GetSession()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/Read") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{session=projects/*/instances/*/databases/*/sessions/*}:read") |
| } |
| opts = append((*c.CallOptions).Read[0:len((*c.CallOptions).Read):len((*c.CallOptions).Read)], opts...) |
| unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true} |
| resp := &spannerpb.ResultSet{} |
| e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq)) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "Read") |
| if err != nil { |
| return err |
| } |
| |
| if err := unm.Unmarshal(buf, resp); err != nil { |
| return err |
| } |
| |
| return nil |
| }, opts...) |
| if e != nil { |
| return nil, e |
| } |
| return resp, nil |
| } |
| |
| // 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. |
| func (c *restClient) StreamingRead(ctx context.Context, req *spannerpb.ReadRequest, opts ...gax.CallOption) (spannerpb.Spanner_StreamingReadClient, error) { |
| m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true} |
| jsonReq, err := m.Marshal(req) |
| if err != nil { |
| return nil, err |
| } |
| |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return nil, err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v:streamingRead", req.GetSession()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/StreamingRead") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{session=projects/*/instances/*/databases/*/sessions/*}:streamingRead") |
| } |
| var streamClient *streamingReadRESTStreamClient |
| e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq)) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| httpRsp, err := executeStreamingHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "StreamingRead") |
| if err != nil { |
| return err |
| } |
| |
| streamClient = &streamingReadRESTStreamClient{ |
| ctx: ctx, |
| md: metadata.MD(httpRsp.Header), |
| stream: gax.NewProtoJSONStreamReader(httpRsp.Body, (&spannerpb.PartialResultSet{}).ProtoReflect().Type()), |
| } |
| return nil |
| }, opts...) |
| |
| return streamClient, e |
| } |
| |
| // streamingReadRESTStreamClient is the stream client used to consume the server stream created by |
| // the REST implementation of StreamingRead. |
| type streamingReadRESTStreamClient struct { |
| ctx context.Context |
| md metadata.MD |
| stream *gax.ProtoJSONStream |
| } |
| |
| func (c *streamingReadRESTStreamClient) Recv() (*spannerpb.PartialResultSet, error) { |
| if err := c.ctx.Err(); err != nil { |
| defer c.stream.Close() |
| return nil, err |
| } |
| msg, err := c.stream.Recv() |
| if err != nil { |
| defer c.stream.Close() |
| return nil, err |
| } |
| res := msg.(*spannerpb.PartialResultSet) |
| return res, nil |
| } |
| |
| func (c *streamingReadRESTStreamClient) Header() (metadata.MD, error) { |
| return c.md, nil |
| } |
| |
| func (c *streamingReadRESTStreamClient) Trailer() metadata.MD { |
| return c.md |
| } |
| |
| func (c *streamingReadRESTStreamClient) CloseSend() error { |
| // This is a no-op to fulfill the interface. |
| return errors.New("this method is not implemented for a server-stream") |
| } |
| |
| func (c *streamingReadRESTStreamClient) Context() context.Context { |
| return c.ctx |
| } |
| |
| func (c *streamingReadRESTStreamClient) SendMsg(m interface{}) error { |
| // This is a no-op to fulfill the interface. |
| return errors.New("this method is not implemented for a server-stream") |
| } |
| |
| func (c *streamingReadRESTStreamClient) RecvMsg(m interface{}) error { |
| // This is a no-op to fulfill the interface. |
| return errors.New("this method is not implemented, use Recv") |
| } |
| |
| // BeginTransaction begins a new transaction. This step can often be skipped: |
| // Read, |
| // ExecuteSql and |
| // Commit can begin a new transaction as a |
| // side-effect. |
| func (c *restClient) BeginTransaction(ctx context.Context, req *spannerpb.BeginTransactionRequest, opts ...gax.CallOption) (*spannerpb.Transaction, error) { |
| m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true} |
| jsonReq, err := m.Marshal(req) |
| if err != nil { |
| return nil, err |
| } |
| |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return nil, err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v:beginTransaction", req.GetSession()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/BeginTransaction") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{session=projects/*/instances/*/databases/*/sessions/*}:beginTransaction") |
| } |
| opts = append((*c.CallOptions).BeginTransaction[0:len((*c.CallOptions).BeginTransaction):len((*c.CallOptions).BeginTransaction)], opts...) |
| unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true} |
| resp := &spannerpb.Transaction{} |
| e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq)) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "BeginTransaction") |
| if err != nil { |
| return err |
| } |
| |
| if err := unm.Unmarshal(buf, resp); err != nil { |
| return err |
| } |
| |
| return nil |
| }, opts...) |
| if e != nil { |
| return nil, e |
| } |
| return resp, nil |
| } |
| |
| // 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 retry |
| // the transaction from the beginning, reusing 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. |
| func (c *restClient) Commit(ctx context.Context, req *spannerpb.CommitRequest, opts ...gax.CallOption) (*spannerpb.CommitResponse, error) { |
| m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true} |
| jsonReq, err := m.Marshal(req) |
| if err != nil { |
| return nil, err |
| } |
| |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return nil, err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v:commit", req.GetSession()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/Commit") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{session=projects/*/instances/*/databases/*/sessions/*}:commit") |
| } |
| opts = append((*c.CallOptions).Commit[0:len((*c.CallOptions).Commit):len((*c.CallOptions).Commit)], opts...) |
| unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true} |
| resp := &spannerpb.CommitResponse{} |
| e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq)) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "Commit") |
| if err != nil { |
| return err |
| } |
| |
| if err := unm.Unmarshal(buf, resp); err != nil { |
| return err |
| } |
| |
| return nil |
| }, opts...) |
| if e != nil { |
| return nil, e |
| } |
| return resp, nil |
| } |
| |
| // Rollback rolls back a transaction, releasing any locks it holds. It’s 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 isn’t |
| // found. Rollback never returns ABORTED. |
| func (c *restClient) Rollback(ctx context.Context, req *spannerpb.RollbackRequest, opts ...gax.CallOption) error { |
| m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true} |
| jsonReq, err := m.Marshal(req) |
| if err != nil { |
| return err |
| } |
| |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v:rollback", req.GetSession()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/Rollback") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{session=projects/*/instances/*/databases/*/sessions/*}:rollback") |
| } |
| return gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq)) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| _, err = executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "Rollback") |
| return err |
| }, opts...) |
| } |
| |
| // 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 isn’t possible to resume the query, and |
| // the whole operation must be restarted from the beginning. |
| func (c *restClient) PartitionQuery(ctx context.Context, req *spannerpb.PartitionQueryRequest, opts ...gax.CallOption) (*spannerpb.PartitionResponse, error) { |
| m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true} |
| jsonReq, err := m.Marshal(req) |
| if err != nil { |
| return nil, err |
| } |
| |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return nil, err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v:partitionQuery", req.GetSession()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/PartitionQuery") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{session=projects/*/instances/*/databases/*/sessions/*}:partitionQuery") |
| } |
| opts = append((*c.CallOptions).PartitionQuery[0:len((*c.CallOptions).PartitionQuery):len((*c.CallOptions).PartitionQuery)], opts...) |
| unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true} |
| resp := &spannerpb.PartitionResponse{} |
| e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq)) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "PartitionQuery") |
| if err != nil { |
| return err |
| } |
| |
| if err := unm.Unmarshal(buf, resp); err != nil { |
| return err |
| } |
| |
| return nil |
| }, opts...) |
| if e != nil { |
| return nil, e |
| } |
| return resp, nil |
| } |
| |
| // 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 isn’t possible to resume the read, and |
| // the whole operation must be restarted from the beginning. |
| func (c *restClient) PartitionRead(ctx context.Context, req *spannerpb.PartitionReadRequest, opts ...gax.CallOption) (*spannerpb.PartitionResponse, error) { |
| m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true} |
| jsonReq, err := m.Marshal(req) |
| if err != nil { |
| return nil, err |
| } |
| |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return nil, err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v:partitionRead", req.GetSession()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/PartitionRead") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{session=projects/*/instances/*/databases/*/sessions/*}:partitionRead") |
| } |
| opts = append((*c.CallOptions).PartitionRead[0:len((*c.CallOptions).PartitionRead):len((*c.CallOptions).PartitionRead)], opts...) |
| unm := protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true} |
| resp := &spannerpb.PartitionResponse{} |
| e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq)) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| buf, err := executeHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "PartitionRead") |
| if err != nil { |
| return err |
| } |
| |
| if err := unm.Unmarshal(buf, resp); err != nil { |
| return err |
| } |
| |
| return nil |
| }, opts...) |
| if e != nil { |
| return nil, e |
| } |
| return resp, nil |
| } |
| |
| // BatchWrite batches the supplied mutation groups in a collection of efficient |
| // transactions. All mutations in a group are committed atomically. However, |
| // mutations across groups can be committed non-atomically in an unspecified |
| // order and thus, they must be independent of each other. Partial failure is |
| // possible, that is, some groups might have been committed successfully, |
| // while some might have failed. The results of individual batches are |
| // streamed into the response as the batches are applied. |
| // |
| // BatchWrite requests are not replay protected, meaning that each mutation |
| // group can be applied more than once. Replays of non-idempotent mutations |
| // can have undesirable effects. For example, replays of an insert mutation |
| // can produce an already exists error or if you use generated or commit |
| // timestamp-based keys, it can result in additional rows being added to the |
| // mutation’s table. We recommend structuring your mutation groups to be |
| // idempotent to avoid this issue. |
| func (c *restClient) BatchWrite(ctx context.Context, req *spannerpb.BatchWriteRequest, opts ...gax.CallOption) (spannerpb.Spanner_BatchWriteClient, error) { |
| m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true} |
| jsonReq, err := m.Marshal(req) |
| if err != nil { |
| return nil, err |
| } |
| |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return nil, err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v:batchWrite", req.GetSession()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "session", url.QueryEscape(req.GetSession()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetSession())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/BatchWrite") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{session=projects/*/instances/*/databases/*/sessions/*}:batchWrite") |
| } |
| var streamClient *batchWriteRESTStreamClient |
| e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq)) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| httpRsp, err := executeStreamingHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "BatchWrite") |
| if err != nil { |
| return err |
| } |
| |
| streamClient = &batchWriteRESTStreamClient{ |
| ctx: ctx, |
| md: metadata.MD(httpRsp.Header), |
| stream: gax.NewProtoJSONStreamReader(httpRsp.Body, (&spannerpb.BatchWriteResponse{}).ProtoReflect().Type()), |
| } |
| return nil |
| }, opts...) |
| |
| return streamClient, e |
| } |
| |
| // batchWriteRESTStreamClient is the stream client used to consume the server stream created by |
| // the REST implementation of BatchWrite. |
| type batchWriteRESTStreamClient struct { |
| ctx context.Context |
| md metadata.MD |
| stream *gax.ProtoJSONStream |
| } |
| |
| func (c *batchWriteRESTStreamClient) Recv() (*spannerpb.BatchWriteResponse, error) { |
| if err := c.ctx.Err(); err != nil { |
| defer c.stream.Close() |
| return nil, err |
| } |
| msg, err := c.stream.Recv() |
| if err != nil { |
| defer c.stream.Close() |
| return nil, err |
| } |
| res := msg.(*spannerpb.BatchWriteResponse) |
| return res, nil |
| } |
| |
| func (c *batchWriteRESTStreamClient) Header() (metadata.MD, error) { |
| return c.md, nil |
| } |
| |
| func (c *batchWriteRESTStreamClient) Trailer() metadata.MD { |
| return c.md |
| } |
| |
| func (c *batchWriteRESTStreamClient) CloseSend() error { |
| // This is a no-op to fulfill the interface. |
| return errors.New("this method is not implemented for a server-stream") |
| } |
| |
| func (c *batchWriteRESTStreamClient) Context() context.Context { |
| return c.ctx |
| } |
| |
| func (c *batchWriteRESTStreamClient) SendMsg(m interface{}) error { |
| // This is a no-op to fulfill the interface. |
| return errors.New("this method is not implemented for a server-stream") |
| } |
| |
| func (c *batchWriteRESTStreamClient) RecvMsg(m interface{}) error { |
| // This is a no-op to fulfill the interface. |
| return errors.New("this method is not implemented, use Recv") |
| } |
| |
| // FetchCacheUpdate retrieves a cache update for a given database. |
| // |
| // This RPC can be used to warm up the client cache by fetching key recipes |
| // and server information for a given database. It is recommended to call |
| // this RPC at the beginning of the client’s lifecycle, prior to any other |
| // data plane operations. |
| // |
| // The cache update is returned as a stream because the response can be too |
| // large to fit into a single CacheUpdate message. |
| func (c *restClient) FetchCacheUpdate(ctx context.Context, req *spannerpb.FetchCacheUpdateRequest, opts ...gax.CallOption) (spannerpb.Spanner_FetchCacheUpdateClient, error) { |
| m := protojson.MarshalOptions{AllowPartial: true, UseEnumNumbers: true} |
| jsonReq, err := m.Marshal(req) |
| if err != nil { |
| return nil, err |
| } |
| |
| baseUrl, err := url.Parse(c.endpoint) |
| if err != nil { |
| return nil, err |
| } |
| baseUrl.Path += fmt.Sprintf("/v1/%v:cacheUpdate", req.GetDatabase()) |
| |
| params := url.Values{} |
| params.Add("$alt", "json;enum-encoding=int") |
| |
| baseUrl.RawQuery = params.Encode() |
| |
| // Build HTTP headers from client and context metadata. |
| hds := []string{"x-goog-request-params", fmt.Sprintf("%s=%v", "database", url.QueryEscape(req.GetDatabase()))} |
| |
| hds = append(c.xGoogHeaders, hds...) |
| hds = append(hds, "Content-Type", "application/json") |
| headers := gax.BuildHeaders(ctx, hds...) |
| if gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "resource_name", fmt.Sprintf("//spanner.googleapis.com/%v", req.GetDatabase())) |
| } |
| if gax.IsFeatureEnabled("METRICS") || gax.IsFeatureEnabled("TRACING") || gax.IsFeatureEnabled("LOGGING") { |
| ctx = callctx.WithTelemetryContext(ctx, "rpc_method", "google.spanner.v1.Spanner/FetchCacheUpdate") |
| ctx = callctx.WithTelemetryContext(ctx, "url_template", "/v1/{database=projects/*/instances/*/databases/*}:cacheUpdate") |
| } |
| var streamClient *fetchCacheUpdateRESTStreamClient |
| e := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { |
| if settings.Path != "" { |
| baseUrl.Path = settings.Path |
| } |
| httpReq, err := http.NewRequest("POST", baseUrl.String(), bytes.NewReader(jsonReq)) |
| if err != nil { |
| return err |
| } |
| httpReq = httpReq.WithContext(ctx) |
| httpReq.Header = headers |
| |
| httpRsp, err := executeStreamingHTTPRequest(ctx, c.httpClient, httpReq, c.logger, jsonReq, "FetchCacheUpdate") |
| if err != nil { |
| return err |
| } |
| |
| streamClient = &fetchCacheUpdateRESTStreamClient{ |
| ctx: ctx, |
| md: metadata.MD(httpRsp.Header), |
| stream: gax.NewProtoJSONStreamReader(httpRsp.Body, (&spannerpb.CacheUpdate{}).ProtoReflect().Type()), |
| } |
| return nil |
| }, opts...) |
| |
| return streamClient, e |
| } |
| |
| // fetchCacheUpdateRESTStreamClient is the stream client used to consume the server stream created by |
| // the REST implementation of FetchCacheUpdate. |
| type fetchCacheUpdateRESTStreamClient struct { |
| ctx context.Context |
| md metadata.MD |
| stream *gax.ProtoJSONStream |
| } |
| |
| func (c *fetchCacheUpdateRESTStreamClient) Recv() (*spannerpb.CacheUpdate, error) { |
| if err := c.ctx.Err(); err != nil { |
| defer c.stream.Close() |
| return nil, err |
| } |
| msg, err := c.stream.Recv() |
| if err != nil { |
| defer c.stream.Close() |
| return nil, err |
| } |
| res := msg.(*spannerpb.CacheUpdate) |
| return res, nil |
| } |
| |
| func (c *fetchCacheUpdateRESTStreamClient) Header() (metadata.MD, error) { |
| return c.md, nil |
| } |
| |
| func (c *fetchCacheUpdateRESTStreamClient) Trailer() metadata.MD { |
| return c.md |
| } |
| |
| func (c *fetchCacheUpdateRESTStreamClient) CloseSend() error { |
| // This is a no-op to fulfill the interface. |
| return errors.New("this method is not implemented for a server-stream") |
| } |
| |
| func (c *fetchCacheUpdateRESTStreamClient) Context() context.Context { |
| return c.ctx |
| } |
| |
| func (c *fetchCacheUpdateRESTStreamClient) SendMsg(m interface{}) error { |
| // This is a no-op to fulfill the interface. |
| return errors.New("this method is not implemented for a server-stream") |
| } |
| |
| func (c *fetchCacheUpdateRESTStreamClient) RecvMsg(m interface{}) error { |
| // This is a no-op to fulfill the interface. |
| return errors.New("this method is not implemented, use Recv") |
| } |