spanner

package

v1.0.8 Latest Latest Go to latest Published: Mar 4, 2025 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation ¶

Index ¶

Constants
Variables
type ErrorInfo
type FilterBatchResponse
type SpannerClient
type SpannerClientIface
type SystemQueryMetadataCache

Constants ¶

const (
	InsertUpdateOrDeleteStatement = "Calling DML Statement"
	InsertOrUpdateMutation        = "Calling Insert or Update Using Mutations"
	DeleteUsingMutations          = "Calling Delete Using Mutations"
	FilterAndExecuteBatch         = "Filter And Execute Batch"
)

View Source

const (
	CommitAPI              = "Commit"
	ExecuteBatchDMLAPI     = "ExecuteBatchDML"
	ExecuteStreamingSqlAPI = "ExecuteStreamingSql"
	UnknownOrMixedAPI      = ""
)

Variables ¶

View Source

var NewSpannerClient = func(client *spanner.Client, logger *zap.Logger, responseHandler *responsehandler.TypeHandler, keyspaceFlatter bool, maxCommitDelay uint64, replayProtection bool) SpannerClientIface {
	return &SpannerClient{
		Client:           client,
		Logger:           logger,
		ResponseHandler:  responseHandler,
		KeyspaceFlatter:  keyspaceFlatter,
		MaxCommitDelay:   maxCommitDelay,
		ReplayProtection: replayProtection,
	}
}

Functions ¶

This section is empty.

Types ¶

type ErrorInfo ¶

type ErrorInfo struct {
	Query string `json:"query"`
	Error string `json:"error"`
}

type FilterBatchResponse ¶

type FilterBatchResponse struct {
	Queries               []*responsehandler.QueryMetadata // Filtered batch queries
	CanExecuteAsBatch     bool                             // This flag is used to run all queries in sequence when batch contains map update by key
	OnlyInserts           bool                             // This flag is used to run all queries as mutations when only INSERTS are available in the batch
	CanExecuteAsMutations bool                             // This flag is used to run all queries as mutations when only INSERTS are available in the batch
}

Response struct of filterBatch function

type SpannerClient ¶

type SpannerClient struct {
	Client           *spanner.Client
	Logger           *zap.Logger
	ResponseHandler  *responsehandler.TypeHandler
	KeyspaceFlatter  bool
	MaxCommitDelay   uint64
	ReplayProtection bool
}

func (*SpannerClient) BuildCommitOptions ¶

func (sc *SpannerClient) BuildCommitOptions() spanner.CommitOptions

BuildCommitOptions returns the commit options for Spanner transactions.

func (*SpannerClient) Close ¶

func (sc *SpannerClient) Close() error

Close - Close the spanner client

func (*SpannerClient) DeleteUsingMutations ¶

func (sc *SpannerClient) DeleteUsingMutations(ctx context.Context, query responsehandler.QueryMetadata) (*message.RowsResult, string, error)

func (*SpannerClient) FilterAndExecuteBatch ¶

func (sc *SpannerClient) FilterAndExecuteBatch(ctx context.Context, queries []*responsehandler.QueryMetadata) (*message.VoidResult, string, error)

func (*SpannerClient) GetTableConfigs ¶

func (sc *SpannerClient) GetTableConfigs(ctx context.Context, query responsehandler.QueryMetadata) (map[string]map[string]*tableConfig.Column, map[string][]tableConfig.Column, *SystemQueryMetadataCache, error)

GetTableConfigs - Get Table config from Spanner.

Parameters:

ctx: Context.
query: query metadata.

Returns: []tableConfig.TableMetaData (metadata of each table) and error.

func (*SpannerClient) InsertMutation ¶

func (sc *SpannerClient) InsertMutation(ctx context.Context, query responsehandler.QueryMetadata) (*message.RowsResult, string, error)

InsertOrUpdateMutation - Handle Insert Operation

Parameters:

ctx: Context.
query: query metadata.