Cloud Spanner Executor test API v1 - Package cloud.google.com/go/spanner/executor/apiv1 (v1.54.0)

Package executor is an auto-generated package for the Cloud Spanner Executor test API.

Stop. This folder is likely not what you are looking for. This folder contains protocol buffer definitions for test-only API for Cloud Spanner clients. Unless told otherwise by a Google Cloud representative, do not use any of the contents of this folder. If you would like to use Cloud Spanner, please consult our official documentation (at https://cloud.google.com/spanner/docs/apis) for details on our APIs, or else consider one of our client libraries (at https://cloud.google.com/spanner/docs/reference/libraries). This API defined in this folder is unreleased and may shut off, break, or fail at any time for any users who are not registered as a part of a private preview program.

NOTE: This package is in beta. It is not stable, and may be subject to changes.

General documentation

For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:

Example usage

To get started with this package, create a client.

ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := executor.NewSpannerExecutorProxyClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client.

ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := executor.NewSpannerExecutorProxyClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()
stream, err := c.ExecuteActionAsync(ctx)
if err != nil {
    // TODO: Handle error.
}
go func() {
    reqs := []*executorpb.SpannerAsyncActionRequest{
        // TODO: Create requests.
    }
    for _, req := range reqs {
        if err := stream.Send(req); err != nil {
            // TODO: Handle error.
        }
    }
    stream.CloseSend()
}()
for {
    resp, err := stream.Recv()
    if err == io.EOF {
        break
    }
    if err != nil {
        // TODO: handle error.
    }
    // TODO: Use resp.
    _ = resp
}

Use of Context

The ctx passed to NewSpannerExecutorProxyClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

SpannerExecutorProxyCallOptions

type SpannerExecutorProxyCallOptions struct {
	ExecuteActionAsync []gax.CallOption
}

SpannerExecutorProxyCallOptions contains the retry settings for each method of SpannerExecutorProxyClient.

SpannerExecutorProxyClient

type SpannerExecutorProxyClient struct {

	// The call options for this service.
	CallOptions *SpannerExecutorProxyCallOptions
	// contains filtered or unexported fields
}

SpannerExecutorProxyClient is a client for interacting with Cloud Spanner Executor test API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service that executes SpannerActions asynchronously.

func NewSpannerExecutorProxyClient

func NewSpannerExecutorProxyClient(ctx context.Context, opts ...option.ClientOption) (*SpannerExecutorProxyClient, error)

NewSpannerExecutorProxyClient creates a new spanner executor proxy client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service that executes SpannerActions asynchronously.

Example

package main

import (
	"context"

	executor "cloud.google.com/go/spanner/executor/apiv1"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := executor.NewSpannerExecutorProxyClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*SpannerExecutorProxyClient) Close

func (c *SpannerExecutorProxyClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*SpannerExecutorProxyClient) Connection (deprecated)

func (c *SpannerExecutorProxyClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not always return the same resource.

func (*SpannerExecutorProxyClient) ExecuteActionAsync

ExecuteActionAsync executeActionAsync is a streaming call that starts executing a new Spanner action.

For each request, the server will reply with one or more responses, but only the last response will contain status in the outcome.

Responses can be matched to requests by action_id. It is allowed to have multiple actions in flight–in that case, actions are be executed in parallel.

Example

package main

import (
	"context"
	"io"

	executor "cloud.google.com/go/spanner/executor/apiv1"
	executorpb "cloud.google.com/go/spanner/executor/apiv1/executorpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := executor.NewSpannerExecutorProxyClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()
	stream, err := c.ExecuteActionAsync(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	go func() {
		reqs := []*executorpb.SpannerAsyncActionRequest{
			// TODO: Create requests.
		}
		for _, req := range reqs {
			if err := stream.Send(req); err != nil {
				// TODO: Handle error.
			}
		}
		stream.CloseSend()
	}()
	for {
		resp, err := stream.Recv()
		if err == io.EOF {
			break
		}
		if err != nil {
			// TODO: handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}