operation

Documentation

Overview

Example (ListOperations)

ctx := context.TODO()
db, err := ydb.Open(ctx, "grpc://localhost:2136/local")
if err != nil {
	panic(err)
}
defer db.Close(ctx) // cleanup resources
var nextToken string
for i := 0; ; i++ {
	operations, err := db.Operation().List(ctx, "buildindex",
		operation.WithPageSize(10),
		operation.WithPageToken(nextToken),
	)
	if err != nil {
		panic(err)
	}
	nextToken = operations.NextToken
	fmt.Printf("page#%d. operations:\n", i)
	for _, op := range operations.Operations {
		fmt.Println(" -", op)
	}
	if len(operations.Operations) == 0 {
		break
	}
}

Index

• func WithPageSize(pageSize uint64) options.List
• func WithPageToken(pageToken string) options.List
• type Client
  • func New(ctx context.Context, balancer grpc.ClientConnInterface) *Client
  • func (c *Client) Cancel(ctx context.Context, opID string) error
  • func (c *Client) Close(ctx context.Context) error
  • func (c *Client) Forget(ctx context.Context, opID string) error
  • func (c *Client) Get(ctx context.Context, opID string) (*Operation, error)
  • func (c *Client) List(ctx context.Context, kind string, opts ...options.List) (*ListOperations, error)
• type ListOperations
• type Operation

Examples

• Package (ListOperations)

Functions

func WithPageSize

func WithPageSize(pageSize uint64) options.List

func WithPageToken

func WithPageToken(pageToken string) options.List

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is an operation service client for manage long operations in YDB

Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental

func New

func New(ctx context.Context, balancer grpc.ClientConnInterface) *Client

func (*Client) Cancel

func (c *Client) Cancel(ctx context.Context, opID string) error

Cancel starts cancellation of a long-running operation.

Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental

func (*Client) Close

func (c *Client) Close(ctx context.Context) error

func (*Client) Forget

func (c *Client) Forget(ctx context.Context, opID string) error

Forget forgets long-running operation. It does not cancel the operation and returns an error if operation was not completed.

Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental

func (*Client) Get

func (c *Client) Get(ctx context.Context, opID string) (*Operation, error)

Get returns operation status by ID

Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental

func (*Client) List

func (c *Client) List(ctx context.Context, kind string, opts ...options.List) (*ListOperations, error)

List returns list of operations that match the specified filter in the request.

Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental

type ListOperations

type ListOperations struct {
	NextToken  string
	Operations []*Operation
}

type Operation

type Operation struct {
	ID            string
	Ready         bool
	Status        string
	ConsumedUnits float64
}

Operation describes operation

Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental