ydbx

Documentation

Index

• type Client
  • func NewClient(ctx context.Context, params ConnectParams, opts ...ClientOption) (c *Client, err error)
  • func (c *Client) Close()
  • func (c *Client) Table() *tableWrapper
• type ClientOption
  • func WithCredentials(credentials ydb.Credentials) ClientOption
  • func WithDriver(driver ydb.Driver) ClientOption
  • func WithDriverConfig(config *ydb.DriverConfig) ClientOption
• type ConnectParams
  • func ConnectionString(uri string) (ConnectParams, error)
  • func EndpointDatabase(endpoint string, database string, tls bool) ConnectParams
  • func MustConnectionString(uri string) ConnectParams

Types

type Client

type Client struct {
	DriverConfig *ydb.DriverConfig
	Driver       ydb.Driver
	// contains filtered or unexported fields
}

func NewClient

func NewClient(ctx context.Context, params ConnectParams, opts ...ClientOption) (c *Client, err error)

NewClient creates a Client to a database

func (*Client) Close

func (c *Client) Close()

func (*Client) Table

func (c *Client) Table() *tableWrapper

type ClientOption

type ClientOption func(client *Client) error

func WithCredentials

func WithCredentials(credentials ydb.Credentials) ClientOption

func WithDriver

func WithDriver(driver ydb.Driver) ClientOption

func WithDriverConfig

func WithDriverConfig(config *ydb.DriverConfig) ClientOption

type ConnectParams

type ConnectParams interface {
	Endpoint() string
	Database() string
	UseTLS() bool
}

func ConnectionString

func ConnectionString(uri string) (ConnectParams, error)

func EndpointDatabase

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

func MustConnectionString

func MustConnectionString(uri string) ConnectParams