v3 – github.com/ydb-platform/ydb-go-sdk/v3 Index | Files | Directories

package ydb

import "github.com/ydb-platform/ydb-go-sdk/v3"

Index

Constants

const Version = meta.Version

Version alias for except cycle import

Functions

func IsOperationError

func IsOperationError(err error) (ok bool, code int32, name string)

func IsStatusAlreadyExistsError

func IsStatusAlreadyExistsError(err error) bool

func IsStatusNotFoundError

func IsStatusNotFoundError(err error) bool

func IsStatusSchemeError

func IsStatusSchemeError(err error) bool

func IsTimeoutError

func IsTimeoutError(err error) bool

func IsTransportError

func IsTransportError(err error) (ok bool, code int32, name string)

func IterateByIssues

func IterateByIssues(err error, it func(message string, code uint32, severity uint32))

Types

type ConnectParams

type ConnectParams interface {
	Endpoint() string
	Database() string
	Secure() bool
	Token() string
}

func ConnectionString

func ConnectionString(uri string) (ConnectParams, error)

func EndpointDatabase

func EndpointDatabase(endpoint string, database string, secure bool) ConnectParams

func MustConnectionString

func MustConnectionString(uri string) ConnectParams

type Connection

type Connection interface {
	DB

	Table() table.Client
	Scheme() scheme.Client
	Coordination() coordination.Client
	RateLimiter() ratelimiter.Client
	Discovery() discovery.Client
}

func New

func New(ctx context.Context, opts ...Option) (_ Connection, err error)

New connects to name and return name runtime holder

type DB

type DB interface {
	cluster.Cluster

	// Name returns database name
	Name() string

	// Secure returns true if database connection is secure
	Secure() bool
}

type Option

type Option func(ctx context.Context, db *db) error

func With

func With(options ...config.Option) Option

func WithAccessTokenCredentials

func WithAccessTokenCredentials(accessToken string) Option

func WithAnonymousCredentials

func WithAnonymousCredentials() Option

func WithBalancingConfig

func WithBalancingConfig(balancerConfig config.BalancerConfig) Option

func WithCertificate

func WithCertificate(cert *x509.Certificate) Option

func WithCertificatesFromFile

func WithCertificatesFromFile(caFile string) Option

func WithCertificatesFromPem

func WithCertificatesFromPem(bytes []byte) Option

func WithConnectParams

func WithConnectParams(params ConnectParams) Option

func WithConnectionString

func WithConnectionString(connection string) Option

func WithCreateCredentialsFunc

func WithCreateCredentialsFunc(createCredentials func(ctx context.Context) (credentials.Credentials, error)) Option

func WithCredentials

func WithCredentials(c credentials.Credentials) Option

func WithDialTimeout

func WithDialTimeout(timeout time.Duration) Option

func WithDiscoveryInterval

func WithDiscoveryInterval(discoveryInterval time.Duration) Option

func WithDriverConfigOptions

func WithDriverConfigOptions(options ...config.Option) Option

func WithGrpcConnectionTTL

func WithGrpcConnectionTTL(ttl time.Duration) Option

func WithSessionPoolCreateSessionTimeout

func WithSessionPoolCreateSessionTimeout(createSessionTimeout time.Duration) Option

func WithSessionPoolDeleteTimeout

func WithSessionPoolDeleteTimeout(deleteTimeout time.Duration) Option

func WithSessionPoolIdleThreshold

func WithSessionPoolIdleThreshold(idleThreshold time.Duration) Option

func WithSessionPoolKeepAliveMinSize

func WithSessionPoolKeepAliveMinSize(keepAliveMinSize int) Option

func WithSessionPoolKeepAliveTimeout

func WithSessionPoolKeepAliveTimeout(keepAliveTimeout time.Duration) Option

func WithSessionPoolSizeLimit

func WithSessionPoolSizeLimit(sizeLimit int) Option

func WithTableConfigOption

func WithTableConfigOption(option config.Option) Option

func WithTraceDriver

func WithTraceDriver(trace trace.Driver) Option

WithTraceDriver returns deadline which has associated Driver with it.

func WithTraceTable

func WithTraceTable(trace trace.Table) Option

WithTraceTable returns deadline which has associated Driver with it.

Source Files

connect_params.go connection.go coordiantion.go discovery.go errors.go options.go ratelimiter.go scheme.go table.go version.go

Directories

PathSynopsis
cluster
cluster/stats
cluster/stats/state
config
coordination
credentials
internal
ratelimiter
retry
table
table/config
table/options
table/resultset
table/stats
table/types
test
testutil
testutil/timeutil
testutil/timeutil/timetest
trace
Version
v3.0.1-rc0
Published
Oct 24, 2021
Platform
windows/amd64
Imports
33 packages
Last checked
now

Tools for package owners.