trace

package
v3.27.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 20, 2022 License: Apache-2.0 Imports: 6 Imported by: 19

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ClearContext

func ClearContext(x interface{}) interface{}

func DiscoveryOnDiscover added in v3.10.0

func DiscoveryOnDiscover(t Discovery, c *context.Context, address string, database string) func(location string, endpoints []EndpointInfo, _ error)

func DiscoveryOnWhoAmI added in v3.10.0

func DiscoveryOnWhoAmI(t Discovery, c *context.Context) func(user string, groups []string, _ error)

func DriverOnBalancerChooseEndpoint added in v3.26.0

func DriverOnBalancerChooseEndpoint(t Driver, c *context.Context) func(endpoint EndpointInfo, _ error)

func DriverOnBalancerClose added in v3.26.0

func DriverOnBalancerClose(t Driver, c *context.Context) func(error)

func DriverOnBalancerInit added in v3.26.0

func DriverOnBalancerInit(t Driver, c *context.Context) func(error)

func DriverOnBalancerUpdate added in v3.26.0

func DriverOnBalancerUpdate(t Driver, c *context.Context, needLocalDC bool) func(endpoints []EndpointInfo, localDC string, _ error)

func DriverOnClose added in v3.5.0

func DriverOnClose(t Driver, c *context.Context) func(error)

func DriverOnConnAllow added in v3.25.1

func DriverOnConnAllow(t Driver, c *context.Context, endpoint EndpointInfo, state ConnState) func(state ConnState)

func DriverOnConnBan added in v3.25.1

func DriverOnConnBan(t Driver, c *context.Context, endpoint EndpointInfo, state ConnState, cause error) func(state ConnState)

func DriverOnConnClose added in v3.12.1

func DriverOnConnClose(t Driver, c *context.Context, endpoint EndpointInfo) func(error)

func DriverOnConnInvoke

func DriverOnConnInvoke(t Driver, c *context.Context, endpoint EndpointInfo, m Method) func(_ error, issues []Issue, opID string, state ConnState)

func DriverOnConnNewStream

func DriverOnConnNewStream(t Driver, c *context.Context, endpoint EndpointInfo, m Method) func(error) func(state ConnState, _ error)

func DriverOnConnPark added in v3.12.1

func DriverOnConnPark(t Driver, c *context.Context, endpoint EndpointInfo) func(error)

func DriverOnConnStateChange

func DriverOnConnStateChange(t Driver, endpoint EndpointInfo, state ConnState) func(state ConnState)

func DriverOnConnTake

func DriverOnConnTake(t Driver, c *context.Context, endpoint EndpointInfo) func(error)

func DriverOnGetCredentials

func DriverOnGetCredentials(t Driver, c *context.Context) func(token string, _ error)

func DriverOnInit added in v3.5.0

func DriverOnInit(t Driver, c *context.Context, endpoint string, database string, secure bool) func(error)

func DriverOnNetClose

func DriverOnNetClose(t Driver, address string) func(error)

func DriverOnNetDial

func DriverOnNetDial(t Driver, c *context.Context, address string) func(error)

func DriverOnNetRead

func DriverOnNetRead(t Driver, address string, buffer int) func(received int, _ error)

func DriverOnNetWrite

func DriverOnNetWrite(t Driver, address string, bytes int) func(sent int, _ error)

func DriverOnRepeaterWakeUp added in v3.11.13

func DriverOnRepeaterWakeUp(t Driver, c *context.Context, name string, event string) func(error)

func DriverOnResolve added in v3.11.0

func DriverOnResolve(t Driver, target string, resolved []string) func(error)

func RetryOnRetry

func RetryOnRetry(t Retry, c *context.Context, iD string, idempotent bool) func(error) func(attempts int, _ error)

func ScriptingOnClose added in v3.13.1

func ScriptingOnClose(t Scripting, c *context.Context) func(error)

func ScriptingOnExecute added in v3.10.0

func ScriptingOnExecute(t Scripting, c *context.Context, query string, parameters scriptingQueryParameters) func(result scriptingResult, _ error)

func ScriptingOnExplain added in v3.10.0

func ScriptingOnExplain(t Scripting, c *context.Context, query string) func(plan string, _ error)

func ScriptingOnStreamExecute added in v3.10.0

func ScriptingOnStreamExecute(t Scripting, c *context.Context, query string, parameters scriptingQueryParameters) func(error) func(error)

func Stub

func Stub(x interface{}, f func(name string, args ...interface{}))

Stub is a helper function that stubs all functional fields of x with given f.

func TableOnClose added in v3.13.1

func TableOnClose(t Table, c *context.Context) func(error)

func TableOnCreateSession added in v3.15.0

func TableOnCreateSession(t Table, c *context.Context) func(error) func(session tableSessionInfo, attempts int, _ error)

func TableOnDo added in v3.15.0

func TableOnDo(t Table, c *context.Context, idempotent bool) func(error) func(attempts int, _ error)

func TableOnDoTx added in v3.15.0

func TableOnDoTx(t Table, c *context.Context, idempotent bool) func(error) func(attempts int, _ error)

func TableOnInit added in v3.13.1

func TableOnInit(t Table, c *context.Context) func(limit int, keepAliveMinSize int)

func TableOnPoolGet

func TableOnPoolGet(t Table, c *context.Context) func(session tableSessionInfo, attempts int, _ error)

func TableOnPoolPut

func TableOnPoolPut(t Table, c *context.Context, session tableSessionInfo) func(error)

func TableOnPoolSessionClose

func TableOnPoolSessionClose(t Table, c *context.Context, session tableSessionInfo) func()

func TableOnPoolSessionNew

func TableOnPoolSessionNew(t Table, c *context.Context) func(session tableSessionInfo, _ error)

func TableOnPoolStateChange added in v3.11.0

func TableOnPoolStateChange(t Table, size int, event string)

func TableOnPoolWait

func TableOnPoolWait(t Table, c *context.Context) func(session tableSessionInfo, _ error)

func TableOnSessionDelete

func TableOnSessionDelete(t Table, c *context.Context, session tableSessionInfo) func(error)

func TableOnSessionKeepAlive

func TableOnSessionKeepAlive(t Table, c *context.Context, session tableSessionInfo) func(error)

func TableOnSessionNew

func TableOnSessionNew(t Table, c *context.Context) func(session tableSessionInfo, _ error)

func TableOnSessionQueryExecute

func TableOnSessionQueryExecute(t Table, c *context.Context, session tableSessionInfo, query tableDataQuery, parameters tableQueryParameters) func(tx tableTransactionInfo, prepared bool, result tableResult, _ error)

func TableOnSessionQueryExplain added in v3.10.0

func TableOnSessionQueryExplain(t Table, c *context.Context, session tableSessionInfo, query string) func(aST string, plan string, _ error)

func TableOnSessionQueryPrepare

func TableOnSessionQueryPrepare(t Table, c *context.Context, session tableSessionInfo, query string) func(result tableDataQuery, _ error)

func TableOnSessionQueryStreamExecute

func TableOnSessionQueryStreamExecute(t Table, c *context.Context, session tableSessionInfo, query tableDataQuery, parameters tableQueryParameters) func(error) func(error)

func TableOnSessionQueryStreamRead

func TableOnSessionQueryStreamRead(t Table, c *context.Context, session tableSessionInfo) func(error) func(error)

func TableOnSessionTransactionBegin

func TableOnSessionTransactionBegin(t Table, c *context.Context, session tableSessionInfo) func(tx tableTransactionInfo, _ error)

func TableOnSessionTransactionCommit

func TableOnSessionTransactionCommit(t Table, c *context.Context, session tableSessionInfo, tx tableTransactionInfo) func(error)

func TableOnSessionTransactionRollback

func TableOnSessionTransactionRollback(t Table, c *context.Context, session tableSessionInfo, tx tableTransactionInfo) func(error)

func WithDefaultDetails added in v3.11.0

func WithDefaultDetails(defaultDetails Details) matchDetailsOption

func WithPOSIXMatch added in v3.11.0

func WithPOSIXMatch() matchDetailsOption

Types

type ConnState

type ConnState interface {
	fmt.Stringer

	IsValid() bool
	Code() int
}

type Coordination added in v3.10.0

type Coordination struct{}

Coordination specified trace of coordination client activity. gtrace:gen

func (Coordination) Compose added in v3.10.0

Compose returns a new Coordination which has functional fields composed both from t and x.

type CoordinationComposeOption added in v3.17.0

type CoordinationComposeOption func(o *coordinationComposeOptions)

CoordinationOption specified Coordination compose option

func WithCoordinationPanicCallback added in v3.17.0

func WithCoordinationPanicCallback(cb func(e interface{})) CoordinationComposeOption

WithCoordinationPanicCallback specified behavior on panic

type Details added in v3.2.1

type Details uint64
const (
	DriverNetEvents         Details = 1 << iota // 1
	DriverConnEvents                            // 2
	DriverBalancerEvents                        // 4
	DriverResolverEvents                        // 8
	DriverRepeaterEvents                        // 16
	DriverCredentialsEvents                     // 32

	TableSessionLifeCycleEvents     // 64
	TableSessionQueryInvokeEvents   // 128
	TableSessionQueryStreamEvents   // 256
	TableSessionTransactionEvents   // 512
	TablePoolLifeCycleEvents        // 1024
	TablePoolSessionLifeCycleEvents // 2048
	TablePoolAPIEvents              // 4096

	RetryEvents // 8192

	DiscoveryEvents // 16384

	SchemeEvents // 32768

	ScriptingEvents // 65536

	RatelimiterEvents // 131072

	CoordinationEvents // 262144

	// Deprecated: has no effect now
	DriverClusterEvents

	DriverEvents = DriverNetEvents |
		DriverConnEvents |
		DriverBalancerEvents |
		DriverResolverEvents |
		DriverRepeaterEvents |
		DriverCredentialsEvents // 63

	TableEvents = TableSessionLifeCycleEvents |
		TableSessionQueryInvokeEvents |
		TableSessionQueryStreamEvents |
		TableSessionTransactionEvents |
		TablePoolLifeCycleEvents |
		TablePoolSessionLifeCycleEvents |
		TablePoolAPIEvents // 16320

	TablePoolEvents = TablePoolLifeCycleEvents |
		TablePoolSessionLifeCycleEvents |
		TablePoolAPIEvents // 15360

	TableSessionQueryEvents = TableSessionQueryInvokeEvents |
		TableSessionQueryStreamEvents // 384
	TableSessionEvents = TableSessionLifeCycleEvents |
		TableSessionQueryEvents |
		TableSessionTransactionEvents // 960

	DetailsAll = ^Details(0) // 18446744073709551615
)

func MatchDetails added in v3.11.0

func MatchDetails(pattern string, opts ...matchDetailsOption) (d Details)

type Discovery added in v3.10.0

type Discovery struct {
	OnDiscover func(DiscoveryDiscoverStartInfo) func(DiscoveryDiscoverDoneInfo)
	OnWhoAmI   func(DiscoveryWhoAmIStartInfo) func(DiscoveryWhoAmIDoneInfo)
}

Discovery specified trace of discovery client activity. gtrace:gen

func (Discovery) Compose added in v3.10.0

func (t Discovery) Compose(x Discovery, opts ...DiscoveryComposeOption) (ret Discovery)

Compose returns a new Discovery which has functional fields composed both from t and x.

type DiscoveryComposeOption added in v3.17.0

type DiscoveryComposeOption func(o *discoveryComposeOptions)

DiscoveryOption specified Discovery compose option

func WithDiscoveryPanicCallback added in v3.17.0

func WithDiscoveryPanicCallback(cb func(e interface{})) DiscoveryComposeOption

WithDiscoveryPanicCallback specified behavior on panic

type DiscoveryDiscoverDoneInfo added in v3.15.0

type DiscoveryDiscoverDoneInfo struct {
	Location  string
	Endpoints []EndpointInfo
	Error     error
}

type DiscoveryDiscoverStartInfo added in v3.15.0

type DiscoveryDiscoverStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context  *context.Context
	Address  string
	Database string
}

type DiscoveryWhoAmIDoneInfo added in v3.15.0

type DiscoveryWhoAmIDoneInfo struct {
	User   string
	Groups []string
	Error  error
}

type DiscoveryWhoAmIStartInfo added in v3.15.0

type DiscoveryWhoAmIStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
}

type Driver

type Driver struct {
	// Driver runtime events
	OnInit  func(DriverInitStartInfo) func(DriverInitDoneInfo)
	OnClose func(DriverCloseStartInfo) func(DriverCloseDoneInfo)

	// Network events
	OnNetRead  func(DriverNetReadStartInfo) func(DriverNetReadDoneInfo)
	OnNetWrite func(DriverNetWriteStartInfo) func(DriverNetWriteDoneInfo)
	OnNetDial  func(DriverNetDialStartInfo) func(DriverNetDialDoneInfo)
	OnNetClose func(DriverNetCloseStartInfo) func(DriverNetCloseDoneInfo)

	// Resolver events
	OnResolve func(DriverResolveStartInfo) func(DriverResolveDoneInfo)

	// Conn events
	OnConnStateChange func(DriverConnStateChangeStartInfo) func(DriverConnStateChangeDoneInfo)
	OnConnInvoke      func(DriverConnInvokeStartInfo) func(DriverConnInvokeDoneInfo)
	OnConnNewStream   func(
		DriverConnNewStreamStartInfo,
	) func(
		DriverConnNewStreamRecvInfo,
	) func(
		DriverConnNewStreamDoneInfo,
	)
	OnConnTake  func(DriverConnTakeStartInfo) func(DriverConnTakeDoneInfo)
	OnConnPark  func(DriverConnParkStartInfo) func(DriverConnParkDoneInfo)
	OnConnBan   func(DriverConnBanStartInfo) func(DriverConnBanDoneInfo)
	OnConnAllow func(DriverConnAllowStartInfo) func(DriverConnAllowDoneInfo)
	OnConnClose func(DriverConnCloseStartInfo) func(DriverConnCloseDoneInfo)

	// Repeater events
	OnRepeaterWakeUp func(DriverRepeaterWakeUpStartInfo) func(DriverRepeaterWakeUpDoneInfo)

	// Balancer events
	OnBalancerInit           func(DriverBalancerInitStartInfo) func(DriverBalancerInitDoneInfo)
	OnBalancerClose          func(DriverBalancerCloseStartInfo) func(DriverBalancerCloseDoneInfo)
	OnBalancerChooseEndpoint func(DriverBalancerChooseEndpointStartInfo) func(DriverBalancerChooseEndpointDoneInfo)
	OnBalancerUpdate         func(DriverBalancerUpdateStartInfo) func(DriverBalancerUpdateDoneInfo)

	// Credentials events
	OnGetCredentials func(DriverGetCredentialsStartInfo) func(DriverGetCredentialsDoneInfo)
}

Driver specified trace of common driver activity. gtrace:gen

func (Driver) Compose

func (t Driver) Compose(x Driver, opts ...DriverComposeOption) (ret Driver)

Compose returns a new Driver which has functional fields composed both from t and x.

type DriverBalancerChooseEndpointDoneInfo added in v3.26.0

type DriverBalancerChooseEndpointDoneInfo struct {
	Endpoint EndpointInfo
	Error    error
}

type DriverBalancerChooseEndpointStartInfo added in v3.26.0

type DriverBalancerChooseEndpointStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
}

type DriverBalancerCloseDoneInfo added in v3.26.0

type DriverBalancerCloseDoneInfo struct {
	Error error
}

type DriverBalancerCloseStartInfo added in v3.26.0

type DriverBalancerCloseStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
}

type DriverBalancerInitDoneInfo added in v3.26.0

type DriverBalancerInitDoneInfo struct {
	Error error
}

type DriverBalancerInitStartInfo added in v3.26.0

type DriverBalancerInitStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
}

type DriverBalancerUpdateDoneInfo added in v3.26.0

type DriverBalancerUpdateDoneInfo struct {
	Endpoints []EndpointInfo
	LocalDC   string
	Error     error
}

type DriverBalancerUpdateStartInfo added in v3.26.0

type DriverBalancerUpdateStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context     *context.Context
	NeedLocalDC bool
}

type DriverCloseDoneInfo added in v3.15.0

type DriverCloseDoneInfo struct {
	Error error
}

type DriverCloseStartInfo added in v3.15.0

type DriverCloseStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
}

type DriverComposeOption added in v3.17.0

type DriverComposeOption func(o *driverComposeOptions)

DriverOption specified Driver compose option

func WithDriverPanicCallback added in v3.17.0

func WithDriverPanicCallback(cb func(e interface{})) DriverComposeOption

WithDriverPanicCallback specified behavior on panic

type DriverConnAllowDoneInfo added in v3.25.1

type DriverConnAllowDoneInfo struct {
	State ConnState
}

type DriverConnAllowStartInfo added in v3.25.1

type DriverConnAllowStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context  *context.Context
	Endpoint EndpointInfo
	State    ConnState
}

type DriverConnBanDoneInfo added in v3.25.1

type DriverConnBanDoneInfo struct {
	State ConnState
}

type DriverConnBanStartInfo added in v3.25.1

type DriverConnBanStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context  *context.Context
	Endpoint EndpointInfo
	State    ConnState
	Cause    error
}

type DriverConnCloseDoneInfo added in v3.15.0

type DriverConnCloseDoneInfo struct {
	Error error
}

type DriverConnCloseStartInfo added in v3.15.0

type DriverConnCloseStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context  *context.Context
	Endpoint EndpointInfo
}

type DriverConnInvokeDoneInfo added in v3.15.0

type DriverConnInvokeDoneInfo struct {
	Error  error
	Issues []Issue
	OpID   string
	State  ConnState
}

type DriverConnInvokeStartInfo added in v3.15.0

type DriverConnInvokeStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context  *context.Context
	Endpoint EndpointInfo
	Method   Method
}

type DriverConnNewStreamDoneInfo added in v3.15.0

type DriverConnNewStreamDoneInfo struct {
	State ConnState
	Error error
}

type DriverConnNewStreamRecvInfo added in v3.15.0

type DriverConnNewStreamRecvInfo struct {
	Error error
}

type DriverConnNewStreamStartInfo added in v3.15.0

type DriverConnNewStreamStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context  *context.Context
	Endpoint EndpointInfo
	Method   Method
}

type DriverConnParkDoneInfo added in v3.15.0

type DriverConnParkDoneInfo struct {
	Error error
}

type DriverConnParkStartInfo added in v3.15.0

type DriverConnParkStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context  *context.Context
	Endpoint EndpointInfo
}

type DriverConnStateChangeDoneInfo added in v3.15.0

type DriverConnStateChangeDoneInfo struct {
	State ConnState
}

type DriverConnStateChangeStartInfo added in v3.15.0

type DriverConnStateChangeStartInfo struct {
	Endpoint EndpointInfo
	State    ConnState
}

type DriverConnTakeDoneInfo added in v3.15.0

type DriverConnTakeDoneInfo struct {
	Error error
}

type DriverConnTakeStartInfo added in v3.15.0

type DriverConnTakeStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context  *context.Context
	Endpoint EndpointInfo
}

type DriverGetCredentialsDoneInfo added in v3.15.0

type DriverGetCredentialsDoneInfo struct {
	Token string
	Error error
}

type DriverGetCredentialsStartInfo added in v3.15.0

type DriverGetCredentialsStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
}

type DriverInitDoneInfo added in v3.15.0

type DriverInitDoneInfo struct {
	Error error
}

type DriverInitStartInfo added in v3.15.0

type DriverInitStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context  *context.Context
	Endpoint string
	Database string
	Secure   bool
}

type DriverNetCloseDoneInfo added in v3.15.0

type DriverNetCloseDoneInfo struct {
	Error error
}

type DriverNetCloseStartInfo added in v3.15.0

type DriverNetCloseStartInfo struct {
	Address string
}

type DriverNetDialDoneInfo added in v3.15.0

type DriverNetDialDoneInfo struct {
	Error error
}

type DriverNetDialStartInfo added in v3.15.0

type DriverNetDialStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
	Address string
}

type DriverNetReadDoneInfo added in v3.15.0

type DriverNetReadDoneInfo struct {
	Received int
	Error    error
}

type DriverNetReadStartInfo added in v3.15.0

type DriverNetReadStartInfo struct {
	Address string
	Buffer  int
}

type DriverNetWriteDoneInfo added in v3.15.0

type DriverNetWriteDoneInfo struct {
	Sent  int
	Error error
}

type DriverNetWriteStartInfo added in v3.15.0

type DriverNetWriteStartInfo struct {
	Address string
	Bytes   int
}

type DriverRepeaterWakeUpDoneInfo added in v3.25.0

type DriverRepeaterWakeUpDoneInfo struct {
	Error error
}

type DriverRepeaterWakeUpStartInfo added in v3.25.0

type DriverRepeaterWakeUpStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
	Name    string
	Event   string
}

type DriverResolveDoneInfo added in v3.15.0

type DriverResolveDoneInfo struct {
	Error error
}

type DriverResolveStartInfo added in v3.15.0

type DriverResolveStartInfo struct {
	Target   string
	Resolved []string
}

type EndpointInfo added in v3.11.8

type EndpointInfo interface {
	fmt.Stringer

	NodeID() uint32
	Address() string
	LocalDC() bool
	Location() string
	LoadFactor() float32
	LastUpdated() time.Time
}

type FieldStubber

type FieldStubber struct {
	// OnStub is an optional callback that is called when field getting
	// stubbed.
	OnStub func(name string)

	// OnCall is an optional callback that will be called for each stubbed
	// field getting called.
	OnCall func(name string, args ...interface{})
}

FieldStubber contains options of filling all struct functional fields.

func (FieldStubber) Stub

func (f FieldStubber) Stub(x reflect.Value)

Stub fills in given x struct.

type Issue

type Issue interface {
	GetMessage() string
	GetIssueCode() uint32
	GetSeverity() uint32
}

Issue declare interface of operation error issues

type Method

type Method string

Method represents rpc method.

func (Method) Name

func (m Method) Name() (s string)

Name returns the rpc method name.

func (Method) Service

func (m Method) Service() (s string)

Service returns the rpc service name.

func (Method) Split

func (m Method) Split() (service, method string)

Split returns service name and method.

type Ratelimiter added in v3.10.0

type Ratelimiter struct{}

Ratelimiter specified trace of ratelimiter client activity. gtrace:gen

func (Ratelimiter) Compose added in v3.10.0

func (t Ratelimiter) Compose(x Ratelimiter, opts ...RatelimiterComposeOption) (ret Ratelimiter)

Compose returns a new Ratelimiter which has functional fields composed both from t and x.

type RatelimiterComposeOption added in v3.17.0

type RatelimiterComposeOption func(o *ratelimiterComposeOptions)

RatelimiterOption specified Ratelimiter compose option

func WithRatelimiterPanicCallback added in v3.17.0

func WithRatelimiterPanicCallback(cb func(e interface{})) RatelimiterComposeOption

WithRatelimiterPanicCallback specified behavior on panic

type Retry

type Retry struct {
	OnRetry func(RetryLoopStartInfo) func(RetryLoopIntermediateInfo) func(RetryLoopDoneInfo)
}

Retry specified trace of retry call activity. gtrace:gen

func (Retry) Compose

func (t Retry) Compose(x Retry, opts ...RetryComposeOption) (ret Retry)

Compose returns a new Retry which has functional fields composed both from t and x.

type RetryComposeOption added in v3.17.0

type RetryComposeOption func(o *retryComposeOptions)

RetryOption specified Retry compose option

func WithRetryPanicCallback added in v3.17.0

func WithRetryPanicCallback(cb func(e interface{})) RetryComposeOption

WithRetryPanicCallback specified behavior on panic

type RetryLoopDoneInfo

type RetryLoopDoneInfo struct {
	Attempts int
	Error    error
}

type RetryLoopIntermediateInfo added in v3.10.0

type RetryLoopIntermediateInfo struct {
	Error error
}

type RetryLoopStartInfo

type RetryLoopStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context    *context.Context
	ID         string
	Idempotent bool
}

type Scheme added in v3.10.0

type Scheme struct{}

Scheme specified trace of scheme client activity. gtrace:gen

func (Scheme) Compose added in v3.10.0

func (t Scheme) Compose(x Scheme, opts ...SchemeComposeOption) (ret Scheme)

Compose returns a new Scheme which has functional fields composed both from t and x.

type SchemeComposeOption added in v3.17.0

type SchemeComposeOption func(o *schemeComposeOptions)

SchemeOption specified Scheme compose option

func WithSchemePanicCallback added in v3.17.0

func WithSchemePanicCallback(cb func(e interface{})) SchemeComposeOption

WithSchemePanicCallback specified behavior on panic

type Scripting added in v3.10.0

Scripting specified trace of scripting client activity. gtrace:gen

func (Scripting) Compose added in v3.10.0

func (t Scripting) Compose(x Scripting, opts ...ScriptingComposeOption) (ret Scripting)

Compose returns a new Scripting which has functional fields composed both from t and x.

type ScriptingCloseDoneInfo added in v3.13.1

type ScriptingCloseDoneInfo struct {
	Error error
}

type ScriptingCloseStartInfo added in v3.13.1

type ScriptingCloseStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
}

type ScriptingComposeOption added in v3.17.0

type ScriptingComposeOption func(o *scriptingComposeOptions)

ScriptingOption specified Scripting compose option

func WithScriptingPanicCallback added in v3.17.0

func WithScriptingPanicCallback(cb func(e interface{})) ScriptingComposeOption

WithScriptingPanicCallback specified behavior on panic

type ScriptingExecuteDoneInfo added in v3.13.1

type ScriptingExecuteDoneInfo struct {
	Result scriptingResult
	Error  error
}

type ScriptingExecuteStartInfo added in v3.13.1

type ScriptingExecuteStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context    *context.Context
	Query      string
	Parameters scriptingQueryParameters
}

type ScriptingExplainDoneInfo added in v3.13.1

type ScriptingExplainDoneInfo struct {
	Plan  string
	Error error
}

type ScriptingExplainStartInfo added in v3.13.1

type ScriptingExplainStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
	Query   string
}

type ScriptingStreamExecuteDoneInfo added in v3.13.1

type ScriptingStreamExecuteDoneInfo struct {
	Error error
}

type ScriptingStreamExecuteIntermediateInfo added in v3.13.1

type ScriptingStreamExecuteIntermediateInfo struct {
	Error error
}

type ScriptingStreamExecuteStartInfo added in v3.13.1

type ScriptingStreamExecuteStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context    *context.Context
	Query      string
	Parameters scriptingQueryParameters
}

type Table

type Table struct {
	// Client events
	OnInit          func(TableInitStartInfo) func(TableInitDoneInfo)
	OnClose         func(TableCloseStartInfo) func(TableCloseDoneInfo)
	OnDo            func(TableDoStartInfo) func(info TableDoIntermediateInfo) func(TableDoDoneInfo)
	OnDoTx          func(TableDoTxStartInfo) func(info TableDoTxIntermediateInfo) func(TableDoTxDoneInfo)
	OnCreateSession func(
		TableCreateSessionStartInfo,
	) func(
		info TableCreateSessionIntermediateInfo,
	) func(
		TableCreateSessionDoneInfo,
	)
	// Session events
	OnSessionNew       func(TableSessionNewStartInfo) func(TableSessionNewDoneInfo)
	OnSessionDelete    func(TableSessionDeleteStartInfo) func(TableSessionDeleteDoneInfo)
	OnSessionKeepAlive func(TableKeepAliveStartInfo) func(TableKeepAliveDoneInfo)
	// Query events
	OnSessionQueryPrepare func(TablePrepareDataQueryStartInfo) func(TablePrepareDataQueryDoneInfo)
	OnSessionQueryExecute func(TableExecuteDataQueryStartInfo) func(TableExecuteDataQueryDoneInfo)
	OnSessionQueryExplain func(TableExplainQueryStartInfo) func(TableExplainQueryDoneInfo)
	// Stream events
	OnSessionQueryStreamExecute func(
		TableSessionQueryStreamExecuteStartInfo,
	) func(
		TableSessionQueryStreamExecuteIntermediateInfo,
	) func(
		TableSessionQueryStreamExecuteDoneInfo,
	)
	OnSessionQueryStreamRead func(
		TableSessionQueryStreamReadStartInfo,
	) func(
		TableSessionQueryStreamReadIntermediateInfo,
	) func(
		TableSessionQueryStreamReadDoneInfo,
	)
	// Transaction events
	OnSessionTransactionBegin  func(TableSessionTransactionBeginStartInfo) func(TableSessionTransactionBeginDoneInfo)
	OnSessionTransactionCommit func(
		TableSessionTransactionCommitStartInfo,
	) func(
		TableSessionTransactionCommitDoneInfo,
	)
	OnSessionTransactionRollback func(
		TableSessionTransactionRollbackStartInfo,
	) func(
		TableSessionTransactionRollbackDoneInfo,
	)
	// Pool state event
	OnPoolStateChange func(TablePoolStateChangeInfo)
	// Pool session lifecycle events
	OnPoolSessionNew   func(TablePoolSessionNewStartInfo) func(TablePoolSessionNewDoneInfo)
	OnPoolSessionClose func(TablePoolSessionCloseStartInfo) func(TablePoolSessionCloseDoneInfo)
	// Pool common API events
	OnPoolPut  func(TablePoolPutStartInfo) func(TablePoolPutDoneInfo)
	OnPoolGet  func(TablePoolGetStartInfo) func(TablePoolGetDoneInfo)
	OnPoolWait func(TablePoolWaitStartInfo) func(TablePoolWaitDoneInfo)
}

Table specified trace of table client activity. gtrace:gen

func (Table) Compose

func (t Table) Compose(x Table, opts ...TableComposeOption) (ret Table)

Compose returns a new Table which has functional fields composed both from t and x.

type TableCloseDoneInfo added in v3.13.1

type TableCloseDoneInfo struct {
	Error error
}

type TableCloseStartInfo added in v3.13.1

type TableCloseStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
}

type TableComposeOption added in v3.17.0

type TableComposeOption func(o *tableComposeOptions)

TableOption specified Table compose option

func WithTablePanicCallback added in v3.17.0

func WithTablePanicCallback(cb func(e interface{})) TableComposeOption

WithTablePanicCallback specified behavior on panic

type TableCreateSessionDoneInfo added in v3.15.0

type TableCreateSessionDoneInfo struct {
	Session  tableSessionInfo
	Attempts int
	Error    error
}

type TableCreateSessionIntermediateInfo added in v3.15.0

type TableCreateSessionIntermediateInfo struct {
	Error error
}

type TableCreateSessionStartInfo added in v3.15.0

type TableCreateSessionStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
}

type TableDoDoneInfo added in v3.15.0

type TableDoDoneInfo struct {
	Attempts int
	Error    error
}

type TableDoIntermediateInfo added in v3.15.0

type TableDoIntermediateInfo struct {
	Error error
}

type TableDoStartInfo added in v3.15.0

type TableDoStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context    *context.Context
	Idempotent bool
}

type TableDoTxDoneInfo added in v3.15.0

type TableDoTxDoneInfo struct {
	Attempts int
	Error    error
}

type TableDoTxIntermediateInfo added in v3.15.0

type TableDoTxIntermediateInfo struct {
	Error error
}

type TableDoTxStartInfo added in v3.15.0

type TableDoTxStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context    *context.Context
	Idempotent bool
}

type TableExecuteDataQueryDoneInfo added in v3.15.0

type TableExecuteDataQueryDoneInfo struct {
	Tx       tableTransactionInfo
	Prepared bool
	Result   tableResult
	Error    error
}

type TableExecuteDataQueryStartInfo added in v3.15.0

type TableExecuteDataQueryStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context    *context.Context
	Session    tableSessionInfo
	Query      tableDataQuery
	Parameters tableQueryParameters
}

type TableExplainQueryDoneInfo added in v3.15.0

type TableExplainQueryDoneInfo struct {
	AST   string
	Plan  string
	Error error
}

type TableExplainQueryStartInfo added in v3.15.0

type TableExplainQueryStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
	Session tableSessionInfo
	Query   string
}

type TableInitDoneInfo added in v3.13.1

type TableInitDoneInfo struct {
	Limit            int
	KeepAliveMinSize int
}

type TableInitStartInfo added in v3.13.1

type TableInitStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
}

type TableKeepAliveDoneInfo added in v3.15.0

type TableKeepAliveDoneInfo struct {
	Error error
}

type TableKeepAliveStartInfo added in v3.15.0

type TableKeepAliveStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
	Session tableSessionInfo
}

type TablePoolGetDoneInfo added in v3.15.0

type TablePoolGetDoneInfo struct {
	Session  tableSessionInfo
	Attempts int
	Error    error
}

type TablePoolGetStartInfo added in v3.15.0

type TablePoolGetStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
}

type TablePoolPutDoneInfo added in v3.15.0

type TablePoolPutDoneInfo struct {
	Error error
}

type TablePoolPutStartInfo added in v3.15.0

type TablePoolPutStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
	Session tableSessionInfo
}

type TablePoolSessionCloseDoneInfo added in v3.15.0

type TablePoolSessionCloseDoneInfo struct{}

type TablePoolSessionCloseStartInfo added in v3.15.0

type TablePoolSessionCloseStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
	Session tableSessionInfo
}

type TablePoolSessionNewDoneInfo added in v3.15.0

type TablePoolSessionNewDoneInfo struct {
	Session tableSessionInfo
	Error   error
}

type TablePoolSessionNewStartInfo added in v3.15.0

type TablePoolSessionNewStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
}

type TablePoolStateChangeInfo added in v3.26.10

type TablePoolStateChangeInfo struct {
	Size  int
	Event string
}

type TablePoolWaitDoneInfo added in v3.15.0

type TablePoolWaitDoneInfo struct {
	Session tableSessionInfo
	Error   error
}

TablePoolWaitDoneInfo means a wait iteration inside Get call is done Warning: Session and Error may be nil at the same time. This means that a wait iteration donned without any significant tableResultErr

type TablePoolWaitStartInfo added in v3.15.0

type TablePoolWaitStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
}

type TablePrepareDataQueryDoneInfo added in v3.15.0

type TablePrepareDataQueryDoneInfo struct {
	Result tableDataQuery
	Error  error
}

type TablePrepareDataQueryStartInfo added in v3.15.0

type TablePrepareDataQueryStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
	Session tableSessionInfo
	Query   string
}

type TableSessionDeleteDoneInfo added in v3.15.0

type TableSessionDeleteDoneInfo struct {
	Error error
}

type TableSessionDeleteStartInfo added in v3.15.0

type TableSessionDeleteStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
	Session tableSessionInfo
}

type TableSessionNewDoneInfo added in v3.15.0

type TableSessionNewDoneInfo struct {
	Session tableSessionInfo
	Error   error
}

type TableSessionNewStartInfo added in v3.15.0

type TableSessionNewStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
}

type TableSessionQueryStreamExecuteDoneInfo added in v3.15.0

type TableSessionQueryStreamExecuteDoneInfo struct {
	Error error
}

type TableSessionQueryStreamExecuteIntermediateInfo added in v3.15.0

type TableSessionQueryStreamExecuteIntermediateInfo struct {
	Error error
}

type TableSessionQueryStreamExecuteStartInfo added in v3.15.0

type TableSessionQueryStreamExecuteStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context    *context.Context
	Session    tableSessionInfo
	Query      tableDataQuery
	Parameters tableQueryParameters
}

type TableSessionQueryStreamReadDoneInfo added in v3.15.0

type TableSessionQueryStreamReadDoneInfo struct {
	Error error
}

type TableSessionQueryStreamReadIntermediateInfo added in v3.15.0

type TableSessionQueryStreamReadIntermediateInfo struct {
	Error error
}

type TableSessionQueryStreamReadStartInfo added in v3.15.0

type TableSessionQueryStreamReadStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
	Session tableSessionInfo
}

type TableSessionTransactionBeginDoneInfo added in v3.15.0

type TableSessionTransactionBeginDoneInfo struct {
	Tx    tableTransactionInfo
	Error error
}

type TableSessionTransactionBeginStartInfo added in v3.15.0

type TableSessionTransactionBeginStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
	Session tableSessionInfo
}

type TableSessionTransactionCommitDoneInfo added in v3.15.0

type TableSessionTransactionCommitDoneInfo struct {
	Error error
}

type TableSessionTransactionCommitStartInfo added in v3.15.0

type TableSessionTransactionCommitStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
	Session tableSessionInfo
	Tx      tableTransactionInfo
}

type TableSessionTransactionRollbackDoneInfo added in v3.15.0

type TableSessionTransactionRollbackDoneInfo struct {
	Error error
}

type TableSessionTransactionRollbackStartInfo added in v3.15.0

type TableSessionTransactionRollbackStartInfo struct {
	// Context make available context in trace callback function.
	// Pointer to context provide replacement of context in trace callback function.
	// Warning: concurrent access to pointer on client side must be excluded.
	// Safe replacement of context are provided only inside callback function
	Context *context.Context
	Session tableSessionInfo
	Tx      tableTransactionInfo
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL